# Tetra
[](https://travis-ci.org/17cupsofcoffee/tetra)
[](https://crates.io/crates/tetra)
[](https://www.rust-lang.org/tools/install)
[](https://docs.rs/tetra)
[](LICENSE)
[](https://gitter.im/tetra-rs/community)
Tetra is a simple 2D game framework written in Rust. It uses SDL2 for event handling and OpenGL 3.2+ for rendering.
**Note that Tetra is still extremely early in development!** It may/will have bugs and missing features (the big one currently being audio playback). That said, you're welcome to give it a go and let me know what you think :)
* [Website/Tutorial](https://tetra.seventeencups.net)
* [API Docs](https://docs.rs/tetra)
* [FAQ](https://tetra.seventeencups.net/FAQ)
## Features
* XNA/MonoGame-inspired API
* Efficient 2D rendering, with draw call batching by default
* Simple input handling
* Animations/spritesheets
* TTF font rendering
* Multiple screen scaling algorithms, including pixel-perfect variants (for those chunky retro pixels)
* Deterministic game loop, à la [Fix Your Timestep](https://gafferongames.com/post/fix_your_timestep/)
## Installation
To add Tetra to your project, add the following line to your `Cargo.toml` file:
```
tetra = "0.2"
```
Tetra currently requires Rust 1.31 or higher.
You will also need to install the SDL2 native libraries, as described [here](https://github.com/Rust-SDL2/rust-sdl2#user-content-requirements). The 'bundled' and 'static linking' features described can be activated using the `sdl2_bundled` and `sdl2_static_link` Cargo features in Tetra.
## Examples
To get a simple window displayed on screen, the following code can be used:
```rust
use tetra::graphics::{self, Color};
use tetra::{Context, ContextBuilder, State};
struct GameState;
impl State for GameState {
fn draw(&mut self, ctx: &mut Context, _dt: f64) -> tetra::Result {
// Cornflour 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(&mut GameState)
}
```
You can see this example in action by running `cargo run --example hello_world`.
The full list of examples available are:
* [`hello_world`](examples/hello_world.rs) - Opens a window and clears it with a solid color.
* [`texture`](examples/texture.rs) - Loads and displays a texture.
* [`animation`](examples/animation.rs) - Displays an animation, made up of regions from a texture.
* [`text`](examples/text.rs) - Displays text using a TTF font.
* [`nineslice`](examples/nineslice.rs) - Slices a texture into nine segments to display a dialog box.
* [`keyboard`](examples/keyboard.rs) - Moves a texture around based on keyboard input.
* [`mouse`](examples/mouse.rs) - Moves a texture around based on mouse input.
* [`gamepad`](examples/gamepad.rs) - Displays the input from a connected gamepad.
* [`text_input`](examples/text_input.rs) - Displays text as it is typed in by the player.
* [`scaling`](examples/scaling.rs) - Demonstrates the different screen scaling algorithms.
* [`shaders`](examples/shaders.rs) - Uses a custom shader to render a texture.
* [`tetras`](examples/tetras.rs) - A full example game (which is entirely legally distinct from a certain other block-based puzzle game *cough*).
## Support/Feedback
As mentioned above, Tetra is fairly early in development, so there's likely to be bugs/flaky docs/general weirdness. Please feel free to open an issue/PR if you find something, or leave a question in the [Gitter chat](https://gitter.im/tetra-rs/community).
You can also contact me via [Twitter](https://twitter.com/17cupsofcoffee), or find me lurking in the #gamedev channel on the [Rust Community Discord](https://bit.ly/rust-community).