From 9af1dc9fef9cef6e21eaa4e209b168f03c06040d Mon Sep 17 00:00:00 2001 From: TomH1004 Date: Wed, 15 Oct 2025 14:42:21 +0200 Subject: [PATCH] update README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 4207dca..e00a78e 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,23 @@ flutter run -d macos # For macOS flutter run -d linux # For Linux ``` +## Example + +Check out the `Example/` folder for a complete Unity integration example! It includes: + +- **UDPCommandListener.cs**: A Unity C# script that listens for UDP commands and executes them +- **unityudp_projects.json**: Sample project with 12 ready-to-use commands (toggle objects, timers, scene control, rotation, colors) +- **README.md**: Detailed setup instructions for Unity + +### Quick Start with Example + +1. Copy `Example/UDPCommandListener.cs` to your Unity project's `Assets/Scripts/` folder +2. Attach it to a GameObject in your scene +3. Copy `Example/unityudp_projects.json` to your Documents folder (see Storage section above) +4. Run your Unity game and start sending commands! + +The example demonstrates simple but practical commands like enabling/disabling objects, starting timers, rotating objects, changing colors, and resetting scenes. + ## Usage ### Creating a Project