update README
This commit is contained in:
17
README.md
17
README.md
@ -43,6 +43,23 @@ flutter run -d macos # For macOS
|
|||||||
flutter run -d linux # For Linux
|
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
|
## Usage
|
||||||
|
|
||||||
### Creating a Project
|
### Creating a Project
|
||||||
|
|||||||
Reference in New Issue
Block a user