From 60a6206c6e407459074d7c451640892c16c0cf7f Mon Sep 17 00:00:00 2001 From: Alexejhero <32238504+Alexejhero@users.noreply.github.com> Date: Sun, 22 Dec 2024 23:59:22 +0200 Subject: [PATCH] Update documentation --- .github/workflows/godot-sdk-publish.yml | 2 +- Godot/README.md | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/workflows/godot-sdk-publish.yml b/.github/workflows/godot-sdk-publish.yml index 3d4b45e..271e4fd 100644 --- a/.github/workflows/godot-sdk-publish.yml +++ b/.github/workflows/godot-sdk-publish.yml @@ -16,7 +16,7 @@ jobs: - name: Create archive run: | cd Godot - zip -r NeuroSdk.zip addons + zip -r NeuroSdk.zip addons neuro_sdk_config.gd - name: Upload to release uses: svenstaro/upload-release-action@v2 diff --git a/Godot/README.md b/Godot/README.md index 2bbeae4..0efd6a2 100644 --- a/Godot/README.md +++ b/Godot/README.md @@ -8,14 +8,16 @@ If you encounter any issues while using this SDK, please open an issue in this r ## Installation -1. Clone or download this repository, then copy the [`Godot/addons`](./addons) folder into your Godot project folder. +You can download this SDK from the [Godot Asset Library](https://godotengine.org/asset-library/asset/14968). The download there will always contain the latest commit on the `main` branch. + +If the above download does not work, you can use the direct link to the [latest release](https://github.com/VedalAI/neuro-game-sdk/releases/tag/godot). ## Setup 1. Enable the plugin: - In the Godot editor, go to `Project > Project Settings > Plugins`, - Click on the Enable checkbox on the `Neuro SDK` entry to enable the plugin. -2. Set the `game` variable in the [`res://addons/neuro-sdk/neuro_sdk_config.gd`](./addons/neuro-sdk/neuro_sdk_config.gd) script to the name of your game. +2. Set the `game` variable in the [`res://neuro_sdk_config.gd`](./neuro_sdk_config.gd) script to the name of your game. 3. Set the `NEURO_SDK_WS_URL` environment variable to the websocket URL you use for testing. ### Usage