Game Creator comes with a dependency manager called Module Manager. It allows to add, remove and seamlessly update extensions that add new features to our core product.
All Modules are located at
Plugins/GameCreatorData/Modules/. Modules are identified by a unique name or bundleID. You can name bundles however you want, but we recommend following the pattern:
For example, the bundleID of the Dialogue module is
com.gamecreator.module.dialogue. By using convention it's easier to avoid duplicate names.
A module is composed of two files. The Unity Package and the Manifest file.
The Unity Package contains all the assets and scripts of the module. It also knows where the files should be routed when updating or installing the module.
The Manifest file contains the rest of the information relative to the specific module. Manifest files are password protected so that inexperienced users don't accidentally mess with them.
(Example of Manifest file)
After signing in the Manifest file you'll see all the Manifest options.
(Custom Manifest file with testing values)
The Manifest can be broken down into 3 sections.
- The Build Module and Logout options.
- The General Information.
- The Build Settings.
The Build Module button allows you to pack the module into a
bundleid.unitypackagefile which can be found next to the Manifest.
The Logout option allows you to exit the Manifest editing mode.
The General information includes the Information, Version, Author, Dependencies and Tags information.
Here you can modify the name, description and bundle id and more. You can freely alter any of these fields (but bundle-id) without any further consequences.
- X - Major version. Complete overhaul of major systems.
- Y - Minor version. New features are added. Might need to take some config steps when upgrading.
- Z - Patch version. Does not contain new features. Fixes errors from the last minor version.
Information about the creator of this module. Used for support inquiries.
Here you can list what modules are required to be installed before this module. You can also specify the minimum compatible version.
Tags allow the module to be easily searched.
The Build Settings are the most important part of the Module Manifest. They tell which parts are included in the package and which aren't.
Since version 0.5.1 Game Creator assets are split in two: The Logic and the Data.
The Logic includes scripts and all the assets that must be shipped with Game Creator in order to work. A module must always include at least one asset (either a script, a 3D model, ...).
The Data is usually auto-generated information, such as script instances. Data is usually excluded from the build as it would overwrite other user's existing data.
In Game Creator we publish all the Logic at
Assets/Plugins/GameCreatordirectory and the Data inside
Let's see how to create a fictional module and distribute it. But before we begin, let's see what our package does.
(CatsModule allows to search for Kittens)
Our module is called CatModule and places a button at the top toolbar that allows you to take a break from work and relax watching some kitten's images.
The code is placed inside the Plugins/CatModule folder.
To distribute this module we'll need to create a manifest file at the installation path and fill its information so it knows what's going to be included in the module. The installation path can be found at
Let's create a new folder and call it
com.gamecreator.module.cats. This is called Bundle ID (or module ID) and is used to uniquely identify this module across others.
We'll also create a Package file and name it with the same bundle id, like in the following screenshot.
Fill in the information from above. Pay special attention to the Code Paths property. We want to add the paths from where our module will be built from. Since our Cat Module is under
Plugins/CatModulewe use the path
Assets/Plugins/CatModule/as the source of the module from where it will be built.
Now that our package knows where to build the module from, let's click on "Build Module" and wait for some seconds. We'll see that a new file has appeared below our manifest with the same name. This is like a .zip that contains everything inside the Code Paths folder/s.
That's it! If you want to share this module with other users, right click on the
com.gamecreator.module.catsfolder and select Export Package. Make sure to untick the Select Dependencies checkbox.
Click on Export... and you'll be prompted to select a folder where to export the module. Installing this package on any Unity project with Game Creator will allow the user to enable it using the Module Manager.