RIMAPI

RIMAPI is a RimWorld mod that gives you an API Server to interact with your current game.

RIMAPI exposes a comprehensive REST API from inside RimWorld. The API listens on http://localhost:8765/ by default once the game reaches the main menu. The port can be changed in the mod settings.

API Documentation | For developers

🚀 Features

Monitor current game state

• 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

Game world manipulation

• In development
  camera control, item spawning, event triggering, zone management

Performance optimizations

• Caching - Efficient data updates without game lag
• Field filtering - Request only the data you need
• ETag support - Intelligent caching with 304 Not Modified responses
• Non-blocking operations - Game non-blocking API operations

🔍 Integrations

Share your projects - send integrations to be featured here

Name	Link
Rimworld Dashboard	https://github.com/IlyaChichkov/rimapi-dashboard

🛠️ Usage

1. Start RimWorld with the mod enabled. When the main menu loads the API server will begin listening.
2. The default address is http://localhost:8765/. You can change the port from the RIMAPI mod settings.
3. Use any HTTP client (curl, Postman, etc.) to call the endpoints.

🎯 Example

Request:

curl http://localhost:8765/api/v1/colonists

Response:

{
  "colonists": [
    {
      "id": 123,
      "name": "John",
      "age": 32,
      "health": 1.0
    }
  ]
}

Note: This mod is under active development. API endpoints may change between versions. Always check /api/v1/version for compatibility information.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Credits and Acknowledgments

This project started as a fork of ARROM by MasterPNJ.

• Original Repository: ARROM

A significant portion of the code has been rewritten and new features have been added, but the initial inspiration and base came from the aforementioned project, which is released under the MIT License.

🤝 Contributing

Contributions are welcome! Please feel free to submit pull requests or open issues for bugs and feature requests.