Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

First draft for bot documentation #14

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

junaidzaidi
Copy link
Contributor

Added Documentation for Custom Bot, DQN Bot, DQN Bot with Joystick
Updated InsertCoin with parameters like 'enableBots' and 'botOptions'

@vercel
Copy link

vercel bot commented Sep 22, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
playroom-2dparkour ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 25, 2023 4:20pm
playroom-carsonroof ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 25, 2023 4:20pm
playroom-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 25, 2023 4:20pm
playroom-draw ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 25, 2023 4:20pm
playroom-r3f-shooter-game ❌ Failed (Inspect) Oct 25, 2023 4:20pm

@vercel
Copy link

vercel bot commented Sep 22, 2023

Someone is attempting to deploy a commit to a Personal Account owned by @asadm on Vercel.

@asadm first needs to authorize it.

Added
- sample joystickConfig object
- sample DQN Specs object
Comment on lines 20 to 21
// Implement your custom bot logic and methods here
}
Copy link
Owner

Choose a reason for hiding this comment

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

Start with a very simple example instead of empty class

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Resolved in separate PR

Comment on lines 14 to 16
Subsequently, extend this base Bot class for your custom bot.
This class is devoid of any predefined methods; its primary role
is to ascertain that your custom bot is identified as a Bot type within the SDK.
Copy link
Owner

Choose a reason for hiding this comment

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

Simplify, too complex words

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Resolved in separate PR


// OPTIONAL: If you want botParams object for the initialization of custom bot class.
botParams: {
... YourCustomBot parameters,
Copy link
Owner

Choose a reason for hiding this comment

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

Also give an example and explain this goes to constructor as object in first parameter

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Resolved in separate PR

... YourCustomBot parameters,
}
},
}).then(() => {
Copy link
Owner

Choose a reason for hiding this comment

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

Use await

Copy link
Contributor Author

@junaidzaidi junaidzaidi Sep 22, 2023

Choose a reason for hiding this comment

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

Resolved in separate PR


```js
if (player.isBot()) {
// Logic to make the bot act within the game loop
Copy link
Owner

Choose a reason for hiding this comment

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

Call the custom method you defined in above class as example

Copy link
Contributor Author

@junaidzaidi junaidzaidi Sep 22, 2023

Choose a reason for hiding this comment

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

Resolved in separate PR

@@ -0,0 +1,90 @@
# DQN Bot Integration with Playroom
Copy link
Owner

Choose a reason for hiding this comment

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

can you move dqn and dqnjoystick in a separate PR. Let's first launch custom / basic bot only.

@Acorn-Studios
Copy link
Contributor

Acorn-Studios commented Jun 24, 2024

Does this need to be updated and pushed for the latest docs version or are we just leaving it?

(I can make updating changes if needed on a separate pull req.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants