Repository files navigation

Please note that the project requires latest Zig compiler (master/nightly). It can be downloadedhere.

Libraries -Sample applications -Vision -Others using zig-gamedev -Monthly reports -Roadmap

We build game development ecosystem forZig programming language, everyday since July 2021. Please considersupporting the project. We create:

• Cross-platform and composablelibraries
• Cross-platformsample applications
• DirectX 12sample applications andintro applications
• Mini-games (in planning)

To get started on Windows/Linux/macOS try outphysically based rendering (wgpu) sample:

git clone https://github.com/michal-z/zig-gamedev.gitcd zig-gamedevzig build physically_based_rendering_wgpu-run

• Very modular "toolbox of libraries", user can use only the components she needs
• Works on Windows, macOS and Linux
• Has zero dependency exceptZig compiler (master) andgit withGit LFS - no Visual Studio, Build Tools, Windows SDK, gcc, dev packages, system headers/libs, cmake, ninja, etc. is needed
• Building is as easy as runningzig build (see:Building)
• Libraries are written from scratch in Zigor provide Ziggified bindings for carefully selected C/C++ libraries
• Uses native wgpu implementation (Dawn) or OpenGL for cross-platfrom graphics and DirectX 12 for low-level graphics on Windows

Some of the sample applications are listed below. More can be found insamples directory.

1. physically based rendering (wgpu): This sample implements physically-based rendering (PBR) and image-based lighting (IBL) to achive realistic looking rendering results.
   zig build physically_based_rendering_wgpu-run

   

2. audio experiments (wgpu): This sample lets the user to experiment with audio and observe data that feeds the hardware.
   zig build audio_experiments_wgpu-run

   

3. bullet physics test (wgpu): This sample application demonstrates how to use full 3D physics engine in your Zig programs.
   zig build bullet_physics_test_wgpu-run

   

4. procedural mesh (wgpu): This sample shows how to efficiently draw several procedurally generated meshes.
   zig build procedural_mesh_wgpu-run

   

5. gui test (wgpu): This sample shows how to use ourzgui library.
   zig build gui_test_wgpu-run

   

Some of the sample applications are listed below. More can be found insamples directory. They can be built and run on Windows and Linux (Wine + VKD3D-Proton 2.8+):

1. bindless: This sample implements physically based shading and image based lighting to achive realistic looking rendering results. It uses bindless textures and HLSL 6.6 dynamic resources.
   zig build bindless-run

   

2. rasterization: This sample application shows how GPU rasterizes triangles in slow motion.
   zig build rasterization-run

   

3. simple raytracer: This sample implements basic hybrid renderer. It uses rasterization to resolve primary rays and raytracing (DXR) for shadow rays.
   zig build simple_raytracer-run

   

4. mesh shader test: This sample shows how to use DirectX 12 Mesh Shader.
   zig build mesh_shader_test-run

   

• Aftersun - Top-down 2D RPG
• Pixi - Pixel art editor made with Zig
• Simulations - GPU Accelerated agent-based modeling to visualize and simulate complex systems
• elvengroin legacy - TBD
• jok - A minimal 2D/3D game framework for Zig

To build all sample applications (assumingzig is in the PATH andGit LFS is installed):

1. git clone https://github.com/michal-z/zig-gamedev.git
2. cd zig-gamedev
3. zig build

Build artifacts will show up inzig-out/bin folder.

zig build <sample_name> will build sample application named<sample_name>.

zig build <sample_name>-run will build and run sample application named<sample_name>.

To list all available sample names runzig build --help and navigate toSteps section.

Options for Windows applications:

• -Dzd3d12-enable-debug-layer=[bool] - Direct3D 12, Direct2D, DXGI debug layers enabled
• -Dzd3d12-enable-gbv=[bool] - Direct3D 12 GPU-Based Validation (GBV) enabled
• -Dzpix-enable=[bool] - PIX markers and events enabled

Thanks to all people who sponsor zig-gamedev project! In particular, these fine folks sponsor zig-gamedev for $25/month or more:

• Derek Collison (derekcollison)
• mzet (mzet-)
• Garett Bass (garettbass)
• Connor Rowland (ckrowland)
• Zig Software Foundation (ziglang)
• shintales (shintales)
• Joran Dirk Greef (jorangreef)