Ronin Server Manager (RSM)

The definitive local desktop orchestrator for dedicated game servers.

---

🖥️ What is RSM?

Ronin Server Manager is a lightweight, local-first application designed to take the headache out of managing dedicated game servers. By leveraging Electron, RSM provides a clean Windows-native interface to handle everything from installation to real-time process monitoring.

Important

This is a client-side desktop application. No web hosting or external databases are required—all server files and configurations stay exactly where they belong: on your machine.

🌟 Key Features

• 📦 One-Click Management: Start, stop, and restart server instances from a unified dashboard.
• Centralized Server List: See the status of every server right in the manager, along with their own pages to. checkout their consoles, and resource usage.
• 🔎 Active Resource Monitoring: Monitor the CPU and RAM usage of your servers individually and overall right in the GUI.
• 🏠 Local-First: High-speed performance with direct filesystem access via Node.js.
• 🛠️ Automated Configs (WIP): No more digging through .ini or .json files; edit settings directly in the GUI.
• 📝 Live Logs: Integrated console output to monitor your server's health and player activity.
• 🔡 Centralized Command Center(WIP): Send command to Each server right in their own consoles.
• 📖 Built-in Wiki: Comprehensive guides powered by MkDocs and Markdown.

---

🚀 Quick Start

1. Download the Executable: Head over to the Releases page.
2. Run the App: Open Ronin-Server-Manager.exe.
3. Configure Your Game: Point RSM to your game directory and start your first instance!

---

🛠️ Development & Tech Stack

If you want to build the project from source or contribute:

• Runtime: Node.js
• Framework: Electron (JavaScript)
• Documentation: MkDocs (Markdown)

Local Setup

# Clone the repo
git clone [https://github.com/PhonicSpider/Ronin-Server-Manager.git](https://github.com/PhonicSpider/Ronin-Server-Manager.git)

# Install dependencies
npm install

# Run in development mode
npm start

---

🤝 Contributing to RSM

We love contributions! Whether you're fixing a bug, adding a new game server module, or improving the UI, here is how you can help:

1. 🏗️ Setting Up Your Environment

Before you start coding, ensure you have the following installed:

• Node.js (v18 or higher recommended)
• npm (comes with Node.js)
• Python (Required only for previewing the MkDocs documentation)

2. 🌿 Branching Strategy

• Fork the repository to your own GitHub account.
• Create a feature branch from main:

  git checkout -b feature/your-feature-name```
  

• ​Keep your commits concise and descriptive.

​3. 💻 Coding Standards

• ​JavaScript/Electron: Follow standard JS naming conventions (camelCase for variables/functions).
• ​Local-First: Ensure any new features maintain the application's local-only architecture—avoid adding cloud or external database requirements.
• ​Modularity: Keep game-specific logic separated so the manager remains a clean orchestrator.

​4. 📝 Documentation Contributions

​The documentation is located in the /docs folder and is built using MkDocs.

• To preview documentation changes locally:

pip install mkdocs-material
mkdocs serve

• Edit the .md files in the docs/ directory to update the live site.

5. 🚀 Submitting a Pull Request

• ​Push your changes to your fork.
• ​Open a Pull Request (PR) against the main branch.
• ​Describe your changes in detail: What does this PR solve? Are there any breaking changes?
• ​We will review your PR as soon as possible!

---

​🆘 Need Help?

​If you're unsure where to start, check the Issues tab or open a new discussion to chat about your ideas.