Merge pull request #46 from CleanCut/more-improvements

More improvements

Author: CleanCut

CHANGELOG.md

@@ -1,6 +1,16 @@
 <!-- next-header -->
 ## [Unreleased] - ReleaseDate
 
+### Improved
+
+- Dropped the lazy_static, log, and env_logger dependencies.
+
+### BREAKING CHANGES
+
+Yes, I know I shouldn't be releasing breaking changes in a patch release...but no one should be using any 5.x versions until I start teaching classes with it publicly...so I'm going to break it until I start teaching with 5.x.
+
+- Updated font loading to be rooted in `assets/` instead of `assets/font/`
+
 ## [5.0.4] - 2022-05-09
 
 ### Improved
@@ -10,8 +20,6 @@
 
 ### BREAKING CHANGES
 
-Yes, I know I shouldn't be releasing breaking changes in a patch release...but no one should be using any 5.x versions until I start teaching classes with it publicly...so I'm going to break it until I start teaching with 5.x.
-
 - Renamed the music file extensions to `.ogg` since [bevy doesn't support that file extension yet](https://github.com/bevyengine/bevy/pull/4703) -- this means the asset pack is now different.
 
 ## [5.0.3] - 2022-04-29

Cargo.toml

@@ -34,13 +34,10 @@ bevy = { version = "0.7.0", default-features = false, features = [
     "vorbis",
 ] }
 bevy_prototype_lyon = "0.5"
-lazy_static = "1.4"
-log = "0.4"
 ron = "0.7"
 serde = { version = "1.0", features = [ "derive" ] }
 
 [dev-dependencies]
-env_logger = "0.9"
 rand = "0.8"
 
 [[example]]

examples/music.rs

@@ -20,7 +20,7 @@ fn main() {
         "engine.audio_manager.play_music(MusicPreset::Classy8Bit, 1.0);",
     );
     msg2.translation.y = -50.0;
-    msg2.font = "FiraMono-Medium.ttf".to_string();
+    msg2.font = "font/FiraMono-Medium.ttf".to_string();
 
     game.audio_manager.play_music(MusicPreset::Classy8Bit, 1.0);
 

examples/sfx.rs

@@ -20,7 +20,7 @@ fn main() {
         "engine.audio_manager.play_sfx(SfxPreset::Jingle1, 1.0);",
     );
     msg2.translation.y = -50.0;
-    msg2.font = "FiraMono-Medium.ttf".to_string();
+    msg2.font = "font/FiraMono-Medium.ttf".to_string();
 
     game.audio_manager.play_sfx(SfxPreset::Jingle1, 1.0);
 

examples/sound.rs

@@ -20,7 +20,7 @@ fn main() {
         "engine.audio_manager.play_sfx(\"sfx/congratulations.ogg\", 1.0);",
     );
     msg2.translation.y = -100.0;
-    msg2.font = "FiraMono-Medium.ttf".to_string();
+    msg2.font = "font/FiraMono-Medium.ttf".to_string();
 
     game.audio_manager.play_sfx("sfx/congratulations.ogg", 1.0);
 

examples/text.rs

@@ -12,7 +12,7 @@ fn main() {
     let mut game = Game::new();
     let fps = game.add_text("fps", "FPS: ");
     fps.translation = Vec2::new(0.0, 250.0);
-    fps.font = "FiraMono-Medium.ttf".to_string();
+    fps.font = "font/FiraMono-Medium.ttf".to_string();
     fps.font_size = 60.0;
 
     let zoom_msg = game.add_text(
@@ -24,10 +24,10 @@ fn main() {
 
     let font_msg = game.add_text(
         "font_msg",
-        "You can choose a font at creation time by providing the filename of a font stored in assets/font.\n\"FiraSans-Bold.ttf\" is the default. \"FiraMono-Medium.ttf\" is also included in the asset pack."
+        "You can choose a font at creation time by providing the filename of a font stored in assets/.\n\"font/FiraSans-Bold.ttf\" is the default. \"font/FiraMono-Medium.ttf\" is also included in the asset pack."
     );
     font_msg.font_size = 20.0;
-    font_msg.font = "FiraMono-Medium.ttf".to_string();
+    font_msg.font = "font/FiraMono-Medium.ttf".to_string();
     font_msg.translation.y = 0.0;
 
     let msg = game.add_text("msg", "Changing the text's translation, rotation, and scale is fast,\n so feel free to do that a lot.");

src/game.rs

@@ -203,7 +203,7 @@ pub fn add_texts(commands: &mut Commands, asset_server: &Res<AssetServer>, engin
         let transform = text.bevy_transform();
         let font_size = text.font_size;
         let text_string = text.value.clone();
-        let font_path = format!("font/{}", text.font);
+        let font_path = text.font.clone();
         commands.spawn().insert(text).insert_bundle(Text2dBundle {
             text: BevyText::with_section(
                 text_string,
@@ -285,7 +285,6 @@ impl<S: Send + Sync + 'static> Game<S> {
     /// more information.
     pub fn window_settings(&mut self, window_descriptor: WindowDescriptor) -> &mut Self {
         self.window_descriptor = window_descriptor;
-        log::debug!("window descriptor is: {:?}", self.window_descriptor);
         self
     }
 
@@ -472,8 +471,7 @@ fn game_logic_sync<S: Send + Sync + 'static>(
             if text.font_size != bevy_text_component.sections[0].style.font_size {
                 bevy_text_component.sections[0].style.font_size = text.font_size;
             }
-            let font_path = format!("font/{}", text.font);
-            let font = asset_server.load(font_path.as_str());
+            let font = asset_server.load(text.font.as_str());
             if bevy_text_component.sections[0].style.font != font {
                 bevy_text_component.sections[0].style.font = font;
             }

src/text.rs

@@ -16,7 +16,7 @@ pub struct Text {
     /// SYNCED: The actual text value you want to display.
     pub value: String,
     /// CREATION: The font to use when creating this text. Should be a file name of an .otf or
-    /// .ttf font located within the assets/font folder. Defaults to "FiraSans-Bold.ttf" (included
+    /// .ttf font located within the assets/font folder. Defaults to "font/FiraSans-Bold.ttf" (included
     /// in the default asset pack).
     pub font: String,
     /// SYNCED: The font size of the text you want to display. WARNING: As font sizes get larger,
@@ -43,7 +43,7 @@ impl Default for Text {
         Self {
             label: String::default(),
             value: String::default(),
-            font: "FiraSans-Bold.ttf".to_string(),
+            font: "font/FiraSans-Bold.ttf".to_string(),
             font_size: TEXT_DEFAULT_FONT_SIZE,
             translation: Vec2::default(),
             layer: TEXT_DEFAULT_LAYER,

tutorial/src/160-text-attributes.md

@@ -20,19 +20,19 @@ If you change the font, then the `Text` will be re-rendered as a new image at th
 
 The asset pack contains two fonts:
 
-- `FiraMono-Medium.ttf`
-- `FiraSans-Bold.ttf` (the default font if none is specified)
+- `font/FiraMono-Medium.ttf`
+- `font/FiraSans-Bold.ttf` (the default font if none is specified)
 
 
 ```rust,ignored
 let mono = engine.add_text("mono", "This text is using a monospace font");
-mono.font = "FiraMono-Medium.ttf".to_string();
+mono.font = "font/FiraMono-Medium.ttf".to_string();
 ```
 
-To use a custom font, place a valid `otf` or `ttf` file in `assets/font` and set it on your `Text`.
+To use a custom font, place a valid `otf` or `ttf` file in `assets/` and set it on your `Text`.
 
 ```rust,ignored
-// After placing `party.otf` in the `assets/font/` directory...
+// After placing `party.otf` in the `assets/` directory...
 let party = engine.add_text("party", "Let's Party!");
 mono.font = "party.otf".to_string();
 ```

tutorial/src/205-music.md

@@ -4,16 +4,16 @@ One music file may be played at a time.  Music always loops repeatedly until exp
 
 ### Play
 
-The `play_music` method starts playing looping music. The first parameter should be a `MusicPreset` enum variant or a music file path relative to `assets/audio`. All music from the asset pack have variants present in the `MusicPreset` enum for convenience.
+The `play_music` method starts playing looping music. The first parameter should be a `MusicPreset` enum variant or a music file path relative to `assets/`. All music from the asset pack have variants present in the `MusicPreset` enum for convenience.
 
 The second parameter is the volume, which should be a value between `0.0` (silent) and `1.0` full volume.
 
 ```rust,ignored
 // using a preset
 game.audio_manager.play_music(MusicPreset::Classy8Bit, 1.0);
 
-// using a filepath relative to `assets/audio`
-game.audio_manager.play_music("music/Classy 8-Bit.ogg", 1.0);
+// using a filepath relative to `assets/`
+game.audio_manager.play_music("audio/music/Classy 8-Bit.ogg", 1.0);
 ```
 
 Any music already playing will be stopped to play a new music selection.