Skip to content

Eremith-s/ServerMonitorPlugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

32 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ“Š Server Monitor Plugin

Sponsor

A lightweight C# plugin for Rust (compatible with both โš™๏ธ Oxide and ๐ŸŒฟ Carbon) designed to broadcast your server's performance metrics in real-time straight to your web dashboard! ๐Ÿš€


๐Ÿ› ๏ธ Installation

  1. ๐Ÿ“ฅ Drop the ServerMonitor.cs file into your Oxide or Carbon plugins folder.
  2. ๐Ÿ”„ The server will automatically compile it and generate a configuration file at ๐Ÿ“‚ /oxide/config/ServerStats.json.

โš™๏ธ Configuration

The first time the plugin is loaded, it will automatically generate a ๐Ÿ” Random Password. You must use this password to authenticate your Server Dashboard on the website.

๐Ÿ“ Default Configuration File (oxide/config/ServerStats.json):

{
  "Password": "YOUR_GENERATED_PASSWORD_HERE"
}
  • ๐Ÿ”‘ Password: An auto-generated token that acts as a secure key, proving to the website that the incoming statistics genuinely belong to your server.

๐Ÿง  How it works (Smart Sleep Mode)

To prevent overloading the dashboard and your Rust server's resources, the plugin features a built-in ๐Ÿ’ค Sleep Mode.

If it detects that no one currently has the web dashboard open in their browser, the plugin will seamlessly enter sleep mode, drastically reducing the tick updates to once every minute ๐Ÿ“‰. As soon as an administrator opens the dashboard, the plugin instantly "wakes up" โšก and resumes flashing fluid updates on the screen ๐Ÿ“ˆ.



โค๏ธ Support this project

If ServerMonitor helps your server workflow, you can support ongoing development:


๐Ÿ’ฌ Support & Community

Need help configuring the monitor? ๐Ÿ› Found a bug? Just wanna chat? Join the community on Discord! ๐ŸŽฎ

Discord

About

๐Ÿ“ก Real-time โšก Lightweight C# Telemetry Plugin for Rust. Monitors online players, entities, and FPS ๐ŸŽฏ seamlessly connecting your Rust Server to Web platforms (Next.js/React) with minimal resource overhead ๐Ÿ”‹.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages