README.md 1.23 KB
Newer Older
nycex's avatar
nycex committed
1 2
<h1 align="center">axosnake</h1>

3 4
[![Crates.io](https://img.shields.io/crates/v/axosnake.svg)](https://crates.io/crates/axosnake)

nycex's avatar
nycex committed
5 6 7 8 9 10
## About
axosnake is a snake game written in rust with webassembly

![screenshot](screenshot.png)

## How to run
11

nycex's avatar
nycex committed
12 13 14 15 16 17
### Run through web:
Install dependencies for web:
```bash
cargo install cargo-web
```
Run the web server:
nycex's avatar
nycex committed
18 19 20
```bash
cargo web start --target=wasm32-unknown-unknown
```
21

nycex's avatar
nycex committed
22 23 24 25 26 27 28 29 30
### Run locally:
Install axosnake through cargo:
```bash
cargo install axosnake
```
Run the binary:
```bash
axosnake
```
31

nycex's avatar
nycex committed
32 33 34
### Dependencies:
For a list of dependencies look at the [quicksilver dependencies](https://github.com/ryanisaacg/quicksilver#linux-dependencies).

nycex's avatar
nycex committed
35
## Demo
nycex's avatar
nycex committed
36
You can play the game online on http://www.axosnake.tk
37

nycex's avatar
nycex committed
38 39 40 41 42 43 44 45 46 47 48
## Keybinds

### Movement:
- W/Up - Move upwards
- A/Left - Move to the left
- S/Down - Move downwards
- D/Right - Move to the right

### Misc:
- R/F5 - Reset the game

nycex's avatar
nycex committed
49
## Credits
nycex's avatar
nycex committed
50 51
- [logo](logo.png) *"axolotl"* by [@Senk Ju](https://senkju.net)
- [font](static/font.ttf) *"EXEPixelPerfect"* by [@Roberto Martínez](https://www.dafont.com/roberto-martinez.d7913)
nycex's avatar
nycex committed
52 53 54

## License
MIT
55 56 57

## Known issues

nycex's avatar
nycex committed
58
### Not running smoothly in firefox
59
- Try disabling the `privacy.resistFingerprinting` setting enabled in about:config