update readme

Author: drowhunter

NewStarGP-TelemetryMod.sln

@@ -0,0 +1,30 @@
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.5.2.0
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NewStarGPTelemetryMod", "NewStarGPTelemetryMod.csproj", "{2664687F-2C11-F749-66EE-0BBB49ACC5CA}"
+EndProject
+Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "TelemetryLib", "..\SharedLib\TelemetryLib.shproj", "{EEB444E9-0B1F-467D-B01C-EDBA291BC941}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{2664687F-2C11-F749-66EE-0BBB49ACC5CA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{2664687F-2C11-F749-66EE-0BBB49ACC5CA}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{2664687F-2C11-F749-66EE-0BBB49ACC5CA}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{2664687F-2C11-F749-66EE-0BBB49ACC5CA}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {7F34D497-F08F-4A60-9C44-422F889D372B}
+	EndGlobalSection
+	GlobalSection(SharedMSBuildProjectFiles) = preSolution
+		..\SharedLib\TelemetryLib.projitems*{2664687f-2c11-f749-66ee-0bbb49acc5ca}*SharedItemsImports = 5
+		..\SharedLib\TelemetryLib.projitems*{eeb444e9-0b1f-467d-b01c-edba291bc941}*SharedItemsImports = 13
+	EndGlobalSection
+EndGlobal

NewStarGPTelemetryMod.csproj

@@ -4,9 +4,9 @@
     <TargetFramework>net46</TargetFramework>
     <AssemblyName>NewStarGPTelemetryMod</AssemblyName>
     <Product>Newstar Telemetry Plugin</Product>
-    <Version>0.0.1</Version>
+    <Version>1.0.0</Version>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
-    <LangVersion>12.0</LangVersion>
+    <LangVersion>latest</LangVersion>
     <RestoreAdditionalProjectSources>
       https://api.nuget.org/v3/index.json;
       https://nuget.bepinex.dev/v3/index.json;

NewStarTelemetryData.cs

@@ -5,8 +5,6 @@ namespace com.drowhunter.NewStarGPTelemetryMod
     [StructLayout(LayoutKind.Sequential)]
     internal struct NewStarTelemetryData
     {
-        //public Quaternion Orientation;
-
         public float Pitch;
         public float Yaw;
         public float Roll;
@@ -29,7 +27,9 @@ internal struct NewStarTelemetryData
         /// Speed in Meter per Second
         /// </summary>
         public float Speed;       
+        
         public float RPM;        
+        
         public int CurrentGear;
 
         public float TireFL;
@@ -44,16 +44,6 @@ internal struct NewStarTelemetryData
         internal bool IsRacing;
         internal bool IsEventOver;
 
-        //public float WheelFL;
-        //public float WheelFR;
-        //public float WheelBL;
-        //public float WheelBR;
-        //public bool GamePaused;
-        //public bool IsRacing;
-        //public bool Boost;
-
-
-
 
     }
 

README.md

@@ -1,7 +1,48 @@
-# UnityMods
+# New Star GP Telemetry Mod
+
+## Instructions
+
+### Normal Install
+1. Install BepinEx v5 [link](https://github.com/BepInEx/BepInEx/releases/tag/v5.4.23.2) into your game folder.     
+
+2. Place plugin dll file into `BepinEx/plugins` folder
+
+### UUVR install
+1. Download RaiPal [click here](https://github.com/Raicuparta/rai-pal/releases) 
+2. Scan for your games, then click on your game.
+3. Install **UUVR Mono Modern** (which includes BepinEx)
+4. Click the 3 dots next to **UUVR Mono Modern** and then click `Open Mod Folder` (the folder will look like `%APPDATA%\raicuparta\rai-pal\data\installed-mods\[ModId]\`)
+5. Place Telemetry Mod dll into `BepinEx/plugins` folder 
+
+
+## Building
+1. Clone this repository
+
+2. This project also references a project named SharedLib (located [here](https://github.com/Unity-Telemetry-Mods/SharedLib))
+
+    - Check out SharedLib folder beside this project
+
+    - folder structure should look like 
+    ```
+    [This Project]\
+    SharedLib\
+    ```
+
+3. The following files will need to be copied from
+
+    `New Star GP\release\NSGP_Data\Managed\`
+
+    to
+    
+    `[Project]\lib`     
+    - netstandard.dll
+    - Assembly-CSharp_publicized.dll **
+
+4. Open sln file located inside Project Folder
 
 ---
+** *You will need to publicize the Assembly-CSharp file from game using a tool like [Assembly Publicizer](https://github.com/CabbageCrow/AssemblyPublicizer/releases)*
 
 ## Changelog
 
-v 1.2 Added Distance Telemetry Mod
+v 1.0 First Release