https://github.com/matthewjberger/whyte
Whyte is a small, structured game engine.
https://github.com/matthewjberger/whyte
3d-graphics cpp game-engine
Last synced: 9 months ago
JSON representation
Whyte is a small, structured game engine.
- Host: GitHub
- URL: https://github.com/matthewjberger/whyte
- Owner: matthewjberger
- License: mit
- Created: 2017-03-31T15:43:28.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-02T22:30:15.000Z (over 8 years ago)
- Last Synced: 2025-04-01T13:19:21.043Z (about 1 year ago)
- Topics: 3d-graphics, cpp, game-engine
- Language: C++
- Homepage: http://matthewjberger.xyz/Whyte
- Size: 120 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Whyte
Whyte is a small, structured game engine.
## Building Whyte
First, clone the repo and its submodules:
```bash
git clone --recursive https://github.com/matthewjberger/whyte
```
Then to build, use [CMake](https://cmake.org/):
```bash
cd whyte
mkdir build
cd build
# To generate makefiles and build
cmake ..
make
```
This will generate build files in the `build` directory. On Unix this will be typically a makefile, and on Windows this will typically be a Visual Studio solution.
When you compile, the output will be placed in the `bin` directory.
### Build Options
#### Unit Tests
To build the unit tests, add this flag when generating build files with cmake:
```bash
-DWHYTE_BUILD_UNIT_TESTS=ON
```
Alternatively, you can select the `WHYTE_BUILD_UNIT_TESTS` option in the CMake GUI.
#### Demo Projects
To build the demo projects, add this flag when generating build files with cmake:
```bash
-DWHYTE_BUILD_DEMOS=ON
```
Alternatively, you can select the `WHYTE_BUILD_DEMOS` option in the CMake GUI.
#### Sandbox
To build an empty, isolated project that links agains the Whyte engine, add this flag when generating build files with cmake:
```bash
-DWHYTE_BUILD_SANDBOX=ON
```
Alternatively, you can select the `WHYTE_BUILD_SANDBOX` option in the CMake GUI.
## Vagrant
This will generate a graphical Ubuntu 16.10 virtual machine with all the dependencies to build Whyte installed.
After loading up this virtual machine, you can follow the build instructions above.
1.) [Install Vagrant](https://www.vagrantup.com/downloads.html)
2.) [Install Virtualbox](https://www.virtualbox.org/wiki/Downloads)
3.) Install the `vagrant-reload` plugin:
```bash
vagrant plugin install vagrant-reload
```
4.) Clone this repo with:
```bash
git clone --recursive https://github.com/matthewjberger/whyte
cd whyte
```
5.) Enter the following command:
```bash
vagrant up
```
> Username: `vagrant`
> Password: `vagrant`
The virtual machine will be downloaded and then opened in VirtualBox. You can login with the password `vagrant`. The files in this repo are in the folder `~/Code/whyte` which is also shared with the host machine.
## Dependencies
* CMake
* Ubuntu
```bash
sudo apt-get install cmake
```
* Windows - Visual Studio 2015
* CMake 3.8+ is necessary to properly set the working directory, startup project, and the linker subsystem.
* [Click here to download CMake 3.8.](https://cmake.org/download/)
* SDL2 (32-Bit)
* Ubuntu
```bash
sudo apt-get install libsdl2-dev
```
* Windows - Visual Studio 2015
* [Download the latest version of SDL2 from here.](https://buildbot.libsdl.org/sdl-builds/sdl-visualstudio/)
* Extract the folder anywhere you like.
* Set an environment variable called `SDL2DIR` to point to the root path of the extracted folder.