Skip to content

README.md

Latest commit

 

History

History
49 lines (38 loc) · 1.68 KB

README.md

File metadata and controls

49 lines (38 loc) · 1.68 KB
Raw

PlayerList

Welcome to PlayerList – a lightweight yet powerful Minecraft Spigot plugin that exposes a simple HTTP API for retrieving the list of online players.

TIP: The plugin has been tested on Minecraft 1.20.1. Compatibility with other versions is not guaranteed.

✨ Key Features

  • Highly configurable
  • Dead-simple API

🚀 How to Install

  1. Download the jar from the releases page.
  2. Drop the file into your server’s plugins folder.
  3. Start or reload your server.
  4. Look for the following lines in the console – they confirm a successful startup: 
    [Server thread/INFO]: [PlayerList] Enabling PlayerList v1.0-SNAPSHOT  
[Server thread/INFO]: [PlayerList] PlayerList 1.0 loaded  
[Server thread/INFO]: [PlayerList] By Slime  
[Server thread/INFO]: [PlayerList] www.slimeserver.top
  5. Edit plugins/PlayerList/config.yml to match your preferences. A minimal example: 
    # Sync interval in seconds
sync-interval: 1
# API bind address & port
api-url: "http://127.0.0.1:4000"
# Enable debug logging
debug: false
  6. Reload the plugin with /playerlist reload or simply restart the server.

🔌 API Reference

Hit the configured endpoint (default http://127.0.0.1:4000) and you’ll receive a JSON response like:

{"players":["Slime_MC","Alex","Steve"]}
Key Value Meaning
players ["Slime_MC","Alex","Steve"] Currently online players: Slime_MC, Alex & Steve