Skip to content

Commit ffb24a8

Browse files
committed
Documentation update, now with video!
1 parent ac2d961 commit ffb24a8

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

README.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ The intriguing bit about all of this is that AI, body shape and brain are **bred
3232

3333
Eventually I plan to plug in some sort of gameplay and release as a free game. Strictly evening/weekend toy project: don't hold your breath.
3434

35+
### Interaction
36+
37+
You can interact with the simulation by shooting Resources at the minions. **Gamepad** supported!
38+
3539
## Feedback
3640
- feel free to post [issues on GitHub](https://github.com/itadinanta/rust-oids/issues)
3741
- also send me interesting gene pools (F6 to get snapshots, see instructions below)
@@ -40,13 +44,14 @@ Eventually I plan to plug in some sort of gameplay and release as a free game. S
4044

4145
This project started as a test bed for the Rust language and toolchain, [GFX](https://github.com/gfx-rs/gfx) and [box2d wrapper](https://github.com/Bastacyclop/rust_box2d), and could have not existed without those.
4246

43-
## Screenshots
47+
## Videos
48+
49+
Some rust-oids competing for territory and resources, and the player messing up with them!
4450

45-
Some rust-oids competing for territory and resources:
51+
[![Play 1](https://img.youtube.com/vi/wChKsu28st8/0.jpg)](https://www.youtube.com/watch?v=wChKsu28st8 "Click to watch video")
4652

47-
![screenshot](img/screenshot_008.png)
4853

49-
![screenshot](img/screenshot_007.png)
54+
[![Play 2](https://img.youtube.com/vi/2M84AUo_GX0/0.jpg)](https://www.youtube.com/watch?v=2M84AUo_GX0 "Click to watch video")
5055

5156
## Prerequisites/platforms
5257

@@ -61,6 +66,10 @@ For audio:
6166
- libportaudio19-dev
6267
- libasound2-dev
6368

69+
For gamepad:
70+
71+
- libudev-dev
72+
6473
### Windows
6574

6675
Building Windows dependencies is a tedious yak shaving exercise. For convenience, I am redistributing parts of open source projects in the form of headers and prebuilt x64 static libs for Windows 10.
@@ -71,7 +80,7 @@ Links to the source code are provided below as for licences:
7180

7281
## Build/run
7382

74-
- Clone this repo and ```cd`` into its root
83+
- Clone this repo and ```cd``` into its root
7584
- ```cargo run --release [options]``` to run starting with the default gene pool
7685
- ```cargo run --release -- <gene_pool_file.csv> [options]``` to run starting with a snapshotted gene pool (DDDDMMYYY_hhmmss.csv).
7786

@@ -84,32 +93,24 @@ Options:
8493

8594
## How to play
8695

96+
*New!* Gamepad support (tested with DS4, in Windows via [DS4Windows](http://ds4windows.com/))
97+
98+
- Left stick, WASD: move
99+
- Right stick, Q, E: aim
100+
- L2: fire rate
101+
- R2, Spacebar: shoot
102+
- L1, G/R1, H: slow down/fast forward
103+
- L3, F1: toggle HUD
104+
- Left mouse click: aim and shoot
87105
- Middle mouse click: new rustoid from current gene pool.
88106
- Ctrl + Middle mouse click: new random rustoid.
89-
- Left mouse clik: select minion for tracing
90-
- Right mouse click/drag: pan.
107+
- Ctrl + Left mouse clik: select minion for tracing
91108
- Z: deselect minion for tracing
92-
- D: disable tracing of target and trajectories
93109
- F6: snapshot current gene pool into the **resources** folder
94110
- F5: reload shaders
95111
- V,B: set background tone
96112
- K,L: change light intensity
97-
- G,H: slow down/fast forward
98113
- 0, Home: reset camera pan
99-
- Arrows: camera pan
100-
- Spacebar/F1: show HUD
101-
102-
## Status line indicators
103-
104-
Press Spacebar or F1 to show the status line
105-
106-
- F: Simulation Frame #, Display Frame #
107-
- E: Elapsed time since start in seconds
108-
- FT: Simulation quantum, frame time (speed factor)
109-
- SFT: Average frame duration of the last 120 frames (step)
110-
- FPS: Average fps of the last 120 frames
111-
- P: Population size
112-
- X: Extinction index - increased every time the whole population dies off
113114

114115
### Other licences
115116

0 commit comments

Comments
 (0)