1. Installation
Alternative: Manual setup
While the editor app is the recommended way to get started, you can also set up a project manually.
Prerequisites
You need to have the following installed on your computer:
- node
- python
- git-lfs
- cmake
- ccache
- ninja
- clang-format
MacOS
Install via HomeBrew
brew install cmake ccache ninja git-lfs clang-format nvm
Note: We recommend installing node via nvm:
nvm install --lts
Windows
Install via Scoop
scoop install cmake ccache ninja git git-lfs nvm
Note: We recommend installing node via nvm:
nvm install --lts
(clang-format is not available in scoop)
Get the template
Start by getting a copy of the Hiber3D game template:
npx degit https://github.com/hiber3d/game-template#stableSetup the project
Unless you have used git lfs before, it needs to be initialized now:
git-lfs installgit-lfs fetchgit-lfs checkout
Next, from the root of the project, run
npm run compile(See below for options)npm installnpm run dev
Open http://localhost:5173 in your browser
- Press
cmd + e(ctrl + eon Windows) to toggle the editor - Start creating your game!
Compiling engine
If you only want to compile the C++ code you can run:
- Both:
npm run compilenpm run compile:release
- WebGPU only:
npm run compile:webgpunpm run compile:webgpu:release
- WebGL only:
npm run compile:webglnpm run compile:webgl:release
Last updated on