Crate wolf_engine

Expand description

Wolf Engine is a game framework for Rust with a focus on flexibility and ease of use. It aims to provide sensible default workflows to those who just want to build a game while allowing custom options for those who don’t want to be forced to do things The Wolf Engine Way (TM).

Getting Started

Wolf Engine ships with sensible defaults to help jump-start projects as quickly as possible. You can get started with the default settings by calling Engine::new(), or alternatively Engine::default().

Engine::new()
    .run(Box::from(my_game_state));

The defaults are probably fine for simple projects, or when you’re just getting started. You can reference the Engine’s documentation if you want to customize the engine.

Game States

Wolf Engine games are organized into one or more game States. These game States bundle your game’s data and logic into a single package that’s easy to pass to the Engine. You will need to implement your game as a State.

pub struct MyGame;

impl State for MyGame {
    fn update(&mut self, _context: &mut Context) -> OptionalTransition {
        // Update your game here.
        None
    }

    fn render(&mut self, _context: &mut Context) -> RenderResult {
        // Render your game here.
    }
}