tetra 0.9.1

A simple 2D game framework written in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# Installation


To get started with Tetra, you'll need several things installed, some of which are only needed on certain platforms:

* **All platforms:**
    * The latest stable version of Rust
    * The SDL development libraries
* **Linux:**
    * The ALSA development libraries

## Installing Rust


Installing Rust is pretty simple - just go to [the website](https://www.rust-lang.org/tools/install) and download the Rustup toolchain manager.

Note that if you're developing on Windows with the default toolchain, you'll also need to install the [Microsoft Visual C++ Build Tools](https://www.visualstudio.com/downloads/#build-tools-for-visual-studio-2017). This is used for linking your code together.

## Installing SDL


Tetra uses a library called SDL for windowing and input, so you will need to have its runtime and development libraries installed in order for your project to compile.

Alternatively, you can have SDL automatically compile from source as part of the build process - see [Do I have to install SDL manually?](./faq.md/#do-i-have-to-install-sdl-manually) for more details. 

### Windows


1. Go to [SDL's GitHub releases page](https://github.com/libsdl-org/SDL/releases) and download the version of the development libraries that corresponds to your Rust toolchain.
    * If you're using the MSVC toolchain, download `SDL3-devel-3.xx.x-VC.zip`.
    * If you're using the GNU toolchain, download `SDL3-devel-2.xx.x-mingw.zip`.
2. Inside the .zip file, open the `SDL3-3.xx.x/lib/x64` folder and extract `SDL3.lib` and `SDL3.dll` to the root of your Cargo workspace.

You will also need to distribute `SDL3.dll` with your game - see the [distributing guide](./distributing.md) for more details.

### Mac


The easiest way to install SDL is via [Homebrew](http://brew.sh/):

```bash
brew install sdl3
```

You will also need to add the following to your `~/.bash_profile`, if it is not already present.

```bash
export LIBRARY_PATH="$LIBRARY_PATH:/opt/homebrew/lib:/usr/local/lib"
```

### Linux


The SDL development libraries are usually acquired through your Linux distribution's package manager. Unfortunately, as SDL 3 is relatively new, not every distribution has an up-to-date package yet. If you can't find one for your distro of choice, you can configure Tetra to [build SDL from source](./faq.md/#do-i-have-to-install-sdl-manually) instead.

## Installing ALSA (Linux only)


On Linux, ALSA is used as the audio backend, so you will also need the ALSA development libraries installed. You can find these on most Linux package managers:

```bash
# Ubuntu/Debian

sudo apt install libasound2-dev

# Fedora/CentOS

sudo yum install alsa-lib-devel

# Arch Linux

sudo pacman -S alsa-lib
```