Repository files navigation

This template is based on the awesomeBevyFlock 2D template featuring out of the box builds for:

• Windows
• Linux
• macOS
• Web (Wasm)This template is a great way to get started if you aim to build new 3D RPGBevy game!It is not as simple as bevy_new_2d which is aimed to an easy start. It focuses to have a rather solid structure to be able to carry the weight of big projects and uses cargo workspaces for that. It adds a bit of complexity, but for big projects it's unavoidable, and this is an example of aflat architercture.Start with abasic project andCI / CD that can deploy toitch.io.You cantry this template in your browser!

Installcargo-generate orbevy_cli and run:

cargo generate olekspickle/bevy_new_3d_rpg -n my-rpg# or with bevy_clibevy new -t=olekspickle/bevy_new_3d_rpg my-rpg

• flat cargo workspace based project structure for game logic crates that can grow and be maintainable
• import and usage of game mechanics and parameters from .ron (config, credits) (kudos to Caudiciform)
• simple asset loading based onbevy_asset_loader with loading from path addition (kudos to Caudiciform)
• third person camera withbevy_third_person_camera
• solid keyboard & gamepad mapping to ui & game actions usingbevy_enhanced_input
• simple scene with colliders and rigid bodies usingavian3d
• simple player movement usingbevy_tnua
• simple skybox sun cycle usingbevy atmosphere example, with daynight and nimbus modes
• featuring rig and animations usingUniversal Animation Library from quaternius
• experimental sound withbevy_seedling based on Firewheel audio engine (which will probably replace bevy_audio), withhighly experimental audio stutter fix for web
• consistent Esc back navigation in gameplay and menu via stacked modals (kudos for the idea to skyemakesgames)
• serialize and save settings
• audio, video and keys rebind tabs in settings (currently not really working)
• easy drop in scene integration using awesomeskein with a simple scene

• add basic mood change per zone
• implement different music states(exploration, combat)
• custom font replace example using pre-loaded font
• sky background instead of just void lol
• Movement sfx: jump, dash, sprint
• spatial audio demo: boombox emitting background music
• Jump with timer(tricky with tnua jump in air counter)
• small door/portal demo
• split screen for coop
• vault on objects if they are reachable
• climbing
• do not rotate player on aim(silly bug, check it out - release aim looking to the floor)
• basic fighting: punch, kick, take weapon
• weapon select wheel
• bow
• rifle

The best way to get started is to play around with the code you find insrc/game/.This template comes with a basic project structure that you may find useful:

Feel free to move things around however you want, though.

There are some helpful commands inMakefile to simplify build optionsBut generally running your game locally is very simple:

• make run if you havecmake
• Usebevy run withbevy_cli orcargo run to run a native dev build.
• Use this command to run a web dev build to run audio in separate thread to avoid audio stuttering:

bevy run web --headers="Cross-Origin-Opener-Policy:same-origin" --headers="Cross-Origin-Embedder-Policy:credentialless"

- Use `bevy run --release` to run a native release build.

WARNING: if you work in a private repository, please be aware that macOS and Windows runners cost more build minutes.For public repositories the workflow runners are free!

This template usesGitHub workflows to run tests and build releases.Check therelease-flow

There are some known issues in Bevy that can require arcane workarounds.

This template uses firewheel experimental audio runnign in the separate worker thread, so it should not be happening, but if you experience it nevertheless, here are a few tips:

• If you're using materials, you should force your render pipelines toload at the start of the game
• Optimize your game as much as you can to keep its FPS high.
• Apply the suggestions from the blog post [Workaround for the Choppy Music in Bevy Web Builds].
• Advise your users to try a Chromium-based browser if there are still issues.

The game window is created before the GPU is ready to render everything.This means that it'll start with a white screen for a few frames.The workaround is tospawn the Window hidden and onlymake it visible a few frames later

Choppy character movement is often caused by movement updates being tied to the frame rate.See thephysics_in_fixed_timestep example for how to fix this.

Choppy camera movement is almost always caused by the camera being tied too tightly to a moving target position.You can usesmooth_nudge to make your camera smoothly approach its target position instead.

Theassets in this repository are all 3rd-party. See the seecredits for more information.

The source code in this repository is licensed under any of the following at your option:

• CC0-1.0 License
• MIT License
• Apache License, Version 2.0