What is this?

ggez is a Rust library to create a Good Game Easily.

More specifically, ggez is a lightweight cross-platform game framework for making 2D games with minimum friction. It aims to implement an API based on (a Rustified version of) the LÖVE game framework. This means it contains basic and portable 2D drawing, sound, resource loading and event handling.

ggez is not meant to be everything to everyone, but rather a good base upon which to build. Thus it takes a fairly batteries-included approach without needing a million additions and plugins for everything imaginable, but also does not dictate higher-level functionality such as physics engine or entity component system. Instead the goal is to allow you to use whichever libraries you want to provide these functions, or build your own libraries atop ggez.

Features

Filesystem abstraction that lets you load resources from folders or zip files
Hardware-accelerated 2D rendering built on the gfx-rs graphics engine
Loading and playing .ogg, .wav and .flac files via the rodio crate
TTF font rendering with rusttype, as well as bitmap fonts.
Interface for handling keyboard and mouse events easily through callbacks
Config file for defining engine and game settings
Easy timing and FPS measurement functions.
Math integration with nalgebra
Some more advanced graphics options: shaders, sprite batches and render targets

Supported platforms

Fully supported: Windows, Linux, macOS
Work in progress: Web/WASM/Emscripten
Not officially supported yet (but maybe you can help!): Android, iOS

For details, see docs/BuildingForEveryPlatform.md

Who's using ggez?

Check out the projects list!

Usage

ggez is requires rustc >= 1.27 and distributed on crates.io. To include it in your project, just add the dependency line to your Cargo.toml file:

ggez = "0.5"

See the API docs for full documentation, or the examples directory for a number of commented examples of varying complexity. Most examples show off a single feature of ggez, while astroblasto and snake are a small but complete games.

To run the examples, just check out the source and execute cargo run --example in the root directory:

git clone https://github.com/ggez/ggez.git
cd ggez
cargo run --example astroblasto

If this doesn't work, see the FAQ for solutions to common problems.

Implementation details

ggez is built upon winit for windowing and events, rodio for sound, and a 2D drawing engine implemented in gfx using the OpenGL backend (which currently defaults to use OpenGL 3.2). It should be entirely thread-safe outside of the basic event-handling loop, and portable to Windows, Linux and Mac.

ggez is Pure Rust(tm).

Help!

Sources of information:

The FAQ has answers to common questions and problems.
The API docs, a lot of design stuff is explained there.
Check out the examples.

If you still have problems or questions, feel free to ask! Easiest ways are:
open an issue on the Github issue tracker
say hi in the #rust-gamedev IRC channel on the irc.mozilla.org server
or in the unofficial Rust Discord server

svercl / ggez

readme