Merge pull request #43 from CleanCut/fixes

Fix sprite preset paths, make level_creator work when installed

Author: CleanCut

.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
   tests:
     name: Tests
     runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.toolchain == 'nightly' }}
+    continue-on-error: ${{ matrix.toolchain == 'nightly' || matrix.toolchain == 'beta' }}
     strategy:
       fail-fast: false
       matrix:

CHANGELOG.md

@@ -1,6 +1,14 @@
 <!-- next-header -->
 ## [Unreleased] - ReleaseDate
 
+### New
+
+- The `level_creator` example can be installed globally with `cargo install rusty_engine --example level_creator` and run in the root of your own project with `level_creator`.
+
+### Fixed
+
+- Fixed sprite preset paths which broke due to the changes in 5.0.2
+
 ## [5.0.2] - 2022-04-29
 
 ### New

examples/collider.rs

@@ -1,8 +1,16 @@
-//! To run this code, clone the rusty_engine repository and run the command:
+//! To run this code in your own project, first install it:
 //!
-//!     cargo run --release --example collider path/to/some_image.png
+//!     cargo install rusty_engine --example collider
 //!
-//!  ...where that image is somewhere under assets/
+//! Then run it in your own project (with the asset pack present) with an image
+//! placed somewhere in your `assets/` directory.
+//!
+//!     collider assets/some_image.png
+//!
+//! Of course, you could also clone the rusty_engine repository, place your image
+//! in `assets/` somewhere, and run:
+//!
+//! cargo run --release --example collider assets/some_image.png
 
 use std::path::PathBuf;
 

examples/level_creator.rs

@@ -1,4 +1,12 @@
-//! To run this code, clone the rusty_engine repository and run the command:
+//! To run this code in your own project, first install it:
+//!
+//!     cargo install rusty_engine --example level_creator
+//!
+//! Then run it in your own project (with the asset pack present).
+//!
+//!     level_creator
+//!
+//! Alterantely, clone the rusty_engine repository and run the command:
 //!
 //!     cargo run --release --example level_creator
 
@@ -27,6 +35,17 @@ impl Default for GameState {
 const MAX_LAYER: f32 = 900.0;
 
 fn main() {
+    // Some trickiness to make assets load relative to the current working directory, which
+    // makes using it from `cargo install rusty_engine --example collider` possible.
+    // This takes advantage of bevy's hard-coded asset loading behavior, and may break in future
+    // bevy versions.
+    std::env::set_var(
+        "CARGO_MANIFEST_DIR",
+        std::env::var("PWD").unwrap_or_default(),
+    );
+    // Make engine logging a bit quieter since we've got console instructions we want folks to see.
+    std::env::set_var("RUST_LOG", "error");
+
     let mut game = Game::new();
 
     println!(

scenarios/extreme_drivers_ed.md

@@ -12,14 +12,16 @@ Navigate a driving course full of obstacles. Carefully avoid the obstacles while
 
 ## Level Setup
 
-It can be _really_ tedious to set up dozens of obstacles via code and guessing coordinates. Instead, clone the `rusty_engine` repository and use the `level_creator` example to place several dozen obstacles and emit the level code for you to copy-and-paste into your own project.
+It can be _really_ tedious to set up dozens of obstacles via code and guessing coordinates. Instead, use `rusty_engine`'s `level_creator` example to place several dozen obstacles and emit the level code for you to copy-and-paste into your own project.
 
 The sprite preset `SpritePreset::RollingHoleStart` are the goals for collecting (you _want_ to run into them). All other sprites will be obstacles.
 
 ```
-git clone https://github.com/CleanCut/rusty_engine.git
-cd rusty_engine
-cargo run --release --example level_creator
+# You only need to install the level creator once
+cargo install rusty_engine --example level_creator
+
+# Then use it to create a level
+level_creator
 ```
 
 ## Engine Initialization

src/sprite.rs

@@ -217,26 +217,26 @@ impl SpritePreset {
     /// `impl From<SpritePreset> for PathBuf` implementation.
     pub fn filepath(&self) -> PathBuf {
         match self {
-            SpritePreset::RacingBarrelBlue => "racing/barrel_blue.png",
-            SpritePreset::RacingBarrelRed => "racing/barrel_red.png",
-            SpritePreset::RacingBarrierRed => "racing/barrier_red.png",
-            SpritePreset::RacingBarrierWhite => "racing/barrier_white.png",
-            SpritePreset::RacingCarBlack => "racing/car_black.png",
-            SpritePreset::RacingCarBlue => "racing/car_blue.png",
-            SpritePreset::RacingCarGreen => "racing/car_green.png",
-            SpritePreset::RacingCarRed => "racing/car_red.png",
-            SpritePreset::RacingCarYellow => "racing/car_yellow.png",
-            SpritePreset::RacingConeStraight => "racing/cone_straight.png",
-            SpritePreset::RollingBallBlue => "rolling/ball_blue.png",
-            SpritePreset::RollingBallBlueAlt => "rolling/ball_blue_alt.png",
-            SpritePreset::RollingBallRed => "rolling/ball_red.png",
-            SpritePreset::RollingBallRedAlt => "rolling/ball_red_alt.png",
-            SpritePreset::RollingBlockCorner => "rolling/block_corner.png",
-            SpritePreset::RollingBlockNarrow => "rolling/block_narrow.png",
-            SpritePreset::RollingBlockSmall => "rolling/block_small.png",
-            SpritePreset::RollingBlockSquare => "rolling/block_square.png",
-            SpritePreset::RollingHoleEnd => "rolling/hole_end.png",
-            SpritePreset::RollingHoleStart => "rolling/hole_start.png",
+            SpritePreset::RacingBarrelBlue => "sprite/racing/barrel_blue.png",
+            SpritePreset::RacingBarrelRed => "sprite/racing/barrel_red.png",
+            SpritePreset::RacingBarrierRed => "sprite/racing/barrier_red.png",
+            SpritePreset::RacingBarrierWhite => "sprite/racing/barrier_white.png",
+            SpritePreset::RacingCarBlack => "sprite/racing/car_black.png",
+            SpritePreset::RacingCarBlue => "sprite/racing/car_blue.png",
+            SpritePreset::RacingCarGreen => "sprite/racing/car_green.png",
+            SpritePreset::RacingCarRed => "sprite/racing/car_red.png",
+            SpritePreset::RacingCarYellow => "sprite/racing/car_yellow.png",
+            SpritePreset::RacingConeStraight => "sprite/racing/cone_straight.png",
+            SpritePreset::RollingBallBlue => "sprite/rolling/ball_blue.png",
+            SpritePreset::RollingBallBlueAlt => "sprite/rolling/ball_blue_alt.png",
+            SpritePreset::RollingBallRed => "sprite/rolling/ball_red.png",
+            SpritePreset::RollingBallRedAlt => "sprite/rolling/ball_red_alt.png",
+            SpritePreset::RollingBlockCorner => "sprite/rolling/block_corner.png",
+            SpritePreset::RollingBlockNarrow => "sprite/rolling/block_narrow.png",
+            SpritePreset::RollingBlockSmall => "sprite/rolling/block_small.png",
+            SpritePreset::RollingBlockSquare => "sprite/rolling/block_square.png",
+            SpritePreset::RollingHoleEnd => "sprite/rolling/hole_end.png",
+            SpritePreset::RollingHoleStart => "sprite/rolling/hole_start.png",
         }
         .into()
     }

tutorial/src/65-sprite-collider.md

@@ -37,10 +37,14 @@ If you create a new sprite using your own image, and you want it to produce `Col
 Creating colliders from scratch is quite tedius, so there is an "example" program called `collider` that you can use to create a collider! To run `collider`, clone the [`rusty_engine`](https://github.com/CleanCut/rusty_engine/) repository, place your image file in the `assets` directory (let's call it `db.png`), and then run:
 
 ```text
-$ cargo run --release --example collider assets/db.png
+# Install the collider example (you only need to do this once)
+$ cargo install rusty_engine --example collider
+
+# Inside your project, run the collider example
+$ collider assets/db.png
 ```
 
-Then follow the directions to create (or re-create) a collider and write it to a file.
+Then follow the example's console instructions to create (or re-create) a collider and write it to a file.
 
 <img width="1392" alt="Screen Shot 2021-12-26 at 10 45 40 PM" src="https://user-images.githubusercontent.com/5838512/147438683-c8af2db7-66dd-463c-a269-d03f37869496.png">