Skip to content

Commit a4f0611

Browse files
committed
Update README
1 parent 48fc1e2 commit a4f0611

1 file changed

Lines changed: 18 additions & 10 deletions

File tree

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,9 @@
88

99
# RimAPI
1010

11-
It's a RimWorld mod that gives you an API Server to interact with the game.
11+
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.
1212

13-
RimAPI exposes a comprehensive REST API from inside RimWorld.
14-
The API listens on `http://localhost:8765/` by default once the
15-
game reaches the main menu.
13+
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.
1614

1715
<table>
1816
<tr>
@@ -32,6 +30,8 @@ game reaches the main menu.
3230
## 🚀 Features
3331

3432
### Monitor current game state
33+
- **Game Controls** - Change game settings, modlist, start a new RimWorld game or load one from saves
34+
- **Global & Colony map** - Get a list of caravans or items inside your storage
3535
- **Real-time colony status** - Get current game time, weather, storyteller, and difficulty
3636
- **Colonist management** - Track health, mood, skills, inventory, and work priorities
3737
- **Resource tracking** - Monitor food, medicine, materials, and storage utilization
@@ -42,9 +42,9 @@ game reaches the main menu.
4242

4343
### Performance optimizations
4444
- **Caching** - Efficient data updates without game lag
45-
- **Field filtering** - Request only the data you need
46-
- **ETag support** - Intelligent caching with 304 Not Modified responses
4745
- **Non-blocking operations** - Game non-blocking API operations
46+
- **Field filtering [todo]** - Request only the data you need
47+
- **ETag support [todo]** - Intelligent caching with 304 Not Modified responses
4848

4949
![alt text](../media/media/banner_get_colonist.jpg)
5050

@@ -54,7 +54,7 @@ Share your projects - send integrations on discord server
5454

5555
## 🛠️ Usage
5656

57-
1. Start new RimWorld game or load one from saves with the mod enabled. When game map is loaded the API server will begin listening.
57+
1. 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.
5858
2. The default address is `http://localhost:8765/`. You can change the port from the RIMAPI mod settings.
5959
3. Use any HTTP client (curl, Postman, etc.) to call the endpoints.
6060

@@ -67,10 +67,18 @@ This project is licensed under the GNU GPLv3 License - see the [LICENSE](https:/
6767

6868
## 👥 Credits and Acknowledgments
6969

70-
Thanks to MasterPNJ and his project for insipiration: [ARROM](https://github.com/MasterPNJ/API-REST-RimwOrld-Mod)
70+
Thanks to MasterPNJ and his project for inspiration.
7171

72-
Thanks to @braasdas and his [RatLab](https://github.com/braasdas/ratlab-mod-github)
73-
for code reference and contributions
72+
Thanks to @braasdas and his RatLab project for code reference.
73+
74+
Contributors: @braasdas, @M4x28
75+
76+
## 📌 Links
77+
78+
- [RimWorld Dashboard [#Web]](https://github.com/IlyaChichkov/rimapi-dashboard)
79+
- [RatLab [#Mod]](https://github.com/braasdas/ratlab-mod-github)
80+
- [RimAPI MCP [#AI]](https://github.com/M4x28/RimAPI_MCP_Server)
81+
- [ARROM [#Analogs]](https://github.com/MasterPNJ/API-REST-RimwOrld-Mod)
7482

7583
## 📋 Changelog
7684

0 commit comments

Comments
 (0)