Skip to content

Compiling framework

fredakilla edited this page Jul 7, 2018 · 61 revisions

Compiling framework consists to build :

  • Third-party libraries (amalgamated to a single GPlay-deps static library)
  • GPlay engine library (GPlay static library)
  • Samples
  • Tools

Cmake is necessary to build third-party libraries but by default it build the entire framework.

QtCreator can be used as alternative to build the engine, samples and tools. But you need to use cmake before, to build thirdparty libraries.

Install submodules dependencies

Some thirdparty libraries are registered as submodules, you need to install them before compiling.

git submodule init
git submodule update

Project repository

Included in the project repository are the following notable folder and files:

Folder/Files Description
/thirdparty External dependency libraries
/res The resources data folder
/src The gplay3d library sources
/samples Game samples
/tools Content authoring encoder and lua binding generator

Output directory

Cmake will create and populate the output directory, this directory is organized as follow:

Folder Description
/bin The output directory for samples binaries
/include The GPlayEngine include directory that contains engine headers to add to your project
/lib Contains the GPlay and GPlay-deps libraries to link to your projects

Setup instructions

Listed below are the basic setup instructions for downloading and installing the supported platform and development environments for gameplay.

Clone this wiki locally