ARROM – RimWorld REST API Mod
Expose a local HTTP REST API inside RimWorld to query your game data in real time!
Key Features
- Local HTTP Server – Retrieve colony status, colonists, buildings, research, weather, and more
- JSON Responses – Well-structured JSON, easy to parse in Python, JavaScript, C#, etc.
- Multi-Version Support – Support RimWorld 1.5 & 1.6
🚀 Available Endpoints
- /colony → Colony name, colonist count, total wealth
- /letters → Recent in-game letters
- /colonists & /colonists/<id> → List & detailed stats (needs, mood, inventory…)
- /mods → Loaded mods
- /factions → Faction relations & goodwill
- /research → Current research project & completed list
- /buildings → Colonist buildings (filter with `?type=`)
- /map → Weather, temperature, hour, season
- /animals → Player-owned animals
- /storage → Stockpiles & storage contents
- /alerts → Active alerts
- /jobs → Colonist current jobs & queued tasks
- /map/tiles → All map tile coordinates
- /map/tiles/<x>/<y> → Details of a specific map tile
🌐 Detailed Endpoints
For details on endpoint outputs, please refer to the GitHub readme file. ( https://github.com/MasterPNJ/API-REST-RimwOrld-Mod/blob/main/README.md )
🛠️ Configuration
- Default HTTP Port: 8765
- Cache Refresh Interval: 300 ticks
💬 Supported Languages
- 🇫🇷 French
- 🇬🇧 English
- 🇩🇪 German
- 🇪🇸 Spanish
- 🇵🇹 Portuguese
- 🇨🇳 Chinese (Simplified)
- 🇨🇳 Chinese (Traditional)
- 🇷🇺 Russian
- 🇯🇵 Japanese
- 🇰🇷 Korean
- Polish
- Italian
🔗 Link
Github with example of endpoint : https://github.com/MasterPNJ/API-REST-RimwOrld-Mod
🚀 Feedback and Support
Thank you for trying ARROM! Feel free to leave feedback, rate, and suggest new endpoints.
If you enjoy my mods and want to support me:
[ko-fi.com]
