Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[REG-1223] Make git the preferred approach for importing the SDK #26

Merged
merged 2 commits into from
Aug 30, 2023
Merged

[REG-1223] Make git the preferred approach for importing the SDK #26

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f5b481
Make git the preferred approach for importing the SDK
vontell Aug 30, 2023
8be1380
Change language for import
vontell Aug 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/studios/unity/tutorials/first_bot_tutorial_images/tutorial_1_package.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 8 additions & 10 deletions docs/studios/unity/tutorials/first_tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,21 +61,19 @@ the game loop, one for controlling the character, and one for controlling the po

## Import the Regression Games Unity Bots package

Our package is available via GitHub [here](https://github.com/Regression-Games/RGUnityBots). Clone or download the repository,
and import the package by clicking **Add package from disk** in the **Package Manager** window (this window can be opened
in the **Window > Package Manager** menu ).
- Note that this package utilizes TextMeshPro. If you are prompted by Unity to add TextMeshPro assets to your project, please add them.
- Note that this package installs a dependency of Newtonsoft Json (https://docs.unity3d.com/Packages/com.unity.nuget.newtonsoft-json@3.1/manual/index.html) for serializing/deserializing Json message payloads.

![Screenshot of the package imported into the project](first_bot_tutorial_images/tutorial_1_package.png)

You can also download the project directly by clicking the plug button and the **Add package from git URL** option, and
pasting in the following URL.
Our package is available via GitHub [here](https://github.com/Regression-Games/RGUnityBots). Clone and import the repository by
clicking **Add package from git URL** in the **Package Manager** window (this window can be opened
in the **Window > Package Manager** menu) and pasting in the following URL.

```
https://github.com/Regression-Games/RGUnityBots.git
```

- Note that this package utilizes TextMeshPro. If you are prompted by Unity to add TextMeshPro assets to your project, please add them.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rcornwall-reg Be sure to have a PR in Regression Docs to update this line as part of your other work.

- Note that this package installs a dependency of Newtonsoft Json (https://docs.unity3d.com/Packages/com.unity.nuget.newtonsoft-json@3.1/manual/index.html) for serializing/deserializing Json message payloads.

![Screenshot of the package imported into the project](first_bot_tutorial_images/tutorial_1_package.png)

## Restart Unity and your IDE

After installing the Regression Games Unity Bots package and its dependencies into Unity, please restart Unity and your IDE. Without this step, your IDE may not properly resolve the new packages even after Unity recompiles the scripts.
Expand Down
19 changes: 18 additions & 1 deletion docs/studios/unity/unity-sdk/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,21 @@ features on our [feedback site](https://regression-games.sleekplan.app/feedback)
| JavaScript SDK | A JavaScript SDK for implementing bots | [Link](./creating-bots/configuration) |
| Live Reloading | Reload bots almost instantly without rebuilding your game, managed via GitHub | _Docs coming soon_ |
| Bot Code Generation | _Only available in Minecraft, see proposals_. Create bots with low-code tools such as behavior trees powered by GPT. | [Link](../../../players/creating-bots/agent-builder) |
| Platform and Language Agnostic | Our protocol permits bots to eventually be written in multiple engines and languages. Vote for support in the feedback link above. | _Docs coming soon_ |
| Platform and Language Agnostic | Our protocol permits bots to eventually be written in multiple engines and languages. Vote for support in the feedback link above. | _Docs coming soon_ |

## Importing the Regression Games Unity Bots package

Our package is available via GitHub [here](https://github.com/Regression-Games/RGUnityBots). Clone and import the repository by
clicking **Add package from git URL** in the **Package Manager** window (this window can be opened
in the **Window > Package Manager** menu) and pasting in the following URL.

```
https://github.com/Regression-Games/RGUnityBots.git
```

- Note that this package utilizes TextMeshPro. If you are prompted by Unity to add TextMeshPro assets to your project, please add them.
- Note that this package installs a dependency of Newtonsoft Json (https://docs.unity3d.com/Packages/com.unity.nuget.newtonsoft-json@3.1/manual/index.html) for serializing/deserializing Json message payloads.

![Screenshot of the package imported into the project](../tutorials/first_bot_tutorial_images/tutorial_1_package.png)

For a full walkthrough on getting started, see the [Building Your First Bot](../tutorials/first_tutorial.md) tutorial.