Get Started
Get started with the GS_Play Gameplay Framework!
Installation
- Download GS_Play_Core Gem
- Download Desired Feature Gems
- Register Gems to Project Manager
- Enable Gems in Project Settings
- Add Gem Dependencies to Project’s Gem/cmakelists file.
For full Installation Details, check out the Installation Page.
About GS_Core
In order to deliver a consistent and full featured framework of tools, we have chosen to create a universally used core featureset. This houses common components, patterns, and utilities, that allow for each Featureset to work consistently, and deliver common functionality between all featuresets, established by the Core.
All GS_Play Modules have a GS_Play_Core dependency. Read more about GS_Play_Core dependencies in the Installation Page.
Read more about GS_Play_Core in the Core Documentation.
1 - Configure Project
Configure Project to run GS_Play.
Install Gems
Add Project Dependencies
cmakelists: package build targets
<ProjectGemName>.Private.Object STATIC
BUILD_DEPENDENCIES
PUBLIC
Gem:GS_Play_Core.API
Gem:GS_<your desired module>.API
Setup Project Environment
Environment Setup
Setup GameManager
Begin Using GS_Play!
1.1 - Setting Up the Physics Environment
Setting up your Physics Environment
These are the necessary details to create your project and have it run reliably with all GS_Play featuresets.
Physics
Image showing the standard PhysX Configuration necessary to support all GS_Play features.
Collision Layers
Image showing the standard PhysX Collision Layers necessary to support all GS_Play features.
NoCollision Layer
Environment Layer
Doodad Layer
Trigger Layer
Unit Layer
Pulse Layer
Interact Layer
Regions Layer
Collision Groups
Image showing the standard PhysX Collision Groups necessary to support all GS_Play features.
UnitGrounding Group
Triggering Group
Pulse Group
Doodad Group
Interact Group
AllButEnviro Group
OnlyRegions Group
Set Ground Collision Layer
In order to properly introduce a GS_Unit to the default scene you need to create an object with the “Environment” collision layer to stand on.
The easist way to start is to change the collision layer of the default “Ground” entity in the level.
2 - Prepare Managers
Prepare Managers to run GS_Play.
Start Creating Manager Prefabs
- Blank Entity
- Create Prefab
- Add to Game Manager
Begin Gameplay Setup
3 - Prepare Startup
Prepare Startup to run GS_Play.
Start Creating Manager Prefabs
- Blank Entity
- Create Prefab
- Add to Game Manager
Begin Gameplay Setup
4 - Prepare Camera
Prepare Camera to run GS_Play.
Start Creating Manager Prefabs
- Blank Entity
- Create Prefab
- Add to Game Manager
Begin Gameplay Setup
5 - Prepare Gameplay
Prepare Gameplay to run GS_Play.
Start Creating Manager Prefabs
- Blank Entity
- Create Prefab
- Add to Game Manager
Begin Gameplay Setup
6 - Full Set Up Guides
Setting up the many Features of GS_Play Gameplay Framework.
Introduction
Using the Set Up Guides
Refer to Feature Lists of Gem Modules
Refer to Documentation for specific feature modules.
Use the guides to get started using the feature and its interrelated components.
6.1 - Core Set Up
Setting up the GS_Core Features.
Introduction
What the Core Gem is and does.
Setting Up GameManager for Gameplay/Startup Handling
Setting Up Managers
Setting Up the Options System
Settings Up the Save System
Settings up the Stage Management System
6.2 - Cinematics Set Up
Setting up the GS_Cinematics Features.
Introduction
What the Cinematics Gem is and does.
Setting Up Dialogue Editor System
Setting Up Timeline Features System
6.3 - Interaction Set Up
Setting up the GS_Interaction Features.
Introduction
What the Interaction Gem is and does.
Setting Up Targeting System
Setting Up World Trigger System
Setting Up Pulse System
6.4 - Phantom Cam Set Up
Setting up the GS_PhantomCam Features.
Introduction
What the Phantom Cam Gem is and does.
Setting Up Camera Manager
Setting Up Camera Core
Setting Up Phantom Cameras
6.5 - UI Set Up
Setting up the GS_UI Features.
Introduction
What the UI Gem is and does.
Setting Up UI Manager
Creating UIs
Handling Multiple UIs in Gameplay
6.6 - Unit Set Up
Setting up the GS_Unit Features.
Introduction
What the Unit Gem is and does.
Setting Up Unit Manager
Setting Up Unit Controllers
Setting Up a Unit for Control
Using Movers and Grounders