refactor: unity integration (#17)

* refactor: unity integration (#16)

* task: refactor handling of Unity integration

* task: bump gitversion/setup to v3.1.1

* ci: update dotnet.yml

* fix: dotnet build configuration

* fix: dotnet project build configurations

* task: update readme

Author: mrdav30

.assets/scripts/create-unity-package.ps1

@@ -11,9 +11,9 @@ Set-Location (Split-Path $MyInvocation.MyCommand.Path)
 $solutionDir = Get-SolutionDirectory
 Set-Location $solutionDir
 
-$fixedMathSharpPluginsPath = "$solutionDir\src\FixedMathSharp.Editor\bin\Release\net48"
+$fixedMathSharpPluginsPath = "$solutionDir\src\FixedMathSharp\bin\ReleaseUnity\net48"
 $unityProjectPath = "$solutionDir\FMS_UnityProject"
-$unityAssetsPath = "$unityProjectPath\Assets\FixedMathSharp"
+$unityAssetsPath = "$unityProjectPath\Assets\Integration\FixedMathSharp"
 $unityPluginsPath = "$unityAssetsPath\Plugins"
 $packagePath = "$solutionDir\$OutputPath"
 
@@ -32,13 +32,13 @@ if (Test-Path $unityProjectPath) {
 Ensure-GitVersion-Environment $UnityVersion
 
 # Build the project with the version information applied
-Build-Project -Configuration "Release"
+Build-Project -Configuration "ReleaseUnity"
 
 # Copy DLLs (including PDB and XML) to Unity Plugins folder
 Copy-Item "$fixedMathSharpPluginsPath\*" $unityPluginsPath -Recurse -ErrorAction SilentlyContinue
 
 # Copy Unity editor-specific scripts to the Assets folder
-Copy-Item "$solutionDir\src\FixedMathSharp.Editor\Editor" $unityAssetsPath -Recurse -ErrorAction SilentlyContinue
+Copy-Item "$solutionDir\src\FixedMathSharp\Integration\Unity\*" $unityAssetsPath -Recurse -ErrorAction SilentlyContinue
 
 $packageName = "FixedMathSharp.$env:GitVersion_FullSemVer.unitypackage"
 $unityExePath = "C:\Program Files\Unity\Hub\Editor\$env:UnityVersion\Editor\Unity.exe"

.github/workflows/dotnet.yml

@@ -37,9 +37,9 @@ jobs:
         dotnet-version: 8.0.x
 
     - name: Install GitVersion
-      uses: gittools/actions/gitversion/setup@v3.0.0
+      uses: gittools/actions/gitversion/setup@v3.1.1
       with:
-        versionSpec: '6.x'
+        versionSpec: '6.0.x'
 
     - name: Cache NuGet packages
       uses: actions/cache@v3

FixedMathSharp.sln

@@ -5,11 +5,6 @@ VisualStudioVersion = 17.5.33516.290
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "FixedMathSharp", "src\FixedMathSharp\FixedMathSharp.csproj", "{61834921-141D-4BD5-9E75-31188DF32E93}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "FixedMathSharp.Editor", "src\FixedMathSharp.Editor\FixedMathSharp.Editor.csproj", "{48AD1F68-9AD1-495E-B6FF-FA8A27C063A7}"
-	ProjectSection(ProjectDependencies) = postProject
-		{61834921-141D-4BD5-9E75-31188DF32E93} = {61834921-141D-4BD5-9E75-31188DF32E93}
-	EndProjectSection
-EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "FixedMathSharp.Tests", "tests\FixedMathSharp.Tests\FixedMathSharp.Tests.csproj", "{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{882324AE-67F3-4F5B-8485-6EF324A15CBF}"
@@ -21,21 +16,27 @@ EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
+		DebugUnity|Any CPU = DebugUnity|Any CPU
 		Release|Any CPU = Release|Any CPU
+		ReleaseUnity|Any CPU = ReleaseUnity|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
 		{61834921-141D-4BD5-9E75-31188DF32E93}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{61834921-141D-4BD5-9E75-31188DF32E93}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{61834921-141D-4BD5-9E75-31188DF32E93}.DebugUnity|Any CPU.ActiveCfg = DebugUnity|Any CPU
+		{61834921-141D-4BD5-9E75-31188DF32E93}.DebugUnity|Any CPU.Build.0 = DebugUnity|Any CPU
 		{61834921-141D-4BD5-9E75-31188DF32E93}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{61834921-141D-4BD5-9E75-31188DF32E93}.Release|Any CPU.Build.0 = Release|Any CPU
-		{48AD1F68-9AD1-495E-B6FF-FA8A27C063A7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{48AD1F68-9AD1-495E-B6FF-FA8A27C063A7}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{48AD1F68-9AD1-495E-B6FF-FA8A27C063A7}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{48AD1F68-9AD1-495E-B6FF-FA8A27C063A7}.Release|Any CPU.Build.0 = Release|Any CPU
+		{61834921-141D-4BD5-9E75-31188DF32E93}.ReleaseUnity|Any CPU.ActiveCfg = ReleaseUnity|Any CPU
+		{61834921-141D-4BD5-9E75-31188DF32E93}.ReleaseUnity|Any CPU.Build.0 = ReleaseUnity|Any CPU
 		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.DebugUnity|Any CPU.ActiveCfg = DebugUnity|Any CPU
+		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.DebugUnity|Any CPU.Build.0 = DebugUnity|Any CPU
 		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.Release|Any CPU.Build.0 = Release|Any CPU
+		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.ReleaseUnity|Any CPU.ActiveCfg = ReleaseUnity|Any CPU
+		{86CD72E6-2A40-494C-9D9B-A38EF90A12A8}.ReleaseUnity|Any CPU.Build.0 = ReleaseUnity|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

README.md

@@ -24,23 +24,42 @@ Ideal for simulations, games, and physics engines requiring reliable arithmetic
 
 ## 🚀 Installation
 
-### Via NuGet:
-```bash
-dotnet add package FixedMathSharp
-```
 
-### Testing Locally:
-1. Build the package:
-   ```bash
-   dotnet pack --configuration Release
-   ```
-2. Create a local NuGet source and test it:
-   ```bash
-   mkdir ./LocalNuGet
-   cp ./bin/Release/*.nupkg ./LocalNuGet/
-   dotnet nuget add source ./LocalNuGet --name LocalNuGet
-   dotnet add package FixedMathSharp --source ./LocalNuGet
-   ```
+Clone the repository and add it to your project:
+
+### Non-Unity Projects
+
+1. **Install via NuGet**:
+   - Add FixedMathSharp to your project using the following command:
+   
+     ```bash
+     dotnet add package FixedMathSharp
+     ```
+
+2. **Or Download/Clone**:
+   - Clone the repository or download the source code.
+   
+     ```bash
+     git clone https://github.com/mrdav30/FixedMathSharp.git
+     ```
+
+3. **Add to Project**:
+
+   - Include the FixedMathSharp project or its DLLs in your build process.
+
+### Unity
+
+To integrate **FixedMathSharp** into your Unity project:
+
+1. **Download the Package**:
+   - Obtain the latest `FixedMathSharp{{VERSION}}.unitypackage` from the [Releases](https://github.com/mrdav30/FixedMathSharp/releases) section of the repository.
+
+2. **Import into Unity**:
+   - In Unity, navigate to **Assets > Import Package > Custom Package...**.
+   - Select the downloaded `FixedMathSharp{{VERSION}}.unitypackage` file.
+
+3. **Verify the Integration**:
+   - After importing, confirm that the `FixedMathSharp` namespace is accessible in your scripts.
 
 ---