Repository files navigation

Libraries -Getting Started -Sample applications -Others using zig-gamedev

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

• Cross-platform and composablelibraries
• Cross-platformsample applications
• DirectX 12sample applications

• Very modular "toolbox of libraries", user can use only the components she needs
• JustZig is required to build on Windows, macOS and Linux - no Visual Studio, Build Tools, Windows SDK, gcc, dev packages, system headers/libs, cmake, ninja, etc. is needed
• Building is as easy aszig build
• 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-platform graphics and DirectX 12 for low-level graphics on Windows

Download thelatest archive or clone/submodule with Git.

Note: If using Git then you will needGit LFS to be installed.

Ourmain branch is currenly tracking Zig0.12.0-dev.2063+804cee3b9 asnominated by the Mach engine project to maintain compatibilty for users of both projects.

zigup is recommended for managing compiler versions. Alternatively, you can download and install manually using the links below:

If you need to use a more recent version of Zig, you can try ourunstable branch. But this is not generally recommended.

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

zig build physically_based_rendering_wgpu-run

To get a list of all available build steps:

zig build -l

Copy each library to a subdirectory in your project and add them as local package dependencies. For example:

build.zig.zon

.{    .name="MyGame",    .version="0.0.0",    .dependencies= .{        .zglfw= .{ .path="libs/zglfw" },        .system_sdk= .{ .path="libs/system-sdk" },    },    .paths="",}

build.zig

pubfnbuild(b:*std.Build)void {constexe=b.addExecutable(.{... });constzglfw=b.dependency("zglfw", .{});exe.root_module.addImport("zglfw",zglfw.module("root"));exe.linkLibrary(zglfw.artifact("glfw"));}

Refer to each lib's README.md for further usage intructions.

Option to download packages using Zig Package Managercoming soon!

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 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 achieve 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

   

• Tides of Revival - First-person, open-world, fantasy RPG being developed in the open
• Simulations - GPU Accelerated agent-based modeling to visualize and simulate complex systems
• krateroid - 3D strategy game
• blokens - Voxel game
• Delve Framework - Simple game framework for making games with Lua
• jok - A minimal 2D/3D game framework for Zig
• Aftersun - Top-down 2D RPG
• Pixi - Pixel art editor made with Zig