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

Fix main page example 'Breakout' to 'breakout' #570

Conversation

dscain
Copy link
Contributor

@dscain dscain commented Nov 1, 2024

This PR fixes a typo in the Quickstart of README.md.

If one follows the README.md example below in Linux:

from ale_py import ALEInterface, roms

ale = ALEInterface()
x = roms.get_rom_path("Breakout")
ale.loadROM(x)
ale.reset_game()

reward = ale.act(0)  # noop
screen_obs = ale.getScreenRGB()

you get UserWarning: Rom Breakout not supported. and get_rom_path returns None and then

TypeError: loadROM(): incompatible function arguments. The following argument types are supported:
    1. (self: ale_py._ale_py.ALEInterface, arg0: str) -> None
    2. (self: ale_py._ale_py.ALEInterface, arg0: os.PathLike) -> None

The issue is the file search is case sensitive. To fix, just run the same with breakout instead of Breakout.

Copy link
Member

@pseudo-rnd-thoughts pseudo-rnd-thoughts left a comment

Choose a reason for hiding this comment

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

Thanks for spotting this

@pseudo-rnd-thoughts pseudo-rnd-thoughts merged commit 9bfb918 into Farama-Foundation:master Nov 1, 2024
8 checks passed
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.

2 participants