[REG-1830] Add documentation for initial monkey bot and action manager implementation #78
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vontell
approved these changes
Jul 5, 2024
docs/generic-bots/monkey-bot.mdx
Outdated
| The automated analysis supports commonly used device input APIs from the Legacy Input Manager, Input System, and Unity UI systems. However, the use of non-standard input handling libraries is not supported. Where possible, the analysis will emit a warning if it is unable to resolve an input. | ||
| ::: | ||
|
|
||
| After the analysis completes, you will see each device input associated with the type of object that listens for it. You can select an action to view more details about it. The checkbox next to each action can be unchecked to exclude the action from consideration by the bot. For example, you may want to exclude "Quit", "Pause", or "Exit" keys or buttons that may interfere with the bot's ability to progress through the game. |
There was a problem hiding this comment.
When it says "you will see each device input associated with the type of object that listens for it", is object the right word? This might be confused with game object, but isn't it more about MonoBehaviours?
There was a problem hiding this comment.
Yeah, that could be confusing. Technically it might not be a MonoBehaviour, e.g. it could be a UnityEngine.UI.Button if it came from Unity UI. To be accurate I've changed this to "component", but do let me know if you think it could be clearer to call it a MonoBehaviour anyways.
nAmKcAz
requested changes
Jul 8, 2024
addisonbgross
approved these changes
Jul 8, 2024
abeizer
requested changes
Jul 8, 2024
docs/generic-bots/monkey-bot.mdx
Outdated
|
|
||
| ## Usage | ||
|
|
||
| For most games, the Monkey Bot can be quickly configured and deployed. First, the bot actions are configured through the Action Manager panel. Then, the monkey bot is started through the Regression Games Bot Manager. |
There was a problem hiding this comment.
Suggested change
| For most games, the Monkey Bot can be quickly configured and deployed. First, the bot actions are configured through the Action Manager panel. Then, the monkey bot is started through the Regression Games Bot Manager. | |
| For most games, the Monkey Bot can be quickly configured and deployed. First, the bot actions are configured through the Action Manager panel. Then, the Monkey Bot is started through the Regression Games Bot Manager. |
docs/generic-bots/monkey-bot.mdx
Outdated
|
|
||
| ### Running The Monkey Bot | ||
|
|
||
| Once you've decided on the actions to include, start the game and navigate to the point where you want the random test to begin. Press the Regression Games logo at the bottom right to open the Regression Games Bot Manager. From here, select the **RGMonkeyBot** behavior and press **Start Bot**. The monkey testing bot will now begin to automatically exercise a variety of game functionality. The bot can be stopped at any time by opening the overlay again and pressing the **Delete** or **Stop All** button. |
There was a problem hiding this comment.
Suggested change
| Once you've decided on the actions to include, start the game and navigate to the point where you want the random test to begin. Press the Regression Games logo at the bottom right to open the Regression Games Bot Manager. From here, select the **RGMonkeyBot** behavior and press **Start Bot**. The monkey testing bot will now begin to automatically exercise a variety of game functionality. The bot can be stopped at any time by opening the overlay again and pressing the **Delete** or **Stop All** button. | |
| Once you've decided which actions to include, start the game and navigate to the point where you want random testing to begin. Press the Regression Games logo in the bottom right-hand corner of the game to open the Regression Games Bot Manager. From here, select the **RGMonkeyBot** behavior and press **Start Bot**. The Monkey Bot will now begin to automatically exercise a variety of game functionality. The bot can be stopped at any time by opening the overlay again and pressing the **Delete** or **Stop All** button. |
|
Thanks for the feedback! I've revised the text based on the given suggested changes. |
nAmKcAz
approved these changes
Jul 9, 2024
abeizer
approved these changes
Jul 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This documentation explains how to get the Monkey Bot running that is now built into the SDK as part of the action manager work. This will be ready to use once the associated PR for the action analysis is merged.