resolve conflict

Author: CleanCut

.github/workflows/ci.yml

@@ -20,44 +20,18 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        toolchain: [stable, beta, nightly]
+        toolchain: [stable]
         include:
           - os: macos-latest
             MACOS: true
-            sccache-path: /Users/runner/Library/Caches/Mozilla.sccache
-            sccache-download-target: apple-darwin
-            # This can be moved to the "env:" section below once sccache is also working on Windows
-            rustc_wrapper: sccache
           - os: windows-latest
           - os: ubuntu-latest
-            sccache-path: /home/runner/.cache/sccache
-            sccache-download-target: unknown-linux-musl
-            # This can be moved to the "env:" section below once sccache is also working on Windows
-            rustc_wrapper: sccache
     env:
       RUST_BACKTRACE: full
-      #RUSTC_WRAPPER: sccache  # Can't hard-code this until we've got Windows working, too
-      RUSTC_WRAPPER: ${{ matrix.rustc_wrapper }}
       RUSTV: ${{ matrix.toolchain }}
-      SCCACHE_CACHE_SIZE: 2G
-      SCCACHE_DIR: ${{ matrix.sccache-path }}
-      SCCACHE_TARGET: ${{ matrix.sccache-download-target }}
-      URL_BASE: https://github.com/mozilla/sccache/releases/download
-      SCCACHE_VERSION: v0.2.15
-      # SCCACHE_RECACHE: 1 # Uncomment this to clear cache, then comment it back out
     steps:
       - uses: actions/checkout@v2
 
-      - name: Install sccache
-        run: |
-          SCCACHE_FILE=sccache-$SCCACHE_VERSION-x86_64-$SCCACHE_TARGET
-          mkdir -p $HOME/.local/bin
-          curl -L "$URL_BASE/$SCCACHE_VERSION/$SCCACHE_FILE.tar.gz" | tar xz
-          mv -f $SCCACHE_FILE/sccache $HOME/.local/bin/sccache
-          chmod +x $HOME/.local/bin/sccache
-          echo "$HOME/.local/bin" >> $GITHUB_PATH
-        if: matrix.os != 'windows-latest'
-
       - name: Install Linux deps alsa and udev
         run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev
         if: runner.os == 'linux'
@@ -72,31 +46,32 @@ jobs:
           override: true
 
       - name: Fetch cargo registry cache
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         continue-on-error: false
         with:
           path: |
-            ~/.cargo/registry
-            ~/.cargo/git
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
             Cargo.lock
-          key: ${{ runner.os }}-cargo-${{ matrix.toolchain }}-${{ hashFiles('**/Cargo.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-cargo-${{ matrix.toolchain }}-
-        if: matrix.os != 'windows-latest'
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+        if: runner.os != 'windows'
 
-      - name: Fetch sccache cache
-        uses: actions/cache@v2
+      - name: Fetch cargo registry cache (windows)
+        uses: actions/cache@v3
         continue-on-error: false
         with:
-          path: ${{ matrix.sccache-path }}
-          key: ${{ runner.os }}-sccache-${{ matrix.toolchain }}-${{ hashFiles('**/Cargo.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-sccache-${{ matrix.toolchain }}-
-        if: matrix.os != 'windows-latest'
-
-      - name: Start sccache server
-        run: sccache --start-server
-        if: matrix.os != 'windows-latest'
+          path: |
+            C:\Rust\.cargo\bin
+            C:\Rust\.cargo\registry\index
+            C:\Rust\.cargo\registry\cache
+            C:\Rust\.cargo\git\db
+            target
+            Cargo.lock
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+        if: runner.os == 'windows'
 
       - name: rustfmt & clippy
         run: |
@@ -108,7 +83,3 @@ jobs:
       - run: cargo test --workspace --all-targets --all-features
         env:
           MACOS: ${{ matrix.MACOS }} # Used by some tests
-
-      - name: Stop sccache server
-        run: sccache --stop-server || true
-        if: matrix.os != 'windows-latest'

CHANGELOG.md

@@ -1,10 +1,26 @@
 <!-- next-header -->
 ## [Unreleased] - ReleaseDate
 
+## Improved
+
+- Updated to `bevy 0.8` and `bevy_prototype_lyon 0.6` under the hood, which resolves the occasional stuttering problem.
+
+
+## [5.1.0] - 2022-06-18
+
+### Improved
+
+- Fixed `CollisionPair::either_contains` to use `.contains` instead of `==`, contributed by [@etnt](https://github.com/etnt) in [#51](https://github.com/CleanCut/rusty_engine/pull/51)
+- Added `CollisionPair::either_equals_to` which uses `==`, contributed by [@etnt](https://github.com/etnt) in [#51](https://github.com/CleanCut/rusty_engine/pull/51)
+- Fixed documentation for a few fields of the `Engine` struct which were in the wrong place.
+- Improved CI caching. Builds should now generally complete in under 3 minutes.
+
+## [5.0.6] - 2022-05-19
+
 ### Improved
 
 - Made a pass through the API documentation and Tutorials, clarifying, correcting, and filling in blanks.
-- Updated to `bevy 0.8` and `bevy_prototype_lyon 0.6` under the hood, which resolves the occasional stuttering problem.
+- Reduced the debug level of logging the window dimension resizing from info to debug
 
 ## [5.0.5] - 2022-05-10
 
@@ -256,7 +272,9 @@ specifying a path to a sound file relative to `assets/audio`.
 
 [Bevy]: https://bevyengine.org
 <!-- next-url -->
-[Unreleased]: https://github.com/CleanCut/rusty_engine/compare/v5.0.5...HEAD
+[Unreleased]: https://github.com/CleanCut/rusty_engine/compare/v5.1.0...HEAD
+[5.1.0]: https://github.com/CleanCut/rusty_engine/compare/v5.0.6...v5.1.0
+[5.0.6]: https://github.com/CleanCut/rusty_engine/compare/v5.0.5...v5.0.6
 [5.0.5]: https://github.com/CleanCut/rusty_engine/compare/v5.0.4...v5.0.5
 [5.0.4]: https://github.com/CleanCut/rusty_engine/compare/v5.0.3...v5.0.4
 [5.0.3]: https://github.com/CleanCut/rusty_engine/compare/v5.0.2...v5.0.3

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rusty_engine"
-version = "5.0.5"
+version = "5.1.0"
 description = "Learn Rust with a simple, cross-platform, 2D game engine."
 edition = "2021"
 homepage = "https://github.com/CleanCut/rusty_engine"

README.md

@@ -58,7 +58,7 @@ Add `rusty_engine` as a dependency
 
 ```toml
 # In your [dependencies] section of Cargo.toml
-rusty_engine = "5.0.5"
+rusty_engine = "5.1.0"
 ```
 
 Write your game!
@@ -112,6 +112,13 @@ Run your game with `cargo run --release`!
 
 See also the [tutorial](https://cleancut.github.io/rusty_engine/), [game scenarios](https://github.com/CleanCut/rusty_engine/tree/main/scenarios), [code examples](https://github.com/CleanCut/rusty_engine/tree/main/examples) and the [API documentation](https://docs.rs/rusty_engine/latest/rusty_engine/)
 
+## Student Showcase
+
+Show off the project you made with Rusty Engine! Learning Rust can be fun. 😄 Just [send me a link](https://agileperception.com/contact) and I'll add it to the list!
+
+- [Rusty Asteroids](https://github.com/etnt/rusty-asteroids) by [@etnt](https://github.com/etnt)
+- [Rusty Breakout](https://github.com/etnt/rusty-breakout) by [@etnt](https://github.com/etnt)
+
 ## Contribution
 
 All software contributions are assumed to be dual-licensed under MIT/Apache-2.  All asset contributions must be under licenses compatible with the software license, and explain their license(s) in a `README.md` file in the same directory as the source files.

examples/scenarios/car_shoot.rs

@@ -4,53 +4,46 @@
 
 use rand::prelude::*;
 use rusty_engine::prelude::*;
-use SpritePreset::*; // The SpritePreset enum was imported from rusty_engine::prelude
 
-#[derive(Default)]
 struct GameState {
-    marbles_left: Vec<String>,
+    marble_labels: Vec<String>,
     cars_left: i32,
     spawn_timer: Timer,
 }
 
 fn main() {
     let mut game = Game::new();
 
-    // Set the title of the window to be Car Shooter
+    // Initial game state
+    let game_state = GameState {
+        marble_labels: vec!["marble1".into(), "marble2".into(), "marble3".into()],
+        cars_left: 25,
+        spawn_timer: Timer::from_seconds(0.0, false),
+    };
+
+    // Set the title of the window
     game.window_settings(WindowDescriptor {
         title: "Car Shoot".into(),
         ..Default::default()
     });
 
-    // Create the player
-    let player = game.add_sprite("player", RacingBarrierRed);
+    // Start the music
+    game.audio_manager.play_music(MusicPreset::Classy8Bit, 0.1);
+
+    //
+    let player = game.add_sprite("player", SpritePreset::RacingBarrierRed);
     player.rotation = UP;
     player.scale = 0.5;
     player.translation.y = -325.0;
     player.layer = 10.0;
 
-    // Start the music
-    game.audio_manager.play_music(MusicPreset::Classy8Bit, 0.1);
-
-    let mut game_state = GameState::default();
-
-    // Marbles left. We'll use these strings as labels for sprites. If they are present in the
-    // vector, then they are available to be shot out of the marble gun. If they are not present,
-    // then they are currently in play.
-    game_state.marbles_left = vec!["marble1".into(), "marble2".into(), "marble3".into()];
-
-    // Cars left in level - each integer represents a car that will be spawned
-    game_state.cars_left = 25;
-    let cars_left = game.add_text("cars left", "Cars left: 25");
+    let cars_left = game.add_text("cars left", format!("Cars left: {}", game_state.cars_left));
     cars_left.translation = Vec2::new(540.0, -320.0);
 
     game.add_logic(game_logic);
     game.run(game_state);
 }
 
-const MARBLE_SPEED: f32 = 600.0;
-const CAR_SPEED: f32 = 300.0;
-
 fn game_logic(engine: &mut Engine, game_state: &mut GameState) {
     // Handle marble gun movement
     let player = engine.sprites.get_mut("player").unwrap();
@@ -61,96 +54,90 @@ fn game_logic(engine: &mut Engine, game_state: &mut GameState) {
 
     // Shoot marbles!
     if engine.mouse_state.just_pressed(MouseButton::Left) {
-        // Create the marble
-        if let Some(label) = game_state.marbles_left.pop() {
-            let marble = engine.add_sprite(label, RollingBallBlue);
-            marble.translation.y = -275.0;
+        if let Some(label) = game_state.marble_labels.pop() {
+            let marble = engine.add_sprite(label, SpritePreset::RollingBallBlue);
             marble.translation.x = player_x;
+            marble.translation.y = -275.0;
             marble.layer = 5.0;
             marble.collision = true;
-            engine.audio_manager.play_sfx(SfxPreset::Impact2, 0.7);
+            engine.audio_manager.play_sfx(SfxPreset::Impact2, 0.4);
         }
     }
 
     // Move marbles
-    for marble in engine
+    const MARBLE_SPEED: f32 = 600.0;
+    engine
         .sprites
         .values_mut()
-        .filter(|marble| marble.label.starts_with("marble"))
-    {
-        marble.translation.y += MARBLE_SPEED * engine.delta_f32;
-    }
+        .filter(|sprite| sprite.label.starts_with("marble"))
+        .for_each(|marble| marble.translation.y += MARBLE_SPEED * engine.delta_f32);
 
     // Move cars across the screen
-    for car in engine
+    const CAR_SPEED: f32 = 250.0;
+    engine
         .sprites
         .values_mut()
-        .filter(|car| car.label.starts_with("car"))
-    {
-        car.translation.x += CAR_SPEED * engine.delta_f32;
-    }
+        .filter(|sprite| sprite.label.starts_with("car"))
+        .for_each(|car| car.translation.x += CAR_SPEED * engine.delta_f32);
 
     // Clean up sprites that have gone off the screen
-    let mut labels_to_delete = vec![];
-    for sprite in engine.sprites.values() {
+    let mut labels_to_delete = Vec::new();
+    for (label, sprite) in engine.sprites.iter() {
         if sprite.translation.y > 400.0 || sprite.translation.x > 750.0 {
-            labels_to_delete.push(sprite.label.clone());
+            labels_to_delete.push(label.clone());
         }
     }
     for label in labels_to_delete {
         engine.sprites.remove(&label);
         if label.starts_with("marble") {
-            game_state.marbles_left.push(label);
+            game_state.marble_labels.push(label);
         }
     }
 
     // Spawn cars
     if game_state.spawn_timer.tick(engine.delta).just_finished() {
         // Reset the timer to a new value
         game_state.spawn_timer = Timer::from_seconds(thread_rng().gen_range(0.1..1.25), false);
-        // Get the next car
+        // Get the new car
         if game_state.cars_left > 0 {
             game_state.cars_left -= 1;
+            let text = engine.texts.get_mut("cars left").unwrap();
+            text.value = format!("Cars left: {}", game_state.cars_left);
             let label = format!("car{}", game_state.cars_left);
-            let cars_left_text = engine.texts.get_mut("cars left").unwrap();
-            cars_left_text.value = format!("Cars left: {}", game_state.cars_left);
+            use SpritePreset::*;
             let car_choices = vec![
                 RacingCarBlack,
                 RacingCarBlue,
                 RacingCarGreen,
                 RacingCarRed,
                 RacingCarYellow,
             ];
-            let car = engine.add_sprite(
-                label,
-                car_choices
-                    .iter()
-                    .choose(&mut thread_rng())
-                    .unwrap()
-                    .clone(),
-            );
+            let sprite_preset = car_choices
+                .iter()
+                .choose(&mut thread_rng())
+                .unwrap()
+                .clone();
+            let car = engine.add_sprite(label, sprite_preset);
             car.translation.x = -740.0;
             car.translation.y = thread_rng().gen_range(-100.0..325.0);
             car.collision = true;
         }
     }
 
-    // Collide with things
+    // Handle collisions
     for event in engine.collision_events.drain(..) {
         if event.state.is_end() {
             continue;
         }
         if !event.pair.one_starts_with("marble") {
             continue;
         }
-        engine.sprites.remove(&event.pair.0);
-        engine.sprites.remove(&event.pair.1);
-        if event.pair.0.starts_with("marble") {
-            game_state.marbles_left.push(event.pair.0);
-        }
-        if event.pair.1.starts_with("marble") {
-            game_state.marbles_left.push(event.pair.1);
+        for label in [event.pair.0, event.pair.1] {
+            engine.sprites.remove(&label);
+            if label.starts_with("marble") {
+                game_state.marble_labels.push(label);
+            }
+            engine.audio_manager.play_sfx(SfxPreset::Confirmation1, 0.2);
         }
-        engine.audio_manager.play_sfx(SfxPreset::Confirmation1, 0.5);
     }
 }