Skip to content
The Trillek Engine
C C++ CMake
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Trillek Engine C

Windows (VStudio 2019) Semaphore (GCC)
Build status Build Status

Requirements

TEC requires cmake 3.9 and a few libraries GLFW3, GLM, ASIO, Protobuf, GLEW, Lua, Bullet, Dear ImGui, Spdlog and OpenAL which can be installed most easily via vcpkg

VCPKG

  1. git clone https://github.com/Microsoft/vcpkg.git (If you already have VCPKG, go to building)
  2. Navigate to the vcpkg/ directory.
    1. Windows: ./bootstrap-vcpkg.bat or Others: ./bootstrap-vcpkg..sh
    2. MacOS MAYBE sudo installer -pkg /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg -target / if bootstrap-vcpkg fails see here for more help
    3. Linux apt-get install libgl1-mesa-dev xorg-dev libglu1-mesa-dev libxinerama-dev libxcursor-dev
    4. OPTIONAL ./vcpkg integrate install
    5. ./vcpkg install asio bullet3 glew glfw3 glm lua openal-soft protobuf zlib spdlog imgui

Building

  1. git submodule update --init in the root directory.
  2. mkdir build/ in to root directory
  3. cd build/
  4. Follow platform specific instructions
    1. Linux (G++ 7 or CLang 4) Unsupported at this moment due to have cmake is setup
      1. INSTALL REQUIRED LIBS bullet, glew, glfw3, glm, asio, lua, openal-soft, spdlog, Dear ImGui, and protobuf. Some of these will need versions not in your distribution (just ask for help in the IRC.)
        1. If you are on Ubuntu/Debian/etc. (something with apt):
          1. Run apt-get install libglew-dev libglfw3 libglm-dev libasio-dev
          2. Run apt-get install liblua5.2-dev libopenal-dev libbullet-dev
          3. Run apt-get install libprotobuf-dev protobuf-compiler libspdlog-dev
        2. If you are on Fedora/RHEL/etc. (something with rpm):
          1. instructions coming soon to a README near you
        3. If you are on Arch/etc. (something with pacman):
          1. Run pacman -S glew glfw-x11 glm asio lua52 openal bullet protobuf spdlog
      2. cmake .. in the build directory
      3. make tec in the build directory
    2. Linux VCPKG (G++ 7 or CLang 4)
      1. cmake -DCMAKE_TOOLCHAIN_FILE=**VCPKG_DIR**/scripts/buildsystems/vcpkg.cmake .. in the build directory
      2. make in the build directory
    3. Windows (Visual Studio 2019)
      1. Run cmake-gui setting the source line to the root directory and the build line to the build directory.
      2. Hit configure and select Specify toolchain file for cross-compiling using **VCPKG_DIR**/scripts/buildsystems/vcpkg.cmake.
      3. Click generate; then open and build the solution in Visual Studio.
      4. In the project properties for trillek-client change the Debugging->Working Directory to $(SolutionDir)..\.
      5. Potentially Download and install oalinst.zip (OpenAL installer) http://openal.org/downloads/ and install it.
    4. MaxOS X 10.14
      1. brew install bullet
      2. cmake -DCMAKE_TOOLCHAIN_FILE=**VCPKG_DIR**/scripts/buildsystems/vcpkg.cmake .. in the build directory
      3. make in the build directory
  5. Run it from tec/

Unit tests

To generate the unit tests, follow the same instructions that before, but set to true the flag BUILD_TESTS_TEC

You can’t perform that action at this time.