Skip to content

Commit

Permalink
Rename to bevy_new_2d (#310)
Browse files Browse the repository at this point in the history
  • Loading branch information
benfrankel authored Sep 22, 2024
1 parent 34e9570 commit 83c2b8b
Show file tree
Hide file tree
Showing 9 changed files with 35 additions and 37 deletions.
14 changes: 7 additions & 7 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 #
Expand All @@ -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
Expand Down
20 changes: 10 additions & 10 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:

[<img src="./docs/img/thumbnail.png" width=40% height=40% alt="A video tutorial for bevy_quickstart"/>](https://www.youtube.com/watch?v=ESBRyXClaYc)
[<img src="./docs/img/thumbnail.png" width=40% height=40% alt="A video tutorial for bevy_new_2d, formerly known as bevy_quickstart"/>](https://www.youtube.com/watch?v=ESBRyXClaYc)

## Prerequisites

Expand All @@ -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.
Expand Down
14 changes: 7 additions & 7 deletions docs/workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 #
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/audio.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<Music>>) {
/// for sink in &sink_query {
Expand All @@ -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<SoundEffect>>) {
/// for sink in &sink_query {
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
2 changes: 1 addition & 1 deletion web/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<head>
<meta charset="utf-8" />
<title>Bevy Quickstart</title>
<title>Bevy New 2D</title>
<link data-trunk rel="copy-dir" href="../assets" />
<link data-trunk rel="inline" href="style.css" />
<link data-trunk rel="inline" type="module" href="restart-audio-context.js" />
Expand Down

0 comments on commit 83c2b8b

Please sign in to comment.