diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 2f189eb..fdba2f5 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -17,7 +17,7 @@ on: # Configure the release workflow by editing these values. env: # The base filename of the binary produced by `cargo build`. - cargo_build_binary_name: bevy_quickstart + cargo_build_binary_name: bevy_new_2d # The path to the assets directory. assets_path: assets @@ -27,7 +27,7 @@ env: # The itch.io project to upload to in the format `user-name/project-name`. # There will be no upload to itch.io if this is commented out. - upload_to_itch: the-bevy-flock/bevy-quickstart + upload_to_itch: the-bevy-flock/bevy-new-2d ############ # ADVANCED # @@ -36,27 +36,27 @@ env: # The ID of the app produced by this workflow. # Applies to macOS releases. # Must contain only A-Z, a-z, 0-9, hyphen, and period: https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleidentifier - app_id: the-bevy-flock.bevy-quickstart + app_id: the-bevy-flock.bevy-new-2d # The base filename of the binary in the package produced by this workflow. # Applies to Windows, macOS, and Linux releases. # Defaults to `cargo_build_binary_name` if commented out. - #app_binary_name: bevy_quickstart + #app_binary_name: bevy_new_2d # The name of the `.zip` or `.dmg` file produced by this workflow. # Defaults to `app_binary_name` if commented out. - app_package_name: bevy-quickstart + app_package_name: bevy-new-2d # The display name of the app produced by this workflow. # Applies to macOS releases. # Defaults to `app_package_name` if commented out. - app_display_name: Bevy Quickstart + app_display_name: Bevy New 2D # The short display name of the app produced by this workflow. # Applies to macOS releases. # Must be 15 or fewer characters: https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundlename # Defaults to `app_display_name` if commented out. - #app_short_name: Bevy Quickstart + #app_short_name: Bevy New 2D # Before enabling LFS, please take a look at GitHub's documentation for costs and quota limits: # https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage diff --git a/Cargo.lock b/Cargo.lock index 1cc59c6..587c1fe 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -791,6 +791,16 @@ dependencies = [ "glam", ] +[[package]] +name = "bevy_new_2d" +version = "0.1.0" +dependencies = [ + "bevy", + "log", + "rand", + "tracing", +] + [[package]] name = "bevy_pbr" version = "0.14.1" @@ -824,16 +834,6 @@ version = "0.14.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7ed72afbb6249a6803a3ed7bd2f68ff080d9392f550475e050b34c1e1c1e3e8f" -[[package]] -name = "bevy_quickstart" -version = "0.1.0" -dependencies = [ - "bevy", - "log", - "rand", - "tracing", -] - [[package]] name = "bevy_reflect" version = "0.14.1" diff --git a/Cargo.toml b/Cargo.toml index 513e508..91ef6b0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "bevy_quickstart" +name = "bevy_new_2d" version = "0.1.0" edition = "2021" license = "MIT OR Apache-2.0 OR CC0-1.0" diff --git a/README.md b/README.md index d26d03a..caef22d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,12 @@ -_Brought to you by the Bevy Jam working group._ +# Bevy New 2D -# Bevy Quickstart - -This template is a great way to get started on a new [Bevy](https://bevyengine.org/) game—especially for a game jam! +This template is a great way to get started on a new 2D [Bevy](https://bevyengine.org/) game! Start with a [basic project structure](#write-your-game) and [CI / CD](#release-your-game) that can deploy to [itch.io](https://itch.io). -You can [try this template in your web browser!](https://the-bevy-flock.itch.io/bevy-quickstart) +You can [try this template in your web browser!](https://the-bevy-flock.itch.io/bevy-new-2d) [@ChristopherBiscardi](https://github.com/ChristopherBiscardi) made a video on how to use this template from start to finish: -[A video tutorial for bevy_quickstart](https://www.youtube.com/watch?v=ESBRyXClaYc) +[A video tutorial for bevy_new_2d, formerly known as bevy_quickstart](https://www.youtube.com/watch?v=ESBRyXClaYc) ## Prerequisites @@ -22,7 +20,7 @@ See our [Design Document](./docs/design.md) for more information on how we struc Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate) and run the following command: ```sh -cargo generate TheBevyFlock/bevy_quickstart +cargo generate thebevyflock/bevy_new_2d ``` Then [create a GitHub repository](https://github.com/new) and push your local repository to it. diff --git a/docs/workflows.md b/docs/workflows.md index 430a1cc..3635019 100644 --- a/docs/workflows.md +++ b/docs/workflows.md @@ -48,7 +48,7 @@ The release workflow can be configured by tweaking the environment variables in ```yaml # The base filename of the binary produced by `cargo build`. - cargo_build_binary_name: bevy_quickstart + cargo_build_binary_name: bevy_new_2d # The path to the assets directory. assets_path: assets @@ -58,7 +58,7 @@ The release workflow can be configured by tweaking the environment variables in # The itch.io project to upload to in the format `user-name/project-name`. # There will be no upload to itch.io if this is commented out. - upload_to_itch: the-bevy-flock/bevy-quickstart + upload_to_itch: the-bevy-flock/bevy-new-2d ############ # ADVANCED # @@ -67,27 +67,27 @@ The release workflow can be configured by tweaking the environment variables in # The ID of the app produced by this workflow. # Applies to macOS releases. # Must contain only A-Z, a-z, 0-9, hyphens, and periods: https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleidentifier - app_id: the-bevy-flock.bevy-quickstart + app_id: the-bevy-flock.bevy-new-2d # The base filename of the binary in the package produced by this workflow. # Applies to Windows, macOS, and Linux releases. # Defaults to `cargo_build_binary_name` if commented out. - app_binary_name: bevy_quickstart + app_binary_name: bevy_new_2d # The name of the `.zip` or `.dmg` file produced by this workflow. # Defaults to `app_binary_name` if commented out. - app_package_name: bevy_quickstart + app_package_name: bevy_new_2d # The display name of the app produced by this workflow. # Applies to macOS releases. # Defaults to `app_package_name` if commented out. - app_display_name: Bevy Quickstart + app_display_name: Bevy New 2D # The short display name of the app produced by this workflow. # Applies to macOS releases. # Must be 15 or fewer characters: https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundlename # Defaults to `app_display_name` if commented out. - app_short_name: Bevy Quickstart + app_short_name: Bevy New 2D # Before enabling LFS, please take a look at GitHub's documentation for costs and quota limits: # https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage diff --git a/src/audio.rs b/src/audio.rs index 04b170b..b17de01 100644 --- a/src/audio.rs +++ b/src/audio.rs @@ -7,7 +7,7 @@ use bevy::prelude::*; /// /// ``` /// use bevy::prelude::*; -/// use bevy_quickstart::audio::Music; +/// use bevy_new_2d::audio::Music; /// /// fn set_music_volume(sink_query: Query<&AudioSink, With>) { /// for sink in &sink_query { @@ -25,7 +25,7 @@ pub struct Music; /// /// ``` /// use bevy::prelude::*; -/// use bevy_quickstart::audio::SoundEffect; +/// use bevy_new_2d::audio::SoundEffect; /// /// fn set_sound_effect_volume(sink_query: Query<&AudioSink, With>) { /// for sink in &sink_query { diff --git a/src/lib.rs b/src/lib.rs index 05c1b78..7014c3c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -37,7 +37,7 @@ impl Plugin for AppPlugin { }) .set(WindowPlugin { primary_window: Window { - title: "Bevy Quickstart".to_string(), + title: "Bevy New 2D".to_string(), canvas: Some("#bevy".to_string()), fit_canvas_to_parent: true, prevent_default_event_handling: true, diff --git a/src/main.rs b/src/main.rs index a3e98d4..e2789f8 100644 --- a/src/main.rs +++ b/src/main.rs @@ -2,7 +2,7 @@ #![cfg_attr(not(feature = "dev"), windows_subsystem = "windows")] use bevy::prelude::*; -use bevy_quickstart::AppPlugin; +use bevy_new_2d::AppPlugin; fn main() -> AppExit { App::new().add_plugins(AppPlugin).run() diff --git a/web/index.html b/web/index.html index cc4593e..ee9e7f4 100644 --- a/web/index.html +++ b/web/index.html @@ -3,7 +3,7 @@ - Bevy Quickstart + Bevy New 2D