Recommended Unity Version

Currently Game Kit Controller requires a minimum version of Unity 2017.1.0f3. You should not use an older version than this because Unity is not backwards compatible with older versions of Unity.

GKC will soon require a minimum Unity version of Unity 2019.4 LTS in a future update, keep an eye on the Discord or Changelog for more information on when this change will happen.

Game Kit Controller generally works with all newer LTS versions too (i.e. 2020 LTS), and they are officially supported. Support for pre-release versions of Unity will be limited due to their unstable nature.

Video Tutorials

If you're more of a visual learner or just looking for videos tutorials for Game Kit Controller check out our tutorials section which has lots of videos showing you different mechanics and how to get started with Game Kit Controller.

About this Documentation

The documentation is organised in a user friendly way. It is always advised you read first the Overview (i.e. the top most page of a section) page for each section, if it exists. Then you can decide to follow the guide from top to bottom or jump to between sections.

Throughout the documentation you'll come across hints, below we've provided a description of what each hint means and it's importance:

We are continually updating the Game Kit Controller documentation in an effort to ensure it's always remains current with the latest version of GKC. If you come across something that seems wrong, outdated or unclear please let us know on the Discord server and we'll be sure to get it improved as soon as possible.

Mixamo Animations

The action system can be used with any type of humanoid animation. To work on this system, example animations from Mixamo were used as placeholders to configure multiple examples of the action system. Due to Mixamo animations can’t be included on asset, you can find the animations used on these examples on the public repository of Game Kit Controller on Github.

https://github.com/sr3888/GKC-Public-Repository

These animations are already with the regular settings applied to work on root motion properly (like rotation based on current pose, loop time, adjust speed, etc…). No extra setting is needed to try these examples.

All those animations and copyrights belong to Mixamo. You can get those animations and more at the official website of Mixamo: https://www.mixamo.com/#/

Of course, on this action system, you can use your own animations, from the asset store or any other store or web.

Slice System

There are a couple of systems in the asset that uses a slice system for 3d meshes and skinned mesh renders, for the melee weapon system, allowing to cut surfaces and characters, similar to games like metal gear rising. Those systems can be found in the public repository of GKC, which is the same limb from a few lines above.

You only need to import those 2 packages and open the script file called sliceSystemUtils.cs and uncomment all the commented lines on that script, in order to use the slice system. This is not mandatory to be done if you won’t use the slice system in any part of your project.

Step #1: New Project or Existing Project

New Project

If you are importing GKC into a new project then all you need to do is import the package and leave everything checked. That's it, you can skip the rest of this page, you're good to start making the game of your dreams!You can move onto the next section using the button below.

Existing Project

If you are importing GKC into an existing project then you'll need to uncheck the option to import the project settings and then continue onto Step #2.

Step #2: Add Key Mappings to the Input Manager

When importing GKC into an existing project, or if you imported GKC without the project settings then you'll need to add the axes below into the Unity Input Manager (Edit > Project Settings > Input Manager) if you want to support using a gamepad.

These are the key mappings for four players when using local multiplayer (i.e. same screen multiplayer), but you can add just one if you are not going to use the local multiplayer functionality in your game.

The key mapping values for each input above are identical for each the variant (i.e. player/input), only the variant names and the joystick number are different. For example Horizontal X1 has the same values as Horizontal X2, X3 and X4 with only the input "Name" and "Joy Num" being different. On Horizontal X1 the Joy Num is Joystick 1, whereas on Horizontal X2 the Joy Num is Joystick 2 etc. For the full breakdown of input values, you can check out the "Full Breakdown" tab of each section below.

Horizontal X and Vertical Y

Mouse X and Mouse Y

Left Trigger and Right Trigger

DPad X and DPad Y

Mouse Left Click

After finishing adding the above key mappings then you will have the input for four players configured. This will allow up to four players to use the local multiplayer system.

Step #3: Add Tags and Layers

When importing GKC into an existing project, or if you imported GKC without the project settings then you'll need to add the tags and layers used by this asset.

You can add the below tags and layers by going into the Unity Tags and Layers settings (Edit > Project Settings > Tags and Layers).

Tags

Layers