Release 2.3.1 metadata & Readme improvements

space928 · Nov 20, 2023 · 5162014 · 5162014
1 parent 6b1c257
commit 5162014
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 3 deletions.
diff --git a/OmsiHook/OmsiHook.csproj b/OmsiHook/OmsiHook.csproj
@@ -10,8 +10,8 @@
     <Description>OmsiHook is a simple library for hooking into Omsi's memory for modding.</Description>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <AssemblyVersion>2.2.0.1</AssemblyVersion>
-    <FileVersion>2.2.0.1</FileVersion>
+    <AssemblyVersion>2.3.1.1</AssemblyVersion>
+    <FileVersion>2.3.1.1</FileVersion>
     <Version>2.3.1</Version>
     <PackageLicenseExpression>LGPL-3.0-only</PackageLicenseExpression>
     <SignAssembly>False</SignAssembly>

diff --git a/OmsiHook/docfx.json b/OmsiHook/docfx.json
@@ -29,7 +29,7 @@
       "_enableNewTab": true,
       "_disableContribution": true,
       "_disableBreadcrumb": false,
-      "_DocumentationVersion": "2.2.0"
+      "_DocumentationVersion": "2.3.1"
     },
     "content": [
       {

diff --git a/OmsiHookRPCPlugin/OmsiHookRPCPlugin.csproj b/OmsiHookRPCPlugin/OmsiHookRPCPlugin.csproj
@@ -106,6 +106,7 @@
 		<PackageIcon>Logo.png</PackageIcon>
 		<PackageLicenseExpression>LGPL-3.0-only</PackageLicenseExpression>
 		<SignAssembly>False</SignAssembly>
+		<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
 	</PropertyGroup>
 	<Target Name="PostBuild" AfterTargets="PostBuildEvent">
 	  <Exec Command="xcopy &quot;$(SolutionDir)$(Configuration)\*.dll&quot; &quot;$(OutDir)&quot; /y&#xD;&#xA;xcopy &quot;$(SolutionDir)$(Configuration)\*.pdb&quot; &quot;$(OutDir)&quot; /y&#xD;&#xA;if not defined OmsiDir (&#xD;&#xA;  set &quot;OmsiDir=D:\Program Files\OMSI 2\&quot;&#xD;&#xA;)&#xD;&#xA;if exist &quot;%25OmsiDir%25plugins\&quot; (&#xD;&#xA;  xcopy &quot;$(OutDir)*.dll&quot; &quot;%25OmsiDir%25plugins\&quot; /y /c&#xD;&#xA;  xcopy &quot;$(OutDir)*.pdb&quot; &quot;%25OmsiDir%25plugins\&quot; /y /c&#xD;&#xA;  xcopy &quot;$(OutDir)*.opl&quot; &quot;%25OmsiDir%25plugins\&quot; /y /c &#xD;&#xA;  xcopy &quot;$(OutDir)*.runtimeconfig.json&quot; &quot;%25OmsiDir%25plugins\&quot; /y /c&#xD;&#xA;)" />

diff --git a/README.md b/README.md
@@ -42,6 +42,7 @@ class Program
     }
 }
 ```
+See the `OmsiExtensionsCLI` [Program.cs](OmsiExtensionsCLI/Program.cs) for more examples using OmsiHook.
 
 ## Project Structure
 This repository contains the source for the OmsiHook and OmsiHookInvoker libraries as well as template 
@@ -55,10 +56,30 @@ Here's a summary of the project structure:
 ┃                             exposing Omsi's internal data.
 ┠─► \OmsiHookInvoker\      -> C++ plugin for invoking native Omsi methods from OmsiHook, 
 ┃                             only used by OmsiHook.
+┠─► \OmsiHookRPCPlugin\    -> An Omsi plugin which exposes native methods from OmsiHookInvoker 
+┃                             to other processes using OmsiHook.
 ┠─► \OmsiExtensionsCLI\    -> Example command line application that uses OmsiHook; runs
 ┃                             outside of Omsi.
 ┠─► \OmsiExtensionsUI\     -> Example Avalonia UI (similar to WPF) application that uses
 ┃                             OmsiHook; runs outside of Omsi.
 ┖─► \OmsiHookPlugin\       -> Example plugin that uses OmsiHook and compiles to a native
                                Omsi plugin by using DNNE.
 ```
+
+## Building
+The project requires .NET 6 SDK to build and only works on Windows x86_32. Because of the nature of 
+the project dependencies, sometimes Visual Studio gets the build order wrong (especially for projects 
+depending on OmsiHookInvoker). When updating to a new version of OmsiHook or if you make changes to 
+OmsiHookInvoker you may need to clean and rebuild the solution; if you're really struggling delete the
+contents of the following directories:
+```
+Omsi-Extensions\Debug
+Omsi-Extensions\Release
+Omsi-Extensions\OmsiExtensionsCLI\bin\
+Omsi-Extensions\OmsiHookPlugin\bin\
+```
+The project can be configured to automatically copy binaries to your Omsi directory. To do so set the 
+`OmsiDir` environment variable to your Omsi directory (eg: `set "OmsiDir=C:\Program Files\OMSI 2\"`).
+You can also set it by editing the Post-build event action in the `OmsiHookRPCPlugin.csproj` and 
+`OmsiHookPlugin.csproj` project files. Note that the binaries are only copied when `OmsiHookRPCPlugin` 
+or `OmsiHookPlugin` is rebuilt.