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
Что это такое?Hazel — это ранняя интерактивная система и движок визуализации для Windows, созданный в первую очередь как учебный проект: почти всё, что есть в репозитории, пишется в прямом эфире на YouTube.
Это готовый игровой движок или скорее учебный проект в процессе разработки?Это движок в процессе разработки, и реализовано в нём пока очень немного. Полнофункциональная версия находится в закрытом репозитории Hazel-dev для сторонников на Patreon, а код постепенно переносится сюда с пояснениями.
Как мне собрать проект?Клонируйте репозиторий рекурсивно с подмодулями git, затем запустите scripts/Setup.bat: он установит необходимые компоненты, включая Vulkan SDK, и создаст решение Visual Studio с помощью Win-GenProjects.bat.
Нужна ли мне определённая среда разработки или SDK перед сборкой?Да: рекомендуется Visual Studio 2017 или 2019 (официально в других версиях не тестировалось). Также необходимы Vulkan SDK и его отладочные библиотеки, которые скрипт настройки устанавливает автоматически.
Уже работает на Mac или Linux?Нет, сейчас поддерживается только Windows. Поддержка других платформ (Mac, Linux, Android, iOS) указана в планах на будущее, но пока не работает.
Для кого на самом деле этот проект?Он рассчитан на тех, кто хочет изучить архитектуру игровых движков, следуя серии роликов TheCherno на YouTube. Готовый к промышленному использованию движок он не предлагает.
Это ставится на мой iPhone или на компьютер?Только на компьютер, а точнее — сейчас только на Windows. Собирается и запускается через Visual Studio.
Какая конечная цель указана в дорожной карте?К концу 2020 года команда хотела создать полноценную игру на Hazel: разработать её в редакторе Hazelnut, тестировать там и запускать в приложении Sandbox на Windows, Mac и Linux.
Что такое Hazelnut?Hazelnut — запланированное приложение-редактор для Hazel, которое будет использоваться для создания и тестирования игровых сцен перед загрузкой их в проигрыватель Sandbox.
Какие графические API планируется поддерживать?В дорожной карте указана нативная поддержка графических API DirectX, Vulkan и Metal, а также 2D-отрисовка (интерфейс, частицы, спрайты) и физически корректная 3D-отрисовка.
Где можно посмотреть, как создаётся движок?Разработка ведётся в прямом эфире на YouTube, по адресу thecherno.com/engine. Дорожная карта отслеживается отдельно на 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