|
| 1 | +# Hazel [](https://github.com/TheCherno/Hazel/blob/master/LICENSE) |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +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](https://thecherno.com/engine). |
| 6 | + |
| 7 | +*** |
| 8 | + |
| 9 | +## Getting Started |
| 10 | +Visual Studio 2017 or 2019 is recommended, Hazel is officially untested on other development environments whilst we focus on a Windows build. |
| 11 | + |
| 12 | +<ins>**1. Downloading the repository:**</ins> |
| 13 | + |
| 14 | +Start by cloning the repository with `git clone --recursive https://github.com/TheCherno/Hazel`. |
| 15 | + |
| 16 | +If the repository was cloned non-recursively previously, use `git submodule update --init` to clone the necessary submodules. |
| 17 | + |
| 18 | +<ins>**2. Configuring the dependencies:**</ins> |
| 19 | + |
| 20 | +1. Run the [Setup.bat](https://github.com/TheCherno/Hazel/blob/master/scripts/Setup.bat) file found in `scripts` folder. This will download the required prerequisites for the project if they are not present yet. |
| 21 | +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. |
| 22 | +3. After installation, run the [Setup.bat](https://github.com/TheCherno/Hazel/blob/master/scripts/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) |
| 23 | +4. After downloading and unzipping the files, the [Win-GenProjects.bat](https://github.com/TheCherno/Hazel/blob/master/scripts/Win-GenProjects.bat) script file will get executed automatically, which will then generate a Visual Studio solution file for user's usage. |
| 24 | + |
| 25 | +If changes are made, or if you want to regenerate project files, rerun the [Win-GenProjects.bat](https://github.com/TheCherno/Hazel/blob/master/scripts/Win-GenProjects.bat) script file found in `scripts` folder. |
| 26 | + |
| 27 | +*** |
| 28 | + |
| 29 | +## The Plan |
| 30 | +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](https://patreon.com/thecherno). 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. |
| 31 | + |
| 32 | +### Main features to come: |
| 33 | +- Fast 2D rendering (UI, particles, sprites, etc.) |
| 34 | +- High-fidelity Physically-Based 3D rendering (this will be expanded later, 2D to come first) |
| 35 | +- Support for Mac, Linux, Android and iOS |
| 36 | + - Native rendering API support (DirectX, Vulkan, Metal) |
| 37 | +- Fully featured viewer and editor applications |
| 38 | +- Fully scripted interaction and behavior |
| 39 | +- Integrated 3rd party 2D and 3D physics engine |
| 40 | +- Procedural terrain and world generation |
| 41 | +- Artificial Intelligence |
| 42 | +- Audio system |
| 43 | + |
| 44 | + |
| 45 | +## Short term goals : |
| 46 | +*Note: this is subject to change at any time! Follow the roadmap over at [hazelengine.com/roadmap](http://hazelengine.com/roadmap).* |
| 47 | + |
| 48 | +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: |
| 49 | + |
| 50 | +- Design the game scene by using Hazelnut, the Hazel editor, |
| 51 | +- Test the game inside Hazelnut, including the ability to save/load the created game, |
| 52 | +- Load and play the game inside Sandbox. |
| 53 | + |
| 54 | +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. |
| 55 | + |
| 56 | +[](https://twitter.com/thecherno) |
| 57 | +[](https://www.instagram.com/thecherno) |
| 58 | +[](https://www.youtube.com/user/TheChernoProject) |
| 59 | +[](https://discord.gg/K2eSyQA) |
| 60 | +[](https://patreon.com/thecherno) |
0 commit comments