Getting Started 📖

1️⃣ Installation

To get started with xTeams, you first need to install the plugin on your Minecraft server. Follow these steps for proper installation:

• Requirements: a Spigot or Paper server running Minecraft 1.20 or newer. The plugin is not compatible with CraftBukkit.
• Optional integrations:
  • PlaceholderAPI — adds the %xteams_…% placeholders.
  • LuckPerms — lets xTeams add/remove a LuckPerms group when a player joins or leaves a team.

Once the plugin is downloaded, drop it into your server's plugins folder and restart the server.

💡 Pick the right identifier mode. Open plugins/xTeams/config.yml and set settings.identifier_mode to "uuid" for premium / online-mode servers, or "nickname" for non-premium / offline-mode servers. This decides whether team members are stored by UUID or by name. Switching it later does not convert existing entries.

---

2️⃣ Create and Manage Teams

Now that you have xTeams installed, let's learn how to create and manage teams on your server.

✨ Create a Team

To create a team in xTeams, use the following command:

/xteams create <team_name> <priority>

Replace <team_name> with the codename you want for the team and <priority> with an integer (higher = more important — used when a player belongs to several teams). Example: /xteams create red 1 creates a team with the codename red and priority 1.

🛠️ Managing the Team

• Join a Team
  To join a team, use the following command:

  /xteams join <team_name> [player_name]

  Leave [player_name] empty to join yourself. Example: /xteams join red adds you to the red team; /xteams join red Alex adds Alex.

• Leave a Team
  To leave a team, execute:

  /xteams leave <team_name|*> [player_name|*]

  Use * for the team to leave every team, or for the player to target every member at once (the latter requires xteams.command.leave.all). Example: /xteams leave red makes you leave the red team; /xteams leave * Alex removes Alex from every team.

• View Team Information
  To get information about a team, use:

  /xteams teaminfo <team_name>

  Example: /xteams teaminfo red shows the red team's display name, priority, and members.

• View Player Information
  To see which teams a player belongs to:

  /xteams playerinfo <player_name>

✏️ Customize the Display Name

Using the /xteams setdisplay command, you can change the text shown for a team in the team list.

/xteams setdisplay <team_name> "<display_name>"

Example: /xteams setdisplay red "&cThe Red Team" changes the display text for the "red" team. Both & color codes and #RRGGBB hex are supported.

🗑️ Delete a Team

If you decide to delete a team, you can do so with:

/xteams delete <team_name|*>

Example: /xteams delete red deletes the "red" team and its data. Use * to delete every team (requires xteams.command.delete.all).

🔄 Reload & Sync

• /xteams reload reloads config.yml, messages.yml and the hook settings without restarting.
• /xteams sync reapplies the LuckPerms / Minecraft team hooks to every online member — useful right after enabling a hook.

---

3️⃣ More Resources

For more information on other commands, permissions, and configurations, check out the following sections:

• Plugin
  • ⌨️ Commands
  • 🔒 Permissions
  • 🧩 Placeholders
• Configuration Files
  • 📝 config.yml
  • 📝 messages.yml
• API
  • 🔗 xTeams API

If you have questions or need further assistance, you can also check the Troubleshooting section.

---

Now you're ready to start creating and managing your teams in xTeams. If you need more help, feel free to continue exploring our wiki. 🚀

---