Skip to content

Latest commit

 

History

History
73 lines (42 loc) · 3.06 KB

README.md

File metadata and controls

73 lines (42 loc) · 3.06 KB
Raw

The Gear2D Creation Kit (G2CK)

(This document is subject to many changes :)

Gear2D Creation Kit is a set of CMake scripts that, given a build toochain, can setup everything you need to start creating your own game using Gear2D.

It assumes you have a build environment available and CMake installed, so, before you start, go get them.

  • If you're using Apple-made operating systems, you'll want Xcode with gcc.
  • If you're using Windows, I highly recommend TDM-GCC and and the IDE of your choice.
  • If you're using Linux, use your package-manager to set it up for you.
    • If you use a Linux distro with yum, check here
    • In apt-based distros, run apt-get install build-essentials

You will need a compiler that supports C++11

Target layout

G2CK will create an environment prepared for you to create games, components, deploy packages, etc. The resulting layout when running g2ck scripts is the following:

 - /top-level/
   - g2ck/:                    this folder with g2ck scripts
   - g2ck-build/:              g2ck build folder.
   - external/:                dependencies, tools, etc. Everything required but not found on your system will
                               be installed here.
   - games/:                   game folders created by means of g2ck (make new-game)

The G2CK build directory.

Make sure you have CMake and your build environment ready, you are going to need them.

Create a g2ck-build folder in the parent folder that this file is. Every interaction you'll do with G2CK will happen inside this folder.

After you're inside the g2ck-build, run cmake like this:

Linux and Mac:

cmake ../g2ck

Windows:

cmake -G "MinGW Makefiles" ../

First thing it will test if your environment is sane by compiling a test program. Then, iIt will output some status messages, whether you have gear2d or not, its version, etc. After this, you're ready for building Gear2D

Gear2D and dependencies

G2CK will check if you have Gear2D and Gear2D-Components already available. Manual installation of them will not be covered here, you might want to check the Gear2D website, maybe there's instructions there (maybe not?)

If you chose not to install Gear2D beforehand, not to worry. We'll do it for you.

Inside the g2ck-build, just type make. It will download and install all required dependencies and then download and install Gear2D and its components, all in the external folder.

Appendix

Dependencies

G2CK will build all the needed libraries, but it depends on your platform being ready to do so. This section provides a little help with some specific Linux distributions.

Fedora Core

You will need to install a list of packages to be able to properly compile and run Gear2D and its dependencies. These are the commands you will need to run (as root)

yum groupinstall 'Development Tools' 'C Development Tools and Libraries'
yum install gcc-g++ patch