You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-10Lines changed: 18 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,9 @@
8
8
9
9
# RimAPI
10
10
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.
12
12
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.
16
14
17
15
<table>
18
16
<tr>
@@ -32,6 +30,8 @@ game reaches the main menu.
32
30
## 🚀 Features
33
31
34
32
### 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
35
35
-**Real-time colony status** - Get current game time, weather, storyteller, and difficulty
36
36
-**Colonist management** - Track health, mood, skills, inventory, and work priorities
37
37
-**Resource tracking** - Monitor food, medicine, materials, and storage utilization
@@ -42,9 +42,9 @@ game reaches the main menu.
42
42
43
43
### Performance optimizations
44
44
-**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
47
45
-**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
0 commit comments