Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexejhero committed Dec 22, 2024
1 parent 396ffd6 commit 60a6206
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/godot-sdk-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 4 additions & 2 deletions Godot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 60a6206

Please sign in to comment.