Skip to content

Commit

Permalink
[REG-1665] more link fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
nAmKcAz committed Mar 27, 2024
1 parent 5010b66 commit 633e15c
Show file tree
Hide file tree
Showing 5 changed files with 498 additions and 481 deletions.
8 changes: 4 additions & 4 deletions docs/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ _February 29, 2024_

**New Features**
- Introducing an [automated UI testing framework for Unity](/automated-testing/overview)
- An entirely new way of [representating states](/integrating-with-unity/defining-states) requiring less custom integration
- An entirely new way of [representating states] requiring less custom integration
- [Rolling Out] New UI design - send us a message for access!


Expand Down Expand Up @@ -60,10 +60,10 @@ try it out and provide feedback! Contact us at [email protected] for dedicated
**New Features**

- New welcome screen added to the SDK, with docs and **sample scene/bot** options
- Introducing C# bots that run **directly in Unity** (reference materials [here](creating-bots/csharp/configuration))
- Introducing C# bots that run **directly in Unity** (reference materials [here](creating-bots/csharp/adaptive-bots))
- Introducing [**Bot Marketplace**](pre-made-bots) (Beta), which provides ready-to-go bots and integration instructions for those bots
- Introducing **Validation Dashboard** (Beta), which provides an interface to view validation runs for a bot, complete with screenshots, state information, and historical records of previous runs
- Introducing [**Agent Builder**](creating-bots/javascript/agent-builder) (Beta), which provides a fast, low-code way to develop bots
- Introducing [**Agent Builder**](creating-bots/csharp/agent-builder) (Beta), which provides a fast, low-code way to develop bots
- Improved debug utilities like RGGizmos to see what your bot is thinking
- Bots can now be directly synced into your Unity projects
- New tutorials and guides for getting started
Expand Down Expand Up @@ -145,7 +145,7 @@ us at [email protected] for dedicated support and access.

**New Platform Features**

- New [RGAction attribute](integrating-with-unity/defining-actions) within RG Unity SDK to make actions easier to define
- New [RGAction attribute] within RG Unity SDK to make actions easier to define
- [GitHub Actions and Unity Test Runner Support](tutorials/github-actions) - New samples and guides for running bots
in GitHub Actions (and other CI/CD systems via [GameCI](https://game.ci))
- UI improvements to Behavior Tree Beta
Expand Down
10 changes: 5 additions & 5 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ these channels, send an e-mail to [[email protected]](mailto:aaron@regression.

The table below details and links to documentation for the features implemented on our platform.

| **Feature** | **Description** | **Documentation** |
|--------------------------------|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| Unity C# SDK | A C# SDK for implementing bots locally in Unity. | [Link](creating-bots/csharp/csharp-unity-bots) |
| Bot Code Generation | Create bots with low-code tools such as behavior trees powered by GPT. | [Link](creating-bots/csharp/agent-builder) |
| Platform and Language Agnostic | Our protocol permits bots to eventually be written in multiple engines and languages. | _Docs coming soon_ |
| **Feature** | **Description** | **Documentation** |
|--------------------------------|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
| Unity C# SDK | A C# SDK for implementing bots locally in Unity. | [Link](creating-bots/csharp/adaptive-bots) |
| Bot Code Generation | Create bots with low-code tools such as behavior trees powered by GPT. | [Link](creating-bots/csharp/agent-builder) |
| Platform and Language Agnostic | Our protocol permits bots to eventually be written in multiple engines and languages. | _Docs coming soon_ |

## Importing the Regression Games Unity Bots package

Expand Down
130 changes: 65 additions & 65 deletions docs/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,66 +1,66 @@
---
sidebar_label: 'Quickstart'
---

# Quickstart - Sample Scene and Bot

**_Time to complete: 10 minutes_**

This quick walk-through will show you an example scene and bot using the Regression Games Unity SDK. Within a few minutes,
you will have your first bot running in Unity!


## Step 1: Create or open a 3D URP scene

To try out the sample scene, you will need to open or create a project that uses Unity's Universal Render Pipeline (URP).
Within your Unity Hub, search for a template called **3D (URP)**, download it if you haven't already, and create a new
project from that template.

![Create a new project from the 3D URP template](img/quickstart/urp.png)

## Step 2: Import the Regression Games Unity Bots SDK

[Our package is available via GitHub](https://github.com/Regression-Games/RGUnityBots). 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?path=src/gg.regression.unity.bots#v0.0.16
```

- Note that this package uses the new Unity Input System, and will likely ask you to restart the editor - **please select yes to restart**.
- 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/[email protected]/manual/index.html) for serializing/deserializing Json message payloads.

![Screenshot of the package imported into the project](./tutorials/img/building-your-first-bot/tutorial-1-package.png)

## Step 3: Login (optional) and load the scene

Once the package is imported, a welcome pane will open with the ability to login to Regression Games. Create
an account to sync your bot and get access to other [ready-to-go bots](pre-made-bots) and our
[Agent Builder tool](creating-bots/javascript/agent-builder), or skip the login (you can access this later from the
**Regression Games** > **Getting Started** menu).

![Screenshot of the welcome pane](img/quickstart/signin.png)

Once you click continue, you will see a screen that links to documentation and has an option to load a sample scene. Click
that button, which will import the sample scene into a new folder within your Assets directory. Once imported, the scene
will automatically open!

![Screenshot of the welcome pane](img/quickstart/welcome.png)

## Step 4: Run the bot!

Once the scene is open, run the scene by clicking play. Once running, click the Regression Games logo in the bottom right,
and click "Start Bot" button to start the `QuickstartBot` that is provided with the scene.

![Screenshot of the welcome pane](img/quickstart/overlay.png)

You should see the bot move around the platform and attack the enemy!

<div style={{position: "relative", paddingBottom: "50.40485829959515%", height: 0}}><iframe src="https://www.loom.com/embed/c4a31389df6742ba9320bf7dc0e91739?sid=336eaf3b-208c-4ea3-a0b3-c6ad3d2d2cee" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style={{position: "absolute", top: 0, left: 0, width: "100%", height: "100%"}}></iframe></div>

## Next steps

Now that you see a bot in action, you can start building your own! In the next tutorial, you will learn more about the
---
sidebar_label: 'Quickstart'
---

# Quickstart - Sample Scene and Bot

**_Time to complete: 10 minutes_**

This quick walk-through will show you an example scene and bot using the Regression Games Unity SDK. Within a few minutes,
you will have your first bot running in Unity!


## Step 1: Create or open a 3D URP scene

To try out the sample scene, you will need to open or create a project that uses Unity's Universal Render Pipeline (URP).
Within your Unity Hub, search for a template called **3D (URP)**, download it if you haven't already, and create a new
project from that template.

![Create a new project from the 3D URP template](img/quickstart/urp.png)

## Step 2: Import the Regression Games Unity Bots SDK

[Our package is available via GitHub](https://github.com/Regression-Games/RGUnityBots). 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?path=src/gg.regression.unity.bots#v0.0.16
```

- Note that this package uses the new Unity Input System, and will likely ask you to restart the editor - **please select yes to restart**.
- 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/[email protected]/manual/index.html) for serializing/deserializing Json message payloads.

![Screenshot of the package imported into the project](./tutorials/img/building-your-first-bot/tutorial-1-package.png)

## Step 3: Login (optional) and load the scene

Once the package is imported, a welcome pane will open with the ability to login to Regression Games. Create
an account to sync your bot and get access to other [ready-to-go bots](pre-made-bots) and our
[Agent Builder tool](creating-bots/csharp/agent-builder), or skip the login (you can access this later from the
**Regression Games** > **Getting Started** menu).

![Screenshot of the welcome pane](img/quickstart/signin.png)

Once you click continue, you will see a screen that links to documentation and has an option to load a sample scene. Click
that button, which will import the sample scene into a new folder within your Assets directory. Once imported, the scene
will automatically open!

![Screenshot of the welcome pane](img/quickstart/welcome.png)

## Step 4: Run the bot!

Once the scene is open, run the scene by clicking play. Once running, click the Regression Games logo in the bottom right,
and click "Start Bot" button to start the `QuickstartBot` that is provided with the scene.

![Screenshot of the welcome pane](img/quickstart/overlay.png)

You should see the bot move around the platform and attack the enemy!

<div style={{position: "relative", paddingBottom: "50.40485829959515%", height: 0}}><iframe src="https://www.loom.com/embed/c4a31389df6742ba9320bf7dc0e91739?sid=336eaf3b-208c-4ea3-a0b3-c6ad3d2d2cee" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style={{position: "absolute", top: 0, left: 0, width: "100%", height: "100%"}}></iframe></div>

## Next steps

Now that you see a bot in action, you can start building your own! In the next tutorial, you will learn more about the
integration patterns and approaches to building bots in Unity using the Regression Games Unity Bots SDK.
2 changes: 1 addition & 1 deletion docs/tutorials/building-your-first-bot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,6 @@ call.
The following guides and references are great next steps:

* Check out the [bot marketplace](https://play.regression.gg/marketplace) to see what bots are available for your game
* Learn how to build your own bot using the [Agent Builder](/creating-bots/javascript/agent-builder)
* Learn how to build your own bot using the [Agent Builder](/creating-bots/csharp/agent-builder)
* Learn how to setup a [QA / validation testing bot](/session-insights/client-dashboard)
* Learn how to get your bot up and running in a [CI/CD environment such as GitHub Actions](/tutorials/github-actions)
Loading

0 comments on commit 633e15c

Please sign in to comment.