README.md

Gardenrift

The goal of this project is to create a small game in Zig, both as a learning opportunity and a proof-of-concept, to see Zig would be a good language to stick with for future game development needs.

It would also be a good learning opportunity to learn lower-level concepts such as graphics and audio APIs, and ECS implementation.

References

Zig

• Zig Documentation
• Zig Guide

Vulkan/OpenGL/GLFW

• Vulkan Tutorial (Highly Recommended!)
• Vulkan (c++) Game Engine Tutorials by Brendan Galea
• GLFW Docs
• Vulkan-Zig by Snektron
• Vulkan Docs
• Mach-GLFW by Hexops
• Mach-GLFW-Vulkan-example by Hexops
• Vulkan by GetIntoGameDev
• OpenGL Tutorial
• Vulkan-Cookbook by Packt
• Kohi Game Engine by Travis Vroman

OpenAL

• OpenAL Programmers Guide
• OpenAL Tutorial by Code, Tech and Tutorials

Math/Linear Algebra

• Model-View-Projection
• Matrix Transformations by Jordan Santell
• Perspective Projection Matrix by pikuma

Image File Format

• Zigimg
• BMP File Format by University of Alberta

Audio File Format

• Making WAVs by Low Byte Productions
• WAVE PCM soundfile format
• Understanding Audio Basics by waveroom

3D File Format

• Model Loading on OpenGL Tutorial
• Wavefront .obj file on Wikipedia

Misc

• Mach Engine
• Pixi by Foxnne
• Aftersun by Foxnne

Resources

• Viking Room by nigelgoh (models/viking_room.obj, textures/viking_room.bmp)
• Blinding Lights by Zander Noriega (sounds/blinding-lights.wav)
• Completion by Brandon Morris (sounds/competion.wav)

Decisions

• Files with underscores as names (e.g. _.zig) will be known as exporters. These serve as the entrypoints of a directory that expose its public contents. This should have nothing in it except a list of pub const <name> = @import("<file>");. This is as opposed to main.zig which may contain functionalities.