Skip to content

AppSprout-dev/rimapi-dashboard

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

186 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RimWorld Dashboard Preview

RimWorld Dashboard React TypeScript

RimWorld Colony Dashboard

A highly customizable, real-time web dashboard for monitoring your RimWorld colony. Built with React and TypeScript, this application connects directly to your running game via the RIMAPI mod, transforming raw game data into a modern, interactive command center.

Key Features

Customizable Interface

  • Drag & Drop Grid: Fully flexible layout engine. Resize, move, and arrange widgets exactly how you want them.
  • Widget Library: Add charts for Mood, Health, Wealth, Power, Weather, Faction Relations, and Message Logs.
  • Save & Load Presets: Save your favorite layouts, switch between them instantly, or export/import them to share with others.
  • Theming: Glassmorphism UI with customizable background images and blur intensity.

Deep Analytics

  • Colonist Insights: Detailed breakdown of colonist needs, mood trends, and health conditions.
  • Medical Center: Triage view showing bleeding rates, immunity progress, and urgent health alerts.
  • Economy & Resources: Real-time inventory tracking and wealth distribution charts.
  • Research Tree: Monitor current research progress and queue status.
  • Power Grid: Visualize power generation vs. consumption and battery storage levels.

Technical

  • Auto-Refresh: Configurable polling interval (default 5s) for near real-time updates.
  • Responsive: optimized for desktop multi-monitor setups but functional on tablets.
  • Zero-Config option: Works out of the box with the default RIMAPI settings.

Prerequisites

  1. RimWorld (v1.5+ recommended)
  2. RIMAPI Mod installed and active.

Getting Started

1. Install the Mod

To expose your game data, you must install the API mod:

  1. Download the latest release from the RIMAPI GitHub Releases or subscribe via Steam Workshop.
  2. Enable the mod in your RimWorld mod list.
  3. Load your save file. The API server starts automatically on port 8765.

2. Connect the Dashboard

Option A: Web Version (Recommended)

No installation required.

  1. Open the RimWorld Dashboard.
  2. Click Connect (Default URL: http://localhost:8765/api/v1).

Option B: Run Locally

If you prefer hosting it yourself or want to contribute:

# Clone the repository
git clone https://github.com/your-username/rimworld-dashboard.git
cd rimworld-dashboard

# Install dependencies
npm install

# Start the application
npm start

The dashboard will open at http://localhost:3000.

Community & Support

License

This project is open-source and licensed under the MIT License.


Disclaimer: This is a fan-made project and is not affiliated with Ludeon Studios. RimWorld is a trademark of Ludeon Studios.


About

Rimworld Colony Dashboard

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 66.1%
  • CSS 33.7%
  • Other 0.2%