-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Compiling framework
To build the gameplay library, tools, and samples as well as write your own games, you will have to install and use the platform specific tools.
Before you get started you will have to download the dependencies separately:
These are the supported development environments for each specific operating system as a target platform.
| Desktop OS | Tool | Development environment |
|---|---|---|
| Microsoft Windows | Visual Studio | Windows |
| Apple MacOS X | Xcode | MacOS X |
| Linux Ubuntu | CMake | Linux |
| Mobile OS | Tool | Development environment |
|---|---|---|
| iOS | Xcode | MacOS X |
| Android | Android NDK | Linux, Windows, MacOS X |
Listed below are the basic setup instructions for downloading and installing the supported platform and development environments for gameplay.
- Visual Studio (Windows)
- Apple Xcode (MacOS X, iOS)
- Linux (Ubuntu)
- Android NDK (Android)
Included in the project repository are the following notable folder and files:
| Folder/Files | Description |
|---|---|
| /api | Doxygen API Reference |
| /bin | Precompiled binary tools |
| /external-deps | External dependency libraries |
| /gameplay | The gameplay library |
| /samples | Game samples |
| /template | Game samples template project files |
| /tools | content authoring encoder and lua binding generator |
| install.bat/.sh | Needed to download external-deps and bin files for developing. |
| newproject.bat/.sh | New cross-platform project script |
The quickest way to get started using the gameplay framework and tools is to simply start working in one of the desktop environments.
You could use:
- Microsoft Visual Studio Express or Professional on a Windows
- Xcode on Apple MacOS X
Just open either gameplay.sln or gameplay.xcworkspace.These solutions/workspaces are set up by default to build all the projects needed and to run the samples you have selected as active.
Now that you are up and running on one of the desktop environments, we recommend you take this seriously and go mobile! In today's mobile game market, cross-platform development is a reality. It is quite simple and easy to use the gameplay framework to target a wider device audience. Start by downloading the native development kit for one of the various supported mobile operating system targets or set them all up.
Ensure that you test early on the physical devices. Depending on the type of game you want to write and on your design ideas, you'll want to get some idea of what type of performance you'll get with the game plan and prototypes you are working towards. Be careful and do not to rely on desktop and mobile simulators as an indicator of performance or mobile device capabilities.
We firmly believe in making a very intuitive set of APIs that are as straight-forward and as consistent as possible. However, all of the classes in the framework have been well documented with Doxygen formatting. The classes will be updated and improved iteratively throughout each release. This is to help you learn about what classes or sets of functions can be used and the recommended practices in using them.
You should consider reading the latest versions of the API reference from the pre-generated HTML Doxygen API documentation in the gameplay-api folder. This will give you a deeper understanding of the C++ gameplay framework.