X-Ample PlayerList

Give your FiveM server a sleek, customizable, and lightweight player list that goes beyond the basics. X-Ample PlayerList provides a modern interface and essential features to keep your community informed, while letting you easily tailor the look and feel to fit your server’s style.

Key Features

• Discord Webhook Integration
  Seamlessly send player list updates via a Discord webhook (just 4 lines in server/main.lua) to keep your community in the loop.

• Auto-Fetch Maximum Players
  Automatically retrieves and displays your server’s max players based on sv_maxclients, saving you the extra configuration work.

• Flexible Identifiers
  Display any combination of identifiers such as citizenid, steam, or license—choose what works best for your server setup.

• Character Name Display
  Show character names instead of generic IDs for a more immersive and roleplay-friendly experience.

• ID Above Head
  Toggle on or off to show the player’s ID above their head, letting you balance immersion with convenience.

• Disable Controls
  Prevent unintended actions by automatically disabling certain controls while the scoreboard is open.

• Emote Playback & Custom Animation
  Add personality to your scoreboard by playing emotes and animations when viewing player info. Simply configure your preferred animation dictionary and emote.

Installation and Setup

1. Download and Extract

   • Grab the X-Ample PlayerList resource.
   • Extract it to your FiveM resources folder (e.g., resources/[your-folder]/xample-playerlist).

2. Update Your Server Config

   • Add the following line to your server.cfg:
     ```cfg ensure xample-playerlist ```

3. Configure

   • Adjust settings in nui/config.json (like display mode, open key, etc.) to align with your server’s preferences.

4. Test and Debug

   • Start your server.
   • Press the key bound to Config.OpenKey (default: U) to verify the scoreboard functions and debug if needed.

Future Enhancements

• Enhanced Framework Compatibility
  We aim to support additional core frameworks for a smoother integration.

• Dynamic UI Themes
  Apply your own custom themes to tailor the scoreboard’s look and feel.

• Advanced Debug Tools
  Debugging will be even easier with new features to streamline troubleshooting.

• Localization
  Offer a multi-language scoreboard for servers with diverse communities.

Experience a refined, immersive scoreboard that keeps your players informed and engaged—X-Ample PlayerList is the perfect fusion of style and functionality for your FiveM server.