> For the complete documentation index, see [llms.txt](https://codingguru1968.gitbook.io/fakeplayers-wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://codingguru1968.gitbook.io/fakeplayers-wiki/getting-started.md).

# ✨ Getting Started

#### ⚙️ Installation & Requirements

 1\. This plugin requires [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/) to be installed on your server. Here are direct links for your server version:

> Server Version: [1.8 - 1.21.8](https://github.com/dmulloy2/ProtocolLib/releases/tag/5.4.0)
>
> Server Version: [1.21.9+](https://github.com/dmulloy2/ProtocolLib/releases/tag/dev-build)

2. Download and install [Citizens](https://ci.citizensnpcs.co/job/Citizens2/) if you want to use the NPCs feature.
3. Download the FakePlayers.jar and drop it into your server's plugins folder.
4. Restart your server to generate the default configuration files.
5. Complete the "Required Configuration" setup that is listed [here](#required-configuration-important) to ensure your fake players function correctly and integrate seamlessly with your server.
6. Insert any placeholders you need to use from the [Placeholders Page](/fakeplayers-wiki/placeholders.md). Use these in TAB, scoreboards, etc to display the correct fake count + online count.

> 💡 Tip: For a comprehensive explanation of every setting, refer to the full [Configuration Page](/fakeplayers-wiki/configuration.md). If you encounter any issues, please check our [Support Discord](https://discord.gg/Rqmngywv57) for assistance.

#### ⚙️ Required Configuration (Important)

You **MUST** complete the following configuration steps before launching. Skipping these will lead to visual inconsistencies.

1. **Overhead Nametags**

   You must configure `overhead-name-settings`. This is required to ensure fake players display correctly and do not have "glitchy" nametags that break immersion.
2. **Tab List Settings**

   You must adjust `tab-settings` to define your name format and team priority. This prevents fake players from appearing with incorrect formatting or in the wrong position in your TAB menu.
3. **Player List Output**

   You must customize `list-players`. This is essential to ensure that your `/list` and `/who` commands correctly integrate fake players with your server's existing rank and formatting themes.
4. **MOTD & Server List**

   You must review `motd-settings`. Failure to configure this can lead to conflicts if you are already using a separate MOTD plugin for your server list.
5. Chat Formatting\
   Ensure `chat-messages.format` is correctly configured to be identical to your current chat plugin in-game.

> 💡 Important: After editing your `config.yml`, you must run `/fp reload` in-game or via console to apply these changes. For deep-dive explanations of every parameter listed above, refer to the full [Configuration Page](/fakeplayers-wiki/configuration.md).