pagurus 0.4.0

Ultra-portable game engine suited for offline 2D games powered by WebAssembly
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
64
65
66
67
68
69
70
71
72

pagurus
========

[![pagurus](https://img.shields.io/crates/v/pagurus.svg)](https://crates.io/crates/pagurus)
[![Documentation](https://docs.rs/pagurus/badge.svg)](https://docs.rs/pagurus)
[![Actions Status](https://github.com/sile/pagurus/workflows/CI/badge.svg)](https://github.com/sile/pagurus/actions)
![License](https://img.shields.io/crates/l/pagurus)

🐚+🦞 Ultra-portable Rust game engine suited for offline 2D games powered by WebAssembly.

Examples
--------

### Snake

Traditional snake game: [examples/snake_game](examples/snake_game)

You can play this game on [itch.io](https://reduls.itch.io/snake).

#### How to build and run locally

Build the game:
```console
$ cargo build --release -p snake_game --target wasm32-unknown-unknown
$ ls target/wasm32-unknown-unknown/release/snake_game.wasm
```

Run the game using SDL:
```console
$ cargo run --release -p sdl_runtime -- target/wasm32-unknown-unknown/release/snake_game.wasm

// or

$ cargo run --release -p sdl_snake
```

Run the game on Android:
```console
$ cargo install cargo-apk
$ cargo apk run --lib -p android_snake
```

Run the game on Windows:
```console
$ cargo run --release -p windows_runtime -- target/wasm32-unknown-unknown/release/snake_game.wasm

// or, if you use WSL2 (Ubuntu)

$ sudo apt install gcc-mingw-w64-x86-64
$ rustup target add x86_64-pc-windows-gnu
$ cargo run --target=x86_64-pc-windows-gnu --release -p windows_runtime -- target/wasm32-unknown-unknown/release/snake_game.wasm
```

Run the game on a Web Browser:
```console
$ cd pagurus_web/
$ npm install
$ npm run build
$ npm run example  // A HTTP server listening on 8888 port will start

$ open http://localhost:8888/examples/web_snake/
```

Run the game on a terminal (audio is disabled):
```console
$ cargo run --release -p tui_runtime -- target/wasm32-unknown-unknown/release/snake_game.wasm
```

Projects that use Pagurus
-------------------------

- [sile/pixcil](https://github.com/sile/pixcil): Pixel art editor