Merge pull request #36 from IlyaChichkov/develop

Develop v1.5.0

Author: IlyaChichkov

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "csharpier": {
-      "version": "1.4.1",
+      "version": "1.5.0",
       "commands": [
         "csharpier"
       ],

About/About.xml

@@ -4,7 +4,7 @@
   <description>RIMAPI is a mod that give you an REST API useable for your current game</description>
   <packageId>RedEyeDev.RIMAPI</packageId>
   <author>RedEyeDev</author>
-  <modVersion>1.4.1</modVersion>
+  <modVersion>1.5.0</modVersion>
   <url></url>
   <supportedVersions>
     <li>1.5</li>

About/Manifest.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <Manifest>
     <identifier>redeyedev.rimapi</identifier>
-    <version>1.4.1</version>
+    <version>1.5.0</version>
     <manifestUri>
         https://raw.githubusercontent.com/IlyaChichkov/RIMAPI/refs/heads/main/About/Manifest.xml</manifestUri>
     <downloadUri>https://github.com/IlyaChichkov/RIMAPI/releases</downloadUri>

CHANGELOG.md

@@ -1,4 +1,25 @@
 # Changelog
+## v1.5.0
+
+Impliment API server launch at game menu screen (previously lauched when game map loaded).
+
+Fix GetColonist, GetColonistDetailed output when colonist with Id not found to display error.
+
+Add new endpoints:
+
+[POST] /api/v1/item/spawn
+[POST] /api/v1/game/save
+[POST] /api/v1/game/load
+[POST] /api/v1/game/start/devquick
+[POST] /api/v1/game/start
+[GET] /api/v1/game/settings
+
+Update README.
+
+## v1.4.1
+
+Fix UI blinking during texture make readable
+
 ## v1.4.0
 
 Author: IlyaChichkov

README.md

@@ -1,21 +1,33 @@
-![alt text](About/preview.png)
+![alt text](../media/media/banner_title.jpg)
 
 ![Status](https://img.shields.io/badge/Status-In_Progress-blue.svg)
 ![RimWorld Version](https://img.shields.io/badge/RimWorld-v1.5+-blue.svg)
 ![API Version](https://img.shields.io/badge/API-v0.1.0-green.svg)
 ![Build](https://github.com/IlyaChichkov/RIMAPI/actions/workflows/release_build.yml/badge.svg)
 ![Release](https://img.shields.io/github/v/release/IlyaChichkov/RIMAPI)
 
-# RIMAPI
+# RimAPI
 
-RIMAPI is a RimWorld mod that gives you an API Server to interact with your current game.
+It's a RimWorld mod that gives you an API Server to interact with the game.
 
-RIMAPI exposes a comprehensive REST API from inside RimWorld.
+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.
-
-[  Documentation  ](https://ilyachichkov.github.io/RIMAPI/index.html)|
-[  Discord Server  ](https://discord.gg/Css9b9BgnM)
+game reaches the main menu.
+
+<table>
+  <tr>
+    <td align="center">
+      <a href="https://ilyachichkov.github.io/RIMAPI/index.html" target="_blank">
+        <img src="../media/media/banner_documentation.jpg" alt="Documentation" width="520"/>
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://discord.gg/Css9b9BgnM" target="_blank">
+        <img src="../media/media/banner_discord.jpg" alt="Discord Server" width="520"/>
+      </a>
+    </td>
+  </tr>
+</table>
 
 ## 🚀 Features
 
@@ -34,20 +46,22 @@ game reaches the main menu. The port can be changed in the mod settings.
 - **ETag support** - Intelligent caching with 304 Not Modified responses
 - **Non-blocking operations** - Game non-blocking API operations
 
-## 🔍 Integrations
+![alt text](../media/media/banner_get_colonist.jpg)
 
-Share your projects - send integrations to be featured here
+## 🔍 Integrations
 
-| Name | Link |
-|---   |---   |
-|Rimworld Dashboard | https://github.com/IlyaChichkov/rimapi-dashboard |
-|Food Analysis Script (Python) | https://gist.github.com/IlyaChichkov/1c4455c9f797a277693ee5a3e016ac3d |
+Share your projects - send integrations on discord server
 
 ## 🛠️ Usage
+
 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.
 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.
 
+> More information in the documentation.
+
+![alt text](../media/media/banner_post_edit_pawn.jpg)
+
 ## 📄 License
 This project is licensed under the GNU GPLv3 License - see the [LICENSE](https://github.com/IlyaChichkov/RIMAPI/blob/main/LICENSE) file for details.
 

Source/RIMAPI/RIMAPI_GameComponent.cs

@@ -18,14 +18,13 @@ public RIMAPI_GameComponent(Game game)
         public override void FinalizeInit()
         {
             base.FinalizeInit();
-            StartServer();
 
             GameObject go = new GameObject("MyTextureExporter");
             go.AddComponent<TextureExportManager>();
             UnityEngine.Object.DontDestroyOnLoad(go);
         }
 
-        public void StartServer()
+        public static void StartServer()
         {
             lock (_serverLock)
             {
@@ -84,13 +83,22 @@ public static IRimApiExtension GetExtension(string extensionId)
             return _serverInitialized ? _apiServer?.GetExtension(extensionId) : null;
         }
 
-        public void RestartServer()
+        public static void RestartServer()
         {
             Log.Message("Restarting API server...");
             Shutdown();
             StartServer();
         }
 
+        public static void ProcessServerQueues()
+        {
+            if (!_serverInitialized || _apiServer == null)
+                return;
+
+            _apiServer.ProcessQueuedRequests();
+            _apiServer.ProcessBroadcastQueue();
+        }
+
         public override void GameComponentTick()
         {
             base.GameComponentTick();

Source/RIMAPI/RIMAPI_Mod.cs

@@ -55,11 +55,7 @@ public override void DoSettingsWindowContents(Rect inRect)
 
             if (list.ButtonText("RIMAPI.RestartServer".Translate()))
             {
-                RIMAPI_GameComponent component = Current.Game.GetComponent<RIMAPI_GameComponent>();
-                if (component != null)
-                {
-                    component.RestartServer();
-                }
+                RIMAPI_GameComponent.RestartServer();
             }
 
             bool tempEnableLogging = Settings.EnableLogging;

Source/RIMAPI/RIMAPI_Settings.cs

@@ -5,7 +5,7 @@ namespace RIMAPI
 {
     public class RIMAPI_Settings : ModSettings
     {
-        public string version = "1.4.1";
+        public string version = "1.5.0";
         public string apiVersion = "v1";
         public int serverPort = 8765;
         public int refreshIntervalTicks = 300;

Source/RIMAPI/RIMAPI_Startup.cs

@@ -0,0 +1,14 @@
+using Verse;
+using RIMAPI.Core;
+
+namespace RIMAPI
+{
+    [StaticConstructorOnStartup]
+    public static class RIMAPI_Startup
+    {
+        static RIMAPI_Startup()
+        {
+            RIMAPI_GameComponent.StartServer();
+        }
+    }
+}

Source/RIMAPI/RimApi.csproj

@@ -6,7 +6,7 @@
     <RootNamespace>RIMAPI</RootNamespace>
     <AssemblyName>RIMAPI</AssemblyName>
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
-    <Version>1.4.1</Version>
+    <Version>1.5.0</Version>
   </PropertyGroup>
 
   <!-- Conditional properties for RimWorld 1.5 -->