Memory and performance improvements

20-30% faster update
-35% less memory used in update
-5% less memory stored after update
135 MB lower memory footprint
Bug fix: Garbage collection now run after update

Author: tsebring

ArkBot/Ark/ArkClusterContext.cs

@@ -42,7 +42,7 @@ private set
             }
         }
 
-        public ArkClusterContext(ClusterConfigSection config) : base(config.SavePath)
+        public ArkClusterContext(ClusterConfigSection config) : base(config.SavePath, true)
         {
             Config = config;
         }

ArkBot/Ark/ArkContextManager.cs

@@ -172,6 +172,9 @@ private void Context_VoteInitiated(ArkServerContext sender, VoteInitiatedEventAr
 
         private void Context_UpdateCompleted(IArkUpdateableContext sender, bool successful, bool cancelled)
         {
+            // Force an immediate garbage collection because it seems more effective (extraction process requires a great deal of memory)
+            GC.Collect();
+
             // When all server contexts have completed one update successfully trigger the InitializationCompleted-event.
             if (!IsFullyInitialized && Servers.All(x => x.IsInitialized) && Clusters.All(x => x.IsInitialized))
             {

ArkBot/Ark/ArkServerContext.cs

@@ -130,7 +130,17 @@ public TimeSpan? ApproxTimeUntilNextUpdate
             }
         }
 
-        public ArkServerContext(IConfig fullconfig, ServerConfigSection config, ArkClusterContext clusterContext, ISavedState savedState, ILifetimeScope scope) : base(config?.SaveFilePath, clusterContext, fullconfig.SavegameExtractionMaxDegreeOfParallelism)
+        public ArkServerContext(
+            IConfig fullconfig,
+            ServerConfigSection config,
+            ArkClusterContext clusterContext,
+            ISavedState savedState,
+            ILifetimeScope scope)
+            : base(
+                  config?.SaveFilePath,
+                  clusterContext,
+                  fullconfig.SavegameExtractionMaxDegreeOfParallelism,
+                  true)
         {
             Config = config;
             _clusterContext = clusterContext;

ArkBot/ArkBot.csproj

@@ -66,13 +66,13 @@
       <HintPath>..\packages\Accord.Statistics.3.5.0\lib\net46\Accord.Statistics.dll</HintPath>
       <Private>True</Private>
     </Reference>
-    <Reference Include="ArkSavegameToolkitNet, Version=1.0.0.0, Culture=neutral, processorArchitecture=MSIL">
-      <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\external\ArkSavegameToolkitNet\$(Configuration)\ArkSavegameToolkitNet.dll</HintPath>
+    <Reference Include="ArkSavegameToolkitNet, Version=1.1.0.0, Culture=neutral, processorArchitecture=MSIL">
+      <HintPath>..\packages\ArkSavegameToolkitNet.1.1.0\lib\net461\ArkSavegameToolkitNet.dll</HintPath>
+      <Private>True</Private>
     </Reference>
-    <Reference Include="ArkSavegameToolkitNet.Domain, Version=1.0.0.0, Culture=neutral, processorArchitecture=MSIL">
-      <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\external\ArkSavegameToolkitNet\$(Configuration)\ArkSavegameToolkitNet.Domain.dll</HintPath>
+    <Reference Include="ArkSavegameToolkitNet.Domain, Version=1.1.0.0, Culture=neutral, processorArchitecture=MSIL">
+      <HintPath>..\packages\ArkSavegameToolkitNet.1.1.0\lib\net461\ArkSavegameToolkitNet.Domain.dll</HintPath>
+      <Private>True</Private>
     </Reference>
     <Reference Include="Autofac, Version=4.3.0.0, Culture=neutral, PublicKeyToken=17863af14b0044da, processorArchitecture=MSIL">
       <HintPath>..\packages\Autofac.4.3.0\lib\net45\Autofac.dll</HintPath>

ArkBot/MainWindow.xaml

@@ -15,7 +15,7 @@
         xmlns:prism="http://prismlibrary.com/"
         mc:Ignorable="d"
         x:Name="mainWindow"
-        Title="ARK Discord Bot" MinWidth="800" MinHeight="600" Width="800" Height="600" WindowStartupLocation="CenterScreen" Icon="basket_empty.ico">
+        Title="ARK Bot" MinWidth="800" MinHeight="600" Width="800" Height="600" WindowStartupLocation="CenterScreen" Icon="basket_empty.ico">
     <i:Interaction.Triggers>
         <i:EventTrigger EventName="Closing">
             <prism:InvokeCommandAction Command="{Binding ClosingCommand}" />

ArkBot/Properties/AssemblyInfo.cs

@@ -6,12 +6,12 @@
 // General Information about an assembly is controlled through the following 
 // set of attributes. Change these attribute values to modify the information
 // associated with an assembly.
-[assembly: AssemblyTitle("ARK Discord Bot")]
-[assembly: AssemblyDescription("")]
+[assembly: AssemblyTitle("ARK Bot")]
+[assembly: AssemblyDescription("ARK Survival Evolved application that monitors and extracts data from local ARK servers and exposes this data through a Web App, Web API and Discord Bot.")]
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyCompany("")]
-[assembly: AssemblyProduct("ArkDiscordBot")]
-[assembly: AssemblyCopyright("Copyright ©  2017")]
+[assembly: AssemblyProduct("ArkBot")]
+[assembly: AssemblyCopyright("Copyright © 2017")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 
@@ -44,5 +44,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.69.*")]
-[assembly: AssemblyFileVersion("1.69.0.0")]
+[assembly: AssemblyVersion("1.70.*")]
+[assembly: AssemblyFileVersion("1.70.0.0")]

ArkBot/ViewModel/Workspace.cs

@@ -193,7 +193,7 @@ static void WriteAndWaitForKey(params string[] msgs)
 
         internal async Task Init()
         {
-            System.Console.WriteLine("ARK Discord Bot");
+            System.Console.WriteLine("ARK Bot");
             System.Console.WriteLine("------------------------------------------------------");
             System.Console.WriteLine();
 

ArkBot/WebApi/Controllers/MapController.cs

@@ -32,30 +32,26 @@ public MapController(IConfig config) : base(config)
         /// <returns></returns>
         public HttpResponseMessage Get(string id)
         {
+            var notfound = new HttpResponseMessage(HttpStatusCode.NotFound) { ReasonPhrase = $@"Map ""{id}"" does not exist!" };
             Bitmap bmp = null;
+            var ms = new MemoryStream();
             try
             {
                 bmp = MapResources.ResourceManager.GetObject($"topo_map_{id}") as Bitmap;
-            }
-            catch (MissingManifestResourceException) { }
-            catch (MissingSatelliteAssemblyException) { }
+                if (bmp == null) return notfound;
 
-            if (bmp == null) return new HttpResponseMessage(HttpStatusCode.NotFound) { ReasonPhrase = $@"Map ""{id}"" does not exist!" };
-
-            var ms = new MemoryStream();
-
-            try
-            {
                 var jpegEncoder = ImageCodecInfo.GetImageEncoders().FirstOrDefault(x => x.FormatID == ImageFormat.Jpeg.Guid);
                 var encParams = new EncoderParameters { Param = new[] { new EncoderParameter(System.Drawing.Imaging.Encoder.Quality, 85L) } };
                 if (jpegEncoder == null) return new HttpResponseMessage(HttpStatusCode.InternalServerError) { ReasonPhrase = "Could not find jpeg encoder." };
 
                 bmp.Save(ms, jpegEncoder, encParams);
                 ms.Seek(0, SeekOrigin.Begin);
             }
+            catch (MissingManifestResourceException) { return notfound; }
+            catch (MissingSatelliteAssemblyException) { return notfound; }
             finally
             {
-                bmp.Dispose();
+                bmp?.Dispose();
             }
 
             var result = new HttpResponseMessage(HttpStatusCode.OK)

ArkBot/packages.config

@@ -4,6 +4,7 @@
   <package id="Accord.MachineLearning" version="3.5.0" targetFramework="net461" />
   <package id="Accord.Math" version="3.5.0" targetFramework="net461" />
   <package id="Accord.Statistics" version="3.5.0" targetFramework="net461" />
+  <package id="ArkSavegameToolkitNet" version="1.1.0" targetFramework="net461" />
   <package id="Autofac" version="4.3.0" targetFramework="net461" />
   <package id="Autofac.Owin" version="4.0.0" targetFramework="net461" />
   <package id="Autofac.SignalR" version="3.0.2" targetFramework="net461" />

README.md

@@ -1,38 +1,39 @@
-# ARK Survival Evolved Discord Bot / Web App / Web API
+# ARK Survival Evolved Companion App / Discord Bot
 
 ![Web-app Interface](https://cloud.githubusercontent.com/assets/408350/26307865/044f849a-3ef7-11e7-930f-9ac829e58d45.png)
 
 ![Discord Bot Commands](https://cloud.githubusercontent.com/assets/408350/25876839/0a91380c-3520-11e7-9172-3a7707cd4c56.png)
 
-## NOTE
-
-### This application is in the very early stages of development.
-
-There are bugs, unfinished/missing features, unoptimized/crappy code, lack of testing and documentation.
-
-
 ## Introduction
 
-The application monitors and extracts data from any number of configured local ARK servers and exposes this data through a Discord Bot and Web API.
+An in-game companion app for players and Discord bot for server administrators.
+
+The application monitors and extracts data from any number of configured local ARK servers and exposes this data through a Web App, Web API and Discord Bot.
 
-It aims to provide important functions to players: dino listings, food-status, statistics; and server admins: rcon-commands, server managing etc. It does not enable cheating or making available data that have a considerable impact on how the game is played.
+It aims to provide important functions to players: dino listings, food-status, breeding info, statistics; and server admins: rcon-commands, server managing etc. It does not enable cheating or making available data that have a considerable impact on how the game is played.
 
 Previously the application utilized a modified version of https://github.com/Qowyn/ark-tools to extract data from savegame-files. It has since been replaced by a faster and more configurable .NET-library developed in conjunction with this application based on Qowyns work on ark-tools.
 
 The application also utilizes creature stat data sourced from Cadons excellent ARK Smart Breeding application (https://github.com/cadon/ARKStatsExtractor).
 
 ## Latest release
-Stable (currently not updated due to the extremely pre-release state of the application)
+### Stable
 
 https://github.com/tsebring/ArkBot/releases
 
-Pre-release built from latest sources (open as zip-archive, binaries under tools/)
+### Pre-release built from latest sources
+Open as zip-archive or change extension to .zip, binaries are located under tools/.
 
 https://www.myget.org/F/tsebring/api/v2/package/ArkDiscordBot
 
-## Configuration in config.json (copy defaultconfig.json template file)
+## Installation
+**For questions/problems: open a GitHub issue or contact me on Discord (Tobias#5051).**
 
-### There are many fields that are not covered below and some information may not be up-to-date. Sticking to the defaultconfig.json setup with minimal changes according to your environment is the safest bet. Open a GitHub issue or contact me on Discord (Tobias#5051) if there are any problems. 
+* Download the latest pre-built binaries (see above).
+* Copy defaultconfig.json and name it config.json.
+* Open config.json in a text editor and go through each setting and change according to your environment (settings are documented below).
+
+## Documentation
 
 **All config settings have descriptions that can be found in:**
 https://github.com/tsebring/ArkBot/blob/master/ArkBot/Config.cs.
@@ -102,31 +103,39 @@ The absolute path of a savegame-file (.ark) to watch for changes and extract dat
 
 The absolute path of the directory where cluster-files are stored. Cluster-files are extracted as part of the server update process triggered by savegame-file (.ark) to watchers.
 
+## Web App
+
+n in-game companion app built on top of the Web API and implemented in Angular (https://angular.io/). 
+
+Features server status, server details, online player listing, per server player-/tribe listings, individual player profile with character- and creature information, including food-status, mating cooldowns, baby age and cuddle timers, breeding info, generator status, crop status, tribe logs and more. 
+
+Url: `webAppListenPrefix`
+Admin url: `webAppListenPrefix`/admin/`serverKey`
 
 ## Web API
 
 RESTful API for accessing exported ARK Server save data via HTTP in JSON- or XML-format. A SignalR hub push server update notifications to connected clients in real-time.
 
-The prebuilt web-app included in this release is by default configured to call the web api on 127.0.0.1:60001. If you want to use another port for the web api you will need to reflect this change in environment.prod.ts and rebuild the web-app dist manually.
+The prebuilt web-app included in this release is by default configured to call the web api on 127.0.0.1:60001. If you want to use another port for the web api you will need to reflect this change in environment.prod.ts and rebuild the web-app dist manually using `ng build --prod --bh /`.
 
 ### Endpoints (base path is configured in `webApiListenPrefix`)
 
-/api/map/`mapName`: ARK topographic maps for (TheIsland, TheCenter and ScorchedEarth_P) sourced from ARK Survival Evolved Wiki (http://ark.gamepedia.com).
+/api/map/`mapName`: ARK topographic maps for (TheIsland, TheCenter, ScorchedEarth_P and Ragnarok) sourced from ARK Survival Evolved Wiki (http://ark.gamepedia.com).
 
 /api/player/`steamId`: Player data for player identified by `steamId` from each configured server instance.
 
 /api/server/`serverKey`: Player and tribe listing from each configured server instance.
 
-/api/adminserver/`serverKey`: Player and tribe listingwith additional creature and structure counts from each configured server instance.
+/api/adminserver/`serverKey`: Player and tribe listing with additional creature and structure counts from each configured server instance.
 
-/api/servers: Server status information including active players and statistics for each configured server instance.
+/api/structures/`serverKey`: Clustered structure data used to show the location of tribes/structures in the ARK.
 
-/signalr/ (hub name `ServerUpdateHub`): Server update notifications using SignalR.
+With [ARK-Server-Beyond-API](https://github.com/tsebring/ARK-Server-Beyond-API) and [ImprovedCommands](https://github.com/tsebring/ImprovedCommands) administrators may remotely destroy and clean-up old structures and tamed creatures in the ARK.
 
-## Web-app (under development)
+/api/servers: User-, access control- and server status information including active players and statistics for each configured server instance.
 
-A web application built on top of the Web API and implemented in Angular (https://angular.io/). 
+/api/administer/`...`: Rcon and other commands exposed through the web app.
 
-Features server status, online player listing, per server player-/tribe listings, individual player profile with character- and creature information with food-status, mating cooldowns, baby age and cuddle timers.
+/api/authentication/`...`: Authenticate players using Steam.
 
-Url: `webAppListenPrefix`/servers
+/signalr/ (hub name `ServerUpdateHub`): Server update notifications using SignalR.