ARROM – API REST RimwOrld Mod
ARROM – RimWorld REST API Mod
[b]Expose a local HTTP REST API inside RimWorld to query your game data in real time![/b]
Key Features
[list]
[*] [b]Local HTTP Server[/b] – Retrieve colony status, colonists, buildings, research, weather, and more
[*] [b]JSON Responses[/b] – Well-structured JSON, easy to parse in Python, JavaScript, C#, etc.
[*] [b]Multi-Version Support[/b] – Support RimWorld 1.5 & 1.6
[/list]
🚀 Available Endpoints
[list]
[*] [b]/colony[/b] → Colony name, colonist count, total wealth
[*] [b]/letters[/b] → Recent in-game letters
[*] [b]/colonists[/b] & [b]/colonists/<id>[/b] → List & detailed stats (needs, mood, inventory…)
[*] [b]/mods[/b] → Loaded mods
[*] [b]/factions[/b] → Faction relations & goodwill
[*] [b]/research[/b] → Current research project & completed list
[*] [b]/buildings[/b] → Colonist buildings (filter with `?type=`)
[*] [b]/map[/b] → Weather, temperature, hour, season
[*] [b]/animals[/b] → Player-owned animals
[*] [b]/storage[/b] → Stockpiles & storage contents
[*] [b]/alerts[/b] → Active alerts
[*] [b]/jobs[/b] → Colonist current jobs & queued tasks
[*] [b]/map/tiles[/b] → All map tile coordinates
[*] [b]/map/tiles/<x>/<y>[/b] → Details of a specific map tile
[/list]
🌐 Detailed Endpoints
For details on endpoint outputs, please refer to the GitHub readme file. ( [url=https://steamcommunity.com/linkfilter/?u=https%3A%2F%2Fgithub.com%2FMasterPNJ%2FAPI-REST-RimwOrld-Mod%2Fblob%2Fmain%2FREADME.md]https://github.com/MasterPNJ/API-REST-RimwOrld-Mod/blob/main/README.md[/url] )
🛠️ Configuration
[list]
[*] Default HTTP Port: 8765
[*] Cache Refresh Interval: 300 ticks
[/list]
💬 Supported Languages
[list]
[*] 🇫🇷 French
[*] 🇬🇧 English
[*] 🇩🇪 German
[*] 🇪🇸 Spanish
[*] 🇵🇹 Portuguese
[*] 🇨🇳 Chinese (Simplified)
[*] 🇨🇳 Chinese (Traditional)
[*] 🇷🇺 Russian
[*] 🇯🇵 Japanese
[*] 🇰🇷 Korean
[*] Polish
[*] Italian
[/list]
🔗 Link
Github with example of endpoint : [url=https://steamcommunity.com/linkfilter/?u=https%3A%2F%2Fgithub.com%2FMasterPNJ%2FAPI-REST-RimwOrld-Mod]https://github.com/MasterPNJ/API-REST-RimwOrld-Mod[/url]
🚀 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:
[url=https://steamcommunity.com/linkfilter/?u=https%3A%2F%2Fko-fi.com%2Fmasterpnj][img]https://storage.ko-fi.com/cdn/opengraph_assets/default_creator_og/hz_profile_page.png[/img][/url][ko-fi.com]
