ServerInfo

Welcome to ServerInfo – a lightweight BeamMP server-status plugin that communicates entirely through plain-text files.
Perfect for integrating your server’s live data into any website.

TIP: The plugin has been tested on BeamMP Server 3.X. Compatibility with other versions is not guaranteed.

---

✨ Key Features

• Persist online player list in real time
• Persist max player limit
• Persist mod list with file sizes
• Pure .txt communication – zero dependencies, maximum compatibility
• Drop-in ready for any web stack that can read text files

---

🚀 How to Install

1. Download the latest ServerInfo.zip from the releases page.
2. Extract the archive.
3. Move the entire ServerInfo folder into

   BeamMP-Server\Resources\Server\
   

4. Open path.yml and set where each status file should be written.
   Example:

   player list path: "F:\abc\ players.txt"
   player number limit: "F:\abc\ player_limit.txt"
   mod list: "F:\abc\ mods.txt"

5. Open config.yml and tweak the refresh rate (in seconds).
   Example:

   # ServerInfo Plugin Config
   
   debug: false
   # When true, prints update messages every time a file is saved
   
   update rate: 3
   # How often to read server state and write the text files

6. Start your BeamMP server (BeamMP-Server.exe).

---

🔌 Text-File API Reference

Because the dev’s skills are limited, we use text files as the interface (｡•́︿•̀｡).

1. Player List File (players.txt)

• Empty server

  Online players: 0
  No players online.
  

• Populated server

  Online players: 5
  Slime_MC
  xzh738
  mclobe233
  ckgarden
  me262
  

  • Line 1: current online count
  • Remaining lines: player names

2. Max Player Limit File (player_limit.txt)

6

• Single line: the server’s maximum allowed player count

3. Mod List & Size File (mods.txt)

sunburst.zip:285.48 MB
test.zip:114.5 MB

• Each line format: [filename]:[size in MB]