Hazel README

The project's README from github.com/TheCherno/Hazel. As one markdown file: README.md.

Hazel License

Hazel

Hazel is primarily an early-stage interactive application and rendering engine for Windows. Currently not much is implemented, however (almost) everything inside this repository is being created within YouTube videos, found at thecherno.com/engine.

Getting Started

Visual Studio 2017 or 2019 is recommended, Hazel is officially untested on other development environments whilst we focus on a Windows build.

1. Downloading the repository:

Start by cloning the repository with git clone --recursive https://github.com/TheCherno/Hazel.

If the repository was cloned non-recursively previously, use git submodule update --init to clone the necessary submodules.

2. Configuring the dependencies:

  1. Run the Setup.bat file found in scripts folder. This will download the required prerequisites for the project if they are not present yet.
  2. One prerequisite is the Vulkan SDK. If it is not installed, the script will execute the VulkanSDK.exe file, and will prompt the user to install the SDK.
  3. After installation, run the Setup.bat file again. If the Vulkan SDK is installed properly, it will then download the Vulkan SDK Debug libraries. (This may take a longer amount of time)
  4. After downloading and unzipping the files, the Win-GenProjects.bat script file will get executed automatically, which will then generate a Visual Studio solution file for user's usage.

If changes are made, or if you want to regenerate project files, rerun the Win-GenProjects.bat script file found in scripts folder.

The Plan

The plan for Hazel is two-fold: to create a powerful 3D engine, but also to serve as an education tool for teaching game engine design and architecture. Because of this the development inside this repository is rather slow, since everything has to be taught and implemented on-camera. There is a much more advanced version of the engine in a private repository called Hazel-dev, accessible to supporters on Patreon. The plan for this project is to mostly take already implemented code from the Hazel-dev repository and integrate it into this one, done within videos and supported by explanations.

Main features to come:

Short term goals :

Note: this is subject to change at any time! Follow the roadmap over at hazelengine.com/roadmap.

By the end 2020, we want to make a game using the Hazel game engine. Not like the time I made a game in one hour using the engine, but this time by using the proper tools that would be required to make a game with Hazel. This means we need to add a full 2D workflow:

We want everyone to be able to play the game on all desktop platforms (Windows, Mac and Linux). When this is implemented, another attempt at the "Creating a game in one hour using Hazel" will be made to see how far the engine has become.

Twitter Instagram Youtube Discord Patreon

Hazel (TheCherno/Hazel)

Searching Database…

13.1K ·GitHub
Hazel
What is this?Hazel is an early-stage interactive application and rendering engine for Windows, built mainly as an educational project: nearly everything in the repo is implemented live in YouTube videos.
Is it a finished game engine or more of a work-in-progress learning project?It's a work-in-progress engine with very little implemented so far; the full-featured version lives in a private 'Hazel-dev' repo for Patreon supporters, and code is gradually ported here with explanations.
How do I get it building?Clone the repo recursively with git submodules, then run scripts/Setup.bat, which installs prerequisites including the Vulkan SDK and generates a Visual Studio solution via Win-GenProjects.bat.
Do I need a specific IDE or SDK before building?Yes: Visual Studio 2017 or 2019 is recommended (officially untested elsewhere), and the Vulkan SDK plus its Debug libraries are required and auto-installed by the setup script.
Does it run on Mac or Linux yet?No, currently it's Windows-only; cross-platform support (Mac, Linux, Android, iOS) is listed as a planned future feature, not something that works now.
Who is this project really for?It's aimed at people who want to learn game engine architecture by following along with TheCherno's YouTube series, not developers looking for a production-ready engine.
Is this installed on my iPhone or on a desktop?Desktop only, specifically Windows right now, built and run through Visual Studio.
What is the end goal mentioned in the roadmap?By the end of 2020 the team wanted to make a full game using Hazel, designed in the Hazelnut editor, testable there, and playable in the Sandbox app across Windows, Mac and Linux.
What is Hazelnut?Hazelnut is the planned Hazel editor application used to design and test game scenes before loading them into the Sandbox player.
What rendering APIs does it plan to support?The roadmap lists native rendering API support for DirectX, Vulkan, and Metal, alongside both 2D (UI, particles, sprites) and physically-based 3D rendering.
Where can I watch the engine being built?Development happens live in YouTube videos at thecherno.com/engine, with a roadmap tracked separately at hazelengine.com/roadmap.
What are similar projects?bgfx, sbox-public, tinyrenderer, assimp, benilla, 3d-game-shaders-for-beginners, DaVinciResolve-likeColorGradePanel4UE, raylib
Which topics is it in?engine, game-engine, gamedev, youtube, rendering, game-development, graphics, 3d, cpp, learning-resources, c++, desktop
Creator
TheCherno
Size
53.5 MB
Stars
13.1K
Updated
CommitOct 27
Age
7y
Commits · 90 Days