Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/17cupsofcoffee/tetra
🎮 A simple 2D game framework written in Rust
https://github.com/17cupsofcoffee/tetra
2d-game-framework game-development game-engine game-frameworks gamedev rust
Last synced: 7 days ago
JSON representation
🎮 A simple 2D game framework written in Rust
- Host: GitHub
- URL: https://github.com/17cupsofcoffee/tetra
- Owner: 17cupsofcoffee
- License: mit
- Created: 2018-09-30T18:17:43.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-12-10T18:00:48.000Z (about 1 month ago)
- Last Synced: 2024-12-29T16:00:17.576Z (14 days ago)
- Topics: 2d-game-framework, game-development, game-engine, game-frameworks, gamedev, rust
- Language: Rust
- Homepage:
- Size: 9.61 MB
- Stars: 940
- Watchers: 18
- Forks: 63
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- AwesomeCppGameDev - tetra
README
# Tetra
[](https://github.com/17cupsofcoffee/tetra/actions?query=branch%3Amain)
[](https://crates.io/crates/tetra)
[](https://docs.rs/tetra)
[](LICENSE)
Tetra is a simple 2D game framework written in Rust. It uses SDL2 for event handling and OpenGL 3.2+ for rendering.
* [API Docs](https://docs.rs/tetra)
* [Installation Guide](/docs/installation.md)
* [Distribution Guide](/docs/distributing.md)
* [Examples](/docs/examples.md)
* [Tutorial](/docs/tutorial/)
* [FAQ](/docs/faq.md)
## Status
Tetra is being passively maintained, [as of January 2022](https://www.seventeencups.net/posts/three-years-of-tetra/).
No new features are planned, but occasional bugfix updates may still be released from time to time. PRs may be accepted if they don't have a large maintainence burden.
If you're looking for a similar framework that's more actively developed, try [macroquad](https://github.com/not-fl3/macroquad) or [GGEZ](https://github.com/ggez/ggez/). Alternatively, you can try [nova](https://github.com/17cupsofcoffee/nova), my spiritual successor to this library (much smaller scope, still very experimental).
## Features
* XNA/MonoGame-inspired API
* Efficient 2D rendering, with draw call batching by default
* Easy input handling, via polling or events, with support for gamepads
* Deterministic game loop by default, Ã la [Fix Your Timestep](https://gafferongames.com/post/fix_your_timestep/)
* Common building blocks built-in, such as:
* Font rendering
* Cameras
* Screen scaling
## Installation
To add Tetra to your project, add the following line to your `Cargo.toml` file:
```toml
tetra = "0.8"
```
You will also need to install the SDL2 native libraries - full details are provided in the [documentation](https://tetra.seventeencups.net/installation).
## Examples
To get a simple window displayed on screen, the following code can be used:
```rust ,noplaypen
use tetra::graphics::{self, Color};
use tetra::{Context, ContextBuilder, State};
struct GameState;
impl State for GameState {
fn draw(&mut self, ctx: &mut Context) -> tetra::Result {
// Cornflower blue, as is tradition
graphics::clear(ctx, Color::rgb(0.392, 0.584, 0.929));
Ok(())
}
}
fn main() -> tetra::Result {
ContextBuilder::new("Hello, world!", 1280, 720)
.build()?
.run(|_| Ok(GameState))
}
```
You can see this example in action by running `cargo run --example hello_world`.
The full list of examples is available [here](https://tetra.seventeencups.net/examples).
## Support/Feedback
Tetra is fairly early in development, so you might run into bugs/flaky docs/general weirdness. Please feel free to open an issue/PR if you find something! You can also contact me via [Twitter](https://twitter.com/17cupsofcoffee) or the [Rust Game Development Discord](https://discord.gg/yNtPTb2).