Crate rhachis

Rhachis

Rhachis is a Rust framework primarily intended for making games. It intends to be as simple as possible, while still allowing the customisation and power that writing the engine yourself offers.

The core of the framework is its Game trait and GameData struct. Functions on the Game trait are called repeatedly to handle events and are given a reference to a GameData struct which gives access to the engine’s core state. This struct is passed down through all subsystems to allow a modular system with several combinations of components.

Example

This example shows the bare minimum required to make a program start at all in Rhachis.

use rhachis::{graphics::EmptyRenderer, *};

#[rhachis::run]
struct Window(EmptyRenderer);

impl Game for Window {
    fn init(_: &GameData) -> Self {
        Self(EmptyRenderer)
    }

    fn get_renderer(&mut self) -> &mut dyn graphics::Renderer {
        &mut self.0
    }
}

More in depth examples can be found in the repository’s examples directory.

Modules

graphics

Code specialised in handling graphics. Most of this is universally applicable.

input

Interacting with user keyboard or mouse inputs.

math

A collection of functions that are useful for games.

postprocess

A renderer to wrap around other renderers to modify their output.

rand

Random generation functions convenient for game development.

renderers

A collection of rendering structs that could be used for simple or temporary parts of a pipeline.

text

Simple text rendering.

ui

A Renderer specifically for rendering UIs.

Macros

set_transforms

Implements a default way to replace transforms on a UiElement

Structs

GameData

A struct containing most of the global state of the engine.

IdMap

A collection of data and an associated ID. Provides many convenience functions over HashMaps.

Traits

Game

A trait that all games must implement to use Rhachis

GameExt

Automatically implemented on everything that implements Game.

Attribute Macros

run

Shorthand for making a main function.