[][src]Crate ale

Rust encapsulation of the Arcade Learning Environment.

The main use of the ALE is running Atari 2600 games. An example for how to play breakout is included in the library. Space to start.

git clone --recursive https://github.com/trolleyman/ale-rs.git
cd ale-rs
cargo xtask download-roms  # Breakout ROM needs to be downloaded from a third-party source
cargo run --release --example breakout

Requirements

This library requires the same dependencies as the cmake-rs library. In other words, CMake needs to be installed.

Unsafety

Generally this libarary has tried to encapsulate and minimize unsafety, but there could still be some pain points that I've missed (especially regarding C++ exceptions). Be sure to report an issue if this is the case!

Structs

Ale

Interface to the Arcade Learning Environment emulator

AleState

State of the ALE

Enums

BundledRom

Enum of ROMs that come bundled with the libarary.

LoggerMode