Merge MVP into main

.gitattributes

@@ -0,0 +1 @@
+docs/guides/img/writing-advanced-validations/using-character-abilities/sample-gameplay-session.gif filter=lfs diff=lfs merge=lfs -text

README.md

@@ -4,13 +4,14 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
 
 ## Installation
 
-```
-$ yarn
+```bash
+$ npm install yarn
+$ yarn install
 ```
 
 ## Local Development
 
-```
+```bash
 $ yarn start -p 3005
 ```
 
@@ -33,7 +34,7 @@ This command starts a local development server and opens up a browser window. Mo
 * An image is always located within an `/img` directory at a reasonable depth in relation to the md that requires that image. The idea here is to make it easy to locate and link to images, so keep them close-by.
   * Rule of thumb -> either same level as the md, or at its parent's level (`img/my-image.png` or `../img/my-image.png`)
 * If an `/img` dir contains many images or is shared by many pages, organize images into subdirectories that match the names of the markdown files they belong to.
-  * Ex. images belonging to `docs/tutorials/building-your-first-bot` should be located under `docs/tutorials/img/building-your-first-bot/` 
+  * Ex. images belonging to `docs/guides/creating-your-first-automated-test` should be located under `docs/guides/creating-your-first-automated-test/img` 
 
 ### Misc.
 * DO NOT include important headers in partials - Docusaurus won't include these in the table-of-contents for any pages they are used in.

docs/additional-game-samples.mdx

@@ -0,0 +1,9 @@
+---
+sidebar_label: 'Additional Game Samples'
+---
+
+# Additional Game Samples
+
+import Placeholder from './partials/_placeholder.mdx';
+
+<Placeholder />

docs/changelog.mdx

@@ -180,7 +180,7 @@ _April 8th, 2024_
 _February 29, 2024_
 
 **New Features**
-- Introducing an [automated UI testing framework for Unity](/automated-testing/overview)
+- Introducing an [automated UI testing framework for Unity](404)
 - An entirely new way of [representing states] requiring less custom integration
 - [Rolling Out] New UI design - send us a message for access!
 
@@ -198,7 +198,7 @@ _February 29, 2024_
 _December 19, 2023_
 
 **New Features**
-- Our new [quickstart guide](/quickstart) allows you to have your first bot running in minutes
+- Our new [quickstart guide](404) allows you to have your first bot running in minutes
 - `[RGState]` is now allowed on class properties
 - Support for raw key press actions using the new Unity Input System, which works great for certain types of bots
 - Code generation time has been reduced, and is now automatic
@@ -231,10 +231,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/adaptive-bots))
-- Introducing [**Bot Marketplace**](pre-made-bots) (Beta), which provides ready-to-go bots and integration instructions for those bots
+- Introducing C# bots that run **directly in Unity** (reference materials [here](404)
+- Introducing [**Bot Marketplace**](unused-content/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/csharp/agent-builder) (Beta), which provides a fast, low-code way to develop bots
+- Introducing [**Agent Builder**](unused-content/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
@@ -317,7 +317,7 @@ us at [email protected] for dedicated support and access.
 **New Platform Features**
 
 - 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
+- [GitHub Actions and Unity Test Runner Support](404) - 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
 - Updated defaults for RG Unity SDK to be more user-friendly
@@ -357,17 +357,17 @@ us at [email protected] for dedicated support and access.
 
 - [Agent Builder](404) Beta - Our GPT-enabled agent builder product is live for select players, now with improved validation tools. If you'd like to try it out, let us know!
 - Our documentation site is now live! This docs site includes API/SDK references, tutorials, guides, and FAQs for both players and developers.
-- [API Keys](authenticating-with-api-keys) - developers and players can now create API keys to interact with RG services
+- [API Keys](core-concepts/authenticating-with-api-keys) - developers and players can now create API keys to interact with RG services
 - New onboarding flow for players and game developers
 - The ID of a bot can now be seen and copied within the Bot Manager
 - Zip Bots - Bots uploaded via zip can now be downloaded
 - The home page has been redesigned to provide players more information about getting started.
 
 **Unity SDK Features**
 
-- An early preview of our [Unity SDK](overview) for building AI agents is now live! Our docs site has a getting started guide - message us for access.
+- An early preview of our [Unity SDK](what-is-regression-games) for building AI agents is now live! Our docs site has a getting started guide - message us for access.
 - Developers can now create Unity bots from the Bot Manager
-- Logs for bots can now be downloaded - available via API or through the [Bot History dashboard](session-insights/in-editor-replay)
+- Logs for bots can now be downloaded - available via API or through the [Bot History dashboard](unused-content/session-insights/in-editor-replay)
 - Character configuration for Unity bots is more flexible and customizable
 - Validation results for QA testing bots are now saved to Unity Replay files, allowing for viewing the validation directly within Unity
 - Default settings for the SDK have been adjusted for increased ease of use

docs/computer-vision/computer-vision.mdx

@@ -1,5 +1,5 @@
 ---
-sidebar_label: 'Overview'
+sidebar_label: 'Computer Vision'
 title: 'Computer Vision'
 ---
 

docs/core-concepts/authenticating-with-api-keys.mdx

@@ -0,0 +1,40 @@
+---
+sidebar_label: 'Authenticating with API Keys'
+---
+
+import CreateAPIKey from "../partials/_create-api-key-partial.mdx"
+import SetAPIKeyInUnity from "../partials/_set-api-key-in-unity-partial.mdx"
+
+# Authenticating with API Keys
+
+The Regression Games platform provides the ability to generate API keys, which can be used
+to authenticate against our API. This is the recommended way to authenticate against our API
+when connecting external systems to Regression Games.
+
+You can find the **API Keys** section near the bottom of your [Regression Games account settings](https://play.regression.gg/account).
+
+## Generating an API Key
+
+<CreateAPIKey />
+
+## Using an API Key
+
+Once you have generated an API key, you can use it to authenticate against our API.
+
+### In the Unity SDK
+
+<SetAPIKeyInUnity />
+
+### Sending API Requests
+
+Include the key in the `Authorization` header of each request you send to our API.
+
+```
+HEADERS
+Authorization: Bearer <API_KEY>
+```
+
+## Revoking API Keys
+
+You can remove API Keys at any time by deleting them from the **API Keys** section.
+Next to each key is a delete icon, which immediately revokes the key.

docs/core-concepts/bot-sequences/actions.mdx

@@ -0,0 +1,9 @@
+---
+sidebar_label: 'Actions'
+---
+
+# Actions
+
+import Placeholder from '../../partials/_placeholder.mdx';
+
+<Placeholder />

docs/core-concepts/bot-sequences/end-criteria.mdx

@@ -0,0 +1,9 @@
+---
+sidebar_label: 'End Criteria'
+---
+
+# End Criteria
+
+import Placeholder from '../../partials/_placeholder.mdx';
+
+<Placeholder />

docs/core-concepts/bot-sequences/getting-started-with-bot-sequences-and-segments.mdx

@@ -0,0 +1,60 @@
+---
+sidebar_label: 'Getting Started With Bot Sequences and Segments'
+---
+
+import SequenceCard from './img/sequence_card.png';
+import SequenceList from './img/sequences_list.png';
+import SequenceEditing from './img/sequence_editing.gif';
+import SequenceDeleteDialog from './img/sequence_delete.png';
+import CreateSequenceButton from './img/create_sequence_button.png';
+import ReloadIcon from './img/reload.png';
+
+# Getting Started With Bot Sequences and Segments
+
+A **Bot Sequence** is a series of automated actions that can be used to both drive and assert certain behaviours or outcomes within your game. These actions are referred to as **Segments**. 
+
+<img src={SequenceList} alt="A list of Bot Sequences" style={{display: 'block',width: '100%', borderRadius: '8px'}} />
+
+## Starting A Bot Sequence
+
+After [adding the RGOverlayCanvas prefab to your scene](../../getting-started/installing-regression-games.mdx), click on the Williward icon in the RG Toolbar to open the overlay. With the overlay opened, you can see the list of Bot Sequences that are available to you. Each Sequence is represented by a card, with three possible actions:
+- **Play**: Start the Bot Sequence, beginning with its first Segment
+- **Edit**: Open the Bot Sequence in the Sequence Editor [(see the next section)](./actions.mdx)
+- **Delete**: Delete the Bot Sequence file from your project [(see the next section)](./actions.mdx)
+
+<div style={{width: '100%'}}>
+<img src={SequenceCard} alt="Sequence Card" style={{display: 'block', width: '300px', margin: '0 auto', borderRadius: '8px'}} />
+</div>
+
+## Creating and Modifying Bot Sequences
+
+### Within Unity
+
+With the overlay open, click the "Create a new Sequence" button to create a new Bot Sequence in our Sequence Editor.
+
+<div style={{width: '100%'}}>
+<img src={CreateSequenceButton} alt="Create Sequence Card" style={{display: 'block', width: '300px', margin: '0 auto', borderRadius: '8px'}} />
+</div>
+
+<br />
+
+Within the Sequence Editor, you can add, remove, and reorder Segments. The available Segments can be searched for by **name**, and are added to the Sequence by dragging them from the list on the right to the Sequence in the middle of the editor. When a Sequence is played, it will execute its Segments from top to bottom.
+
+<img src={SequenceEditing} style={{borderRadius: '8px'}}/>
+
+You can also delete a Sequence by clicking the trash icon on the Sequence card in the overlay. A confirmation dialog will appear to ensure you don't delete a Sequence by accident.
+
+<div style={{width: '100%'}}>
+<img src={SequenceDeleteDialog} alt="Delete Sequence dialog" style={{display: 'block', height: '200px', margin: '0 auto', borderRadius: '8px'}} />
+</div>
+
+### Outside of Unity
+
+Bot Sequences and Segments are saved as **json** files in your Unity project. You can edit these files directly in a text editor. [In the next sections](./actions.mdx) you can find more information on the structure of these files.
+
+If you have created or modified any Sequences or Segments outside of Unity, you can click the refresh button in the overlay to reload them from disk. Bot Sequences can be reloaded from the Sequence list, and Segments can be reloaded from within the Sequence Editor.
+
+<div style={{width: '100%', display: 'flex'}}>
+<p style={{paddingTop: '10px', paddingRight: '8px'}}>Keep your eye out for this icon to reload!</p>
+<img src={ReloadIcon} alt="Reload Sequences or Segments icon" style={{display: 'block', width: '55px', height: '50px', borderRadius: '8px'}} />
+</div>

docs/core-concepts/gameplay-sessions.mdx

@@ -0,0 +1,41 @@
+---
+sidebar_label: 'Gameplay Sessions'
+---
+
+# Gameplay Sessions
+
+A **Gameplay Session** is automatically saved to your Regression Games account whenever you
+manually [record gameplay](recording-gameplay),
+[replay a recording](recording-gameplay#replaying-recordings), or use a feature that records its
+own gameplay such as running a [Bot Sequence](bot-sequences/getting-started-with-bot-sequences-and-segments).
+
+Learn more about the data we capture through our SDK in the
+[Recording Gameplay](recording-gameplay#recorded-data-formats) section.
+
+## Viewing Gameplay Sessions
+
+You can view a list of your saved Gameplay Sessions through the
+[Gameplay Sessions dashboard](https://play.regression.gg/sessions) in the Regression Games web interface.
+
+At a glance, each Session displays a summary including the date and time it was recorded,
+duration of its gameplay, and the number of ticks captured in total.
+Selecting a Session reveals more details through a tick scrubber that allows you to view
+a timeline of the game's state, user inputs, and performance data alongside a screenshot of the game
+at a specific tick.
+
+![Gameplay Sessions Dashboard](img/gameplay-sessions/gameplay-sessions-dashboard.png)
+
+## Using Gameplay Sessions to Create Validation Suites
+
+A Gameplay Session is the foundation for creating a [Validation Suite](validation-suites).
+Data from the Session is used to determine which entities and components from your game are available to
+use in Validation Steps defined through the [Scenario Builder](validation-suites#validation-scenarios).
+
+To create a Validation Suite from a Session, select the Session from the list and click the
+**Create a Validation Suite From This Session** button.
+This will present a dialog where you'll give the Suite a name and optional description.
+Once you create your Suite, you will be redirected to the Suite's details page in the
+[Validation Suites dashboard](https://play.regression.gg/validations).
+
+Alternatively, you can create a new Validation Suite from the [Validation Suites dashboard](https://play.regression.gg/validations)
+by clicking the **Create Suite** button and selecting the Session you wish to use from a dropdown in the creation dialog.