edbeeching / godot_rl_agents

An Open Source package that allows video game creators, AI researchers and hobbyists the opportunity to learn complex behaviors for their Non Player Characters or agents
MIT License
942 stars 69 forks source link

Improvements that may be needed in Custom ENV Doc #33

Closed ryash072007 closed 1 year ago

ryash072007 commented 1 year ago

It should be: "size": [len(get_obs()["obs"])], not: "size": len(get_obs()["obs"]), or an error arises

ryash072007 commented 1 year ago

The zero_reward() Has to be included in the Agent's script or sync.gd tries to execute a non-existent function which makes it so that the game does not run.

ryash072007 commented 1 year ago

In the RaycastSensor script, you should make it optional to allow the raycasts to detect areas as it is not required always. Currently, it always sets the raycast to detect areas.

ryash072007 commented 1 year ago

In the godot_rl_agents script, you should provide direct paths to the sync.gd and icon otherwise the plugin may not always activate. This means it can not be accessed in the add node window.

sync.gd direct path is "res://addons/sync.gd" .

ryash072007 commented 1 year ago

The player/agent has to be in a group called "AGENT", please include this in the docs as well.

ryash072007 commented 1 year ago

The zero_reward() Has to be included in the Agent's script or sync.gd tries to execute a non-existent function which makes it so that the game does not run.

same for var needs_reset

edbeeching commented 1 year ago

That's for highlighting and fixing these issues. If you want to make a pull request that improves the docs it would be much appreciated. It is just me working on this project, mostly in my spare time.

ryash072007 commented 1 year ago

38 Created Pull Request.