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

Need better documentation #9

Open
swarupmohalik opened this issue Mar 17, 2021 · 1 comment
Open

Need better documentation #9

swarupmohalik opened this issue Mar 17, 2021 · 1 comment

Comments

@swarupmohalik
Copy link

Need some good documentation for usage. In particular, how to add the details of a game (description, level etc) in init.py?

@rubenvereecken
Copy link
Owner

I agree, it could do with more documentation for different use cases. The best way would be a comprehensive small example of a RL agent.

I can get you started quickly however. If you check out play_vgdl.py, it takes a levelfile and domainfile. Ignoring all the rest of the parameters for now, it registers these with the VGDL registry, after which the environment can be accessed from anywhere through the registry.

If I remember correctly, this basically sets up the VGDL interface, so you access VGDL through its own interface instead of Pybrain or Gym, which are other interfaces VGDL exposes if that's what you prefer.

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

No branches or pull requests

2 participants