Merge pull request #207 from Tiagobuzzz/codex/verify-unity-compatibility

Author: TiagoUltra

README.md

@@ -16,6 +16,10 @@ interlinked systems that model memory, beliefs, personality, emotions and more.
 
 For help and community discussions join our [support channel](https://example.com/discord).
 
+## Unity Integration
+
+See [docs/unity_integration.md](docs/unity_integration.md) for instructions on building a DLL and importing it into a Unity project.
+
 ## Versioning
 
 This project follows [Semantic Versioning](https://semver.org/). Public releases

Unity/UltraWorldAI.asmdef

@@ -0,0 +1,7 @@
+{
+  "name": "UltraWorldAI",
+  "references": [],
+  "includePlatforms": [],
+  "excludePlatforms": [],
+  "allowUnsafeCode": false
+}

docs/unity_integration.md

@@ -0,0 +1,13 @@
+# Unity Integration
+
+This project targets .NET 8 and can be imported into Unity as a managed plugin. Follow these steps to create a DLL that Unity can reference:
+
+1. Build the library in Release mode:
+   ```bash
+   dotnet build -c Release src/UltraWorldAI/UltraWorldAI.csproj
+   ```
+2. Copy the generated `UltraWorldAI.dll` from `src/UltraWorldAI/bin/Release/net8.0/` into your Unity project's `Assets/Plugins` folder.
+3. In Unity, create an Assembly Definition file that references `UltraWorldAI.dll` if you plan to compile scripts separately.
+4. Ensure your Unity project is set to use the `Mono` scripting backend or a version of `IL2CPP` that supports .NET 8 assemblies.
+
+Because the project uses modern .NET features, older versions of Unity may not load the DLL. Unity 2022.3 and newer is recommended.