RimAPI is a RimWorld mod that embeds a high-performance REST API server directly into the game, allowing external applications to read and interact with your colony in real-time.
RimAPI exposes over 120+ comprehensive endpoints. The API starts listening on http://localhost:8765/ by default as soon as the game reaches the main menu.
|
|
- Game Controls - Change game settings, modlist, start a new RimWorld game or load one from saves
- Global & Colony map - Get a list of caravans or items inside your storage
- Real-time colony status - Get current game time, weather, storyteller, and difficulty
- Colonist management - Track health, mood, skills, inventory, and work priorities
- Resource tracking - Monitor food, medicine, materials, and storage utilization
- Research progress - Check current projects and completed research
- Quests & incidents - Get list of quests and incidents
- Caching - Efficient data updates without game lag
- Non-blocking operations - Game non-blocking API operations
- Field filtering [todo] - Request only the data you need
- ETag support [todo] - Intelligent caching with 304 Not Modified responses
Share your projects - send integrations on discord server
- Start new RimWorld game or load one from saves with the mod enabled. When the game map is loaded the API server will begin listening.
- The default address is
http://localhost:8765/. You can change the port from the RIMAPI mod settings. - Use any HTTP client (curl, Postman, etc.) to call the endpoints.
More information in the documentation.
This project is licensed under the GNU GPLv3 License - see the LICENSE file for details.
Thanks to MasterPNJ and his project for inspiration.
Thanks to @braasdas and his RatLab project for code reference.
Contributors: @braasdas, @M4x28
Contributions are welcome! Please feel free to submit pull requests or open issues for bugs and feature requests.