Skip to content

Latest commit

 

History

History
105 lines (87 loc) · 3.62 KB

README.md

File metadata and controls

105 lines (87 loc) · 3.62 KB

🎮 Bevy Starter Template for NixOS

A streamlined template for Bevy game development on NixOS, leveraging direnv and Nix flakes for a seamless setup. Multi-crate structure for better code organization.

🌟 Features

  • Multi-Crate Structure: Separate app-bevy and lib-utils crates for better organization
  • Optimized Compilation: Fast linking with LLD
  • Nightly Rust: Latest features
  • Bevy Enhancements: Dynamic linking and Wayland support
  • Nix-Powered: Consistent development environment

🚀 Quick Start

git clone https://github.com/drxm1/bevy-project-template-nixos-wayland.git
cd bevy-project-template-nixos-wayland
direnv allow
cargo run -p app-bevy

🛠 Project Structure

  • Cargo.toml: Workspace configuration
  • app-bevy/: Main Bevy application crate
    • Cargo.toml: Bevy app manifest
    • src/main.rs: Main application code
  • lib-utils/: Utility crate
    • Cargo.toml: Utils crate manifest
    • src/lib.rs: Utility functions and plugins
  • .cargo/config.toml: LLD linker configuration
  • rust-toolchain.toml: Nightly Rust specification
  • flake.nix: Nix development environment definition
  • .envrc: Direnv configuration for Nix flake

🧰 Development Environment

  • Nix Flakes: Reproducible development setup
  • Direnv: Automatic environment loading
  • Rust Nightly: Latest features necessary with our build flags

📝 Notes

  • Requires Nix and direnv
  • .direnv is gitignored
  • Update flake.lock with nix flake update after flake.nix changes

🚫 Limitations

  • No WebGPU or web serving capabilities ensured right now, add that yourself
  • Designed for local development (well tested in emacs with direnv-mode)

🔧 Using This Template for Your Project

  1. Clone the repository: 
    git clone https://github.com/drxm1/bevy-project-template-nixos-wayland.git your-project-name
cd your-project-name
  2. Remove the existing git history: 
    rm -rf .git
  3. Initialize a new git repository: 
    git init
  4. Update the project name in Cargo.toml, app-bevy/Cargo.toml, lib-utils/Cargo.toml, and flake.nix.
  5. Update this README.md with your project details.
  6. Create your initial commit: 
    git add .
git commit -m "Initial commit: Bevy project setup from template"
  7. Link to your new GitHub repository: 
    git remote add origin https://github.com/yourusername/your-project-name.git
git branch -M main
git push -u origin main
  8. Start developing your Bevy game!
  9. For the final release build:
    • Refer to the Bevy setup guide for optimal release configurations.
    • Note that you'll likely need to build the final version without dynamic linking for better performance and portability.
    • Update your app-bevy/Cargo.toml to remove the dynamic_linking feature for release builds: 
      [dependencies]
bevy = { version = "0.14.0", features = ["wayland"] }

[features]
default = ["bevy/wayland"]
dev = ["bevy/dynamic_linking"]
    • Build your release version with: 
      cargo build --release --package app-bevy

Remember to customize the flake.nix if you need additional dependencies for your specific project.

📦 Working with Multiple Crates

  • To run the main application: cargo run -p app-bevy or just cargo run
  • To run tests for all crates: cargo test --workspace
  • To add a new dependency to the utils crate: cargo add <dependency> --package lib-utils
  • Add more crates to the workspace by updating the root Cargo.toml file.