{"id":15137904,"url":"https://github.com/thebevyflock/bevy_new_2d","last_synced_at":"2025-10-08T12:51:38.470Z","repository":{"id":246953123,"uuid":"824330782","full_name":"TheBevyFlock/bevy_new_2d","owner":"TheBevyFlock","description":"This template is a great way to get started on a new 2D Bevy game!","archived":false,"fork":false,"pushed_at":"2025-04-01T22:14:02.000Z","size":3200,"stargazers_count":258,"open_issues_count":33,"forks_count":37,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-02T06:04:41.148Z","etag":null,"topics":["bevy","gamedev","template"],"latest_commit_sha":null,"homepage":"https://the-bevy-flock.itch.io/bevy-new-2d","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TheBevyFlock.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-Apache-2.0.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-04T22:18:26.000Z","updated_at":"2025-04-01T22:14:07.000Z","dependencies_parsed_at":"2024-07-09T00:58:37.142Z","dependency_job_id":"7c85a5e9-19ce-417c-8bf1-faf28a748202","html_url":"https://github.com/TheBevyFlock/bevy_new_2d","commit_stats":null,"previous_names":["thebevyflock/bevy-template","thebevyflock/bevy_new_2d","thebevyflock/bevy_quickstart"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheBevyFlock%2Fbevy_new_2d","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheBevyFlock%2Fbevy_new_2d/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheBevyFlock%2Fbevy_new_2d/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheBevyFlock%2Fbevy_new_2d/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheBevyFlock","download_url":"https://codeload.github.com/TheBevyFlock/bevy_new_2d/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247999856,"owners_count":21031046,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bevy","gamedev","template"],"created_at":"2024-09-26T07:03:29.292Z","updated_at":"2025-10-08T12:51:38.464Z","avatar_url":"https://github.com/TheBevyFlock.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bevy New 2D\n\nThis template is a great way to get started on a new 2D [Bevy](https://bevyengine.org/) game!\nStart with a [basic project](#write-your-game) and [CI / CD](#release-your-game) that can deploy to [itch.io](https://itch.io).\nYou can [try this template in your browser!](https://the-bevy-flock.itch.io/bevy-new-2d)\n\n## Prerequisites\n\nWe assume that you're familiar with Bevy and have already seen the [official Quick Start Guide](https://bevyengine.org/learn/quick-start/introduction/).\n\nIf you're new to Bevy, the patterns used in this template may look a bit weird at first glance.\nSee our [Design Document](./docs/design.md) for more information on how we structured the code and why.\n\n## Create a new game\n\nInstall [`bevy_cli`](https://github.com/TheBevyFlock/bevy_cli/) and run the following command:\n\n```sh\nbevy new my_game --template 2d\n```\n\nThen [create a GitHub repository](https://github.com/new) and push your local repository to it.\n\n## Write your game\n\nThe best way to get started is to play around with the code you find in [`src/demo/`](./src/demo).\n\nThis template comes with a basic project structure that you may find useful:\n\n| Path                                               | Description                                                        |\n| -------------------------------------------------- | ------------------------------------------------------------------ |\n| [`src/main.rs`](./src/main.rs)                     | App setup                                                          |\n| [`src/asset_tracking.rs`](./src/asset_tracking.rs) | A high-level way to load collections of asset handles as resources |\n| [`src/audio.rs`](./src/audio.rs)                   | Marker components for sound effects and music                      |\n| [`src/dev_tools.rs`](./src/dev_tools.rs)           | Dev tools for dev builds (press \\` aka backtick to toggle)         |\n| [`src/demo/`](./src/demo)                          | Example game mechanics \u0026 content (replace with your own code)      |\n| [`src/menus/`](./src/menus)                        | Main menu, pause menu, settings menu, etc.                         |\n| [`src/screens/`](./src/screens)                    | Splash screen, title screen, loading screen, etc.                  |\n| [`src/theme/`](./src/theme)                        | Reusable UI widgets \u0026 theming                                      |\n\nFeel free to move things around however you want, though.\n\n\u003e [!TIP]\n\u003e Be sure to check out the [3rd-party tools](./docs/tooling.md) we recommend!\n\n## Run your game\n\nWe recommend using the [Bevy CLI](https://github.com/TheBevyFlock/bevy_cli) to run your game.\n\nRunning your game locally is very simple:\n\n- Use `bevy run` to run a native dev build.\n- Use `bevy run web` to run a web dev build.\n\nThis template also comes with [VS Code tasks](./.vscode/tasks.json) and [JetBrains run configurations](./.idea/runConfigurations/)\nto help run your game from your IDE.\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cins\u003eRunning release builds\u003c/ins\u003e\u003c/summary\u003e\n\n  - Use `bevy run --release` to run a native release build.\n  - Use `bevy run --release web` to run a web release build.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cins\u003eInstalling Linux dependencies\u003c/ins\u003e\u003c/summary\u003e\n\n  If you're using Linux, make sure you've installed Bevy's [Linux dependencies](https://github.com/bevyengine/bevy/blob/main/docs/linux_dependencies.md).\n  Note that this template enables Wayland support, which requires additional dependencies as detailed in the link above.\n  Wayland is activated by using the `bevy/wayland` feature in the [`Cargo.toml`](./Cargo.toml).\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cins\u003e(Optional) Improving compile times\u003c/ins\u003e\u003c/summary\u003e\n\n  [`.cargo/config_fast_builds.toml`](./.cargo/config_fast_builds.toml) contains documentation on how to set up your environment to improve compile times.\n  After you've fiddled with it, rename it to `.cargo/config.toml` to enable it.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cins\u003e(Optional) Hot-patching with \u003ccode\u003esubsecond\u003c/code\u003e\u003c/ins\u003e\u003c/summary\u003e\n\n  Hot-patching is an experimental feature that allows you to edit your game's code _while it's running_\n  and see the changes without having to recompile or restart.\n\n  To set this up, follow the instructions in the [release announcement](https://bevy.org/news/bevy-0-17/#hot-patching-systems-in-a-running-app).\n\n  Run your game with hot-patching enabled:\n\n  ```shell\n  BEVY_ASSET_ROOT='.' dx serve --hot-patch --features \"bevy/hotpatching\"\n  ```\n\n  Now edit a system's code while the game is running, and save the file.\n  You should see `Status: Hot-patching...` in the CLI if you've got it working.\n\u003c/details\u003e\n\n## Release your game\n\nThis template uses [GitHub workflows](https://docs.github.com/en/actions/using-workflows) to run tests and build releases.\nSee [Workflows](./docs/workflows.md) for more information.\n\n## Known Issues\n\nThere are some known issues in Bevy that can require arcane workarounds.\nTo keep this template simple, we've opted to leave these workarounds out.\nYou can read about them in the [Known Issues](./docs/known-issues.md) document.\n\n## License\n\nThe source code in this repository is licensed under any of the following at your option:\n\n- [CC0-1.0 License](./LICENSE-CC0-1.0.txt)\n- [MIT License](./LICENSE-MIT.txt)\n- [Apache License, Version 2.0](./LICENSE-Apache-2.0.txt)\n\nThe CC0 license explicitly does not waive patent rights, but we confirm that we hold no patent rights to anything presented in this repository.\n\n## Credits\n\nThe [assets](./assets) in this repository are all 3rd-party. See the [credits menu](./src/menus/credits.rs) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthebevyflock%2Fbevy_new_2d","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthebevyflock%2Fbevy_new_2d","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthebevyflock%2Fbevy_new_2d/lists"}