⚠️ Beta State

PyBevy is in an early and experimental stage. The API is incomplete, subject to breaking changes without notice, and you should expect bugs. Many features are still under development.

Where to Go Next?

A "table of contents" file pointing to the other tracks.

Congratulations!

You've completed the "Get Started" hub for pybevy. You've learned the absolute basics:

  • How to create an app and open a window.
  • The magic of hot reloading with pybevy watch.
  • The core concepts of the Entity Component System (ECS).
  • How to spawn 2D and 3D objects in the same world.

You now have the foundational knowledge to start building things!

The Hub and Spoke Model

This documentation is structured like a "hub and spoke" model. You just finished the central hub. Now, you can choose a spoke that matches what you want to build. Each spoke is a self-contained tutorial track that will guide you through a specific area of game development.

What do you want to build?

Choose a track below to continue your journey.

Track 1: 2D Game Development

Start here if you want to build a 2D game like Breakout, a platformer, or a top-down shooter.

This track covers everything you need for 2D games, including sprites, player input, animation, UI, and a final project to build a complete Breakout clone.

(Find these examples in the 01_track_2d folder)

Track 2: 3D Scene Development

Start here to learn 3D rendering, load complex models, and understand lighting.

This track focuses on creating beautiful 3D worlds. You'll learn how to load industry-standard glTF models, set up realistic lighting with Physically Based Rendering (PBR), and play character animations.

(Find these examples in the 02_track_3d folder)

Core Features

Learn the engine features that power real games: timers, events, states, audio, and more.

This track covers the essential systems you'll need for any non-trivial project. It teaches timers for cooldowns, events and observers for decoupled communication, game states for menus and pausing, audio playback, mouse input, camera controllers, custom plugins, post-processing effects, and window configuration.

(Find these examples in the 06_core_features folder)

The Cookbook: Advanced Recipes

For advanced users. Find specific recipes for NumPy, custom shaders, and more.

The cookbook is not a linear tutorial. It's a collection of standalone examples that show how to solve specific, advanced problems or integrate pybevy with other tools. Dive in here when you have a specific question or want to see how to push the engine further.

(Find these examples in the 03_cookbook folder)

The Philosophy: "Why?"

Learn why pybevy uses ECS and how it compares to other Python game libraries.

This section is for those who want to understand the design decisions behind pybevy. It explains the benefits of the ECS architecture and provides a brief comparison to frameworks like Pygame and Godot.

(Find these examples in the 04_philosophy folder)

# This file is for explanation only and does not contain runnable code.
pass