search

Regression-Games / RegressionDocs

Documentation site for Regression Games' games, tools, etc.
0 stars 0 forks source link

[REG-1058] Document how to write unity.js bots #6

Closed abeizer closed 1 year ago

abeizer commented 1 year ago

https://www.loom.com/share/b148028682b840a3a9d10a6da9217f4b?sid=b8131645-f198-4316-9bd9-3514e2ba0758

linear[bot] commented 1 year ago
REG-1058 Create Documentation for JavaScript Unity SDK

This task covers taking the work from [REG-1009](https://linear.app/regression-games/issue/REG-1009/documentation-of-rg-unity-tools-installation-and-integration) and putting it into a cleaned version within Docusaurus. This also includes creating a few samples and examples.

vontell commented 1 year ago

Overall good stuff, a lot of little comments throughout.

I do want to have a team debate about async functions for everything. I see why we did it to try to make the playtest vs validation bots the same, but it feels artificial/weird in the playtest bots and leaves us open to simply forgetting to await breaking the playtest bot expected behavior completely.

Yeah I think having a meeting to discuss our goals for the SDK would be really good - also regarding context on this documentation, we had some initial discussions around those concerns in the PR that implemented these approaches (https://github.com/Regression-Games/RegressionGames/pull/320#discussion_r1238598692)

I personally feel that eventually we will have a base rgbot interface that provides raw functionality, and then a validation framework on top of that. I think we decided on this initial approach since QA was the main use case we wanted to focus on first, so we deemed it was fine for this first pass. But yeah I agree with some of the points too.