docs.rs failed to build olc_pixel_game_engine-0.1.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

Visit the last successful build: olc_pixel_game_engine-0.6.0

olcPixelGameEngine-rs

Rust bindings and API for olcPixelGameEngine.

Library offers Rust API for olcPixelGameEngine. The code builds on macOS/OSX (any 10.x, including older versions, only X11 is required) and uses my mac port of pixel game engine https://github.com/sadikovi/olcPixelGameEngine-macos.

The code should build on Linux as well after you update build.rs file to compile pixel game engine on Linux. I will try addressing it soon but the fixes are more than welcome.

You can link the crate as a dependency and extend Application trait to run the pixel game engine:

extern crate olc_pixel_game_engine;

use crate::olc_pixel_game_engine as olc;

struct ExampleProgram {}

impl olc::Application for ExampleProgram {
  fn on_user_create(&mut self) -> Result<(), olc::Error> {
    // Mirrors `olcPixelGameEngine::onUserCreate`.
    // Your code goes here.
    Ok(())
  }

  fn on_user_update(&mut self, _elapsed_time: f32) -> Result<(), olc::Error> {
    // Mirrors `olcPixelGameEngine::onUserUpdate`.
    // Your code goes here.
    Ok(())
  }

  fn on_user_destroy(&mut self) -> Result<(), olc::Error> {
    // Mirrors `olcPixelGameEngine::onUserDestroy`.
    // Your code goes here.
    Ok(())
  }
}

fn main() {
  let mut example = ExampleProgram {};
  // Launches the program in 256x240 "pixels" screen, where each "pixel" is 4x4 pixel square,
  // and starts the main game loop.
  olc::start("Hello, World!", &mut example, 256, 240, 4, 4).unwrap();
}

I recommend checking out the documentation to see what APIs are available.

Examples

You can look at the examples in examples/ directory to get a sense of available APIs,
make sure to also check out docs.

I will be adding more examples in that directory. Some of them are the direct ports of olcPixelGameEngine examples and videos. Feel free to add more as you explore the pixel game engine!

Run examples

For example, run the Isometric Tiles demo with cargo run --example isometric_tiles.

Build

Run cargo build to build the project.

Test

Run cargo test for the project tests.

Docs