Merge pull request #29 from CleanCut/scenario-improvements

Improve Game Scenarios

Author: CleanCut

CHANGELOG.md

@@ -10,6 +10,7 @@
 - Upgraded to Bevy 0.6 in the back end
 - `Text` rotation and scale now works! 🎉
 - TODO: bevy_prototype_debug_lines hasn't had a release, and the `main` branch sorta works, but the lines now appear _under_ sprites instead of over them, which is not ideal. We _must_ have a release upstream and would _love_ a fix upstream. If there isn't an upstream release, we'll need to find another line-drawing solution before release.
+- Updated (or finished) all of the game scenario descriptions.
 
 ## [3.0.0] - 2021-12-30
 

examples/collision.rs

@@ -1,3 +1,7 @@
+//! To run this code, clone the rusty_engine repository and run the command:
+//!
+//!     cargo run --release --example collision
+
 use rusty_engine::prelude::*;
 
 const ROTATION_SPEED: f32 = 3.0;

examples/game_state.rs

@@ -1,3 +1,7 @@
+//! To run this code, clone the rusty_engine repository and run the command:
+//!
+//!     cargo run --release --example game_state
+
 use std::f32::consts::TAU;
 
 use rusty_engine::prelude::*;

examples/keyboard_events.rs

@@ -1,3 +1,7 @@
+//! To run this code, clone the rusty_engine repository and run the command:
+//!
+//!     cargo run --release --example keyboard_events
+
 use rusty_engine::prelude::*;
 
 fn main() {

examples/keyboard_state.rs

@@ -1,3 +1,7 @@
+//! To run this code, clone the rusty_engine repository and run the command:
+//!
+//!     cargo run --release --example keyboard_state
+
 use std::f32::consts::PI;
 
 use rusty_engine::prelude::*;

examples/layer.rs

@@ -1,3 +1,7 @@
+//! To run this code, clone the rusty_engine repository and run the command:
+//!
+//!     cargo run --release --example layer
+
 use rusty_engine::prelude::*;
 
 fn main() {

examples/level_creator.rs

@@ -1,3 +1,7 @@
+//! To run this code, clone the rusty_engine repository and run the command:
+//!
+//!     cargo run --release --example level_creator
+
 use rusty_engine::prelude::*;
 
 struct GameState {

examples/mouse_events.rs

@@ -1,3 +1,7 @@
+//! To run this code, clone the rusty_engine repository and run the command:
+//!
+//!     cargo run --release --example mouse_events
+
 use rusty_engine::prelude::*;
 
 const ORIGIN_LOCATION: (f32, f32) = (0.0, -200.0);

examples/mouse_state.rs

@@ -1,3 +1,7 @@
+//! To run this code, clone the rusty_engine repository and run the command:
+//!
+//!     cargo run --release --example mouse_state
+
 use rusty_engine::prelude::*;
 
 const ORIGIN_LOCATION: (f32, f32) = (0.0, -200.0);

examples/music.rs

@@ -1,3 +1,7 @@
+//! To run this code, clone the rusty_engine repository and run the command:
+//!
+//!     cargo run --release --example music
+
 //! This is an example of playing a music preset. For playing your own music file, please see the
 //! `sound` example.