# Custom Module

**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.

{% hint style="info" %}
Learn more about the Module Manager [here](https://docs.gamecreator.one/game-creator/systems/module-manager).
{% endhint %}

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:

```
com.[company].[product-type].[product-name]
```

For example, the **bundleID** of the **Dialogue** module is `com.gamecreator.module.dialogue`. By using convention it's easier to avoid duplicate names. 

## Anatomy of a Module

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.

{% hint style="info" %}
If you are unfamiliar with [package managers](https://en.wikipedia.org/wiki/Package_manager), imagine the **Unity Package** is a **zip** file you can decompress to access its content.
{% endhint %}

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.

{% hint style="success" %}
The password of all Manifest files is **gamecreator** (lowercase and without any spaces).
{% endhint %}

![(Example of Manifest file)](https://2174264233-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LAqwYovmUPn5V6CMeID%2F-LCFLZ9s7iIdLLHrJMwB%2F-LCFL_in0NUkMUzPDD_2%2Fcustom-mm-manifest.png?alt=media\&token=0aa1fd8e-7c7c-4436-aa05-2b5db9bdaa9a)

After signing in the Manifest file you'll see all the Manifest options.

![(Custom Manifest file with testing values)](https://2174264233-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LAqwYovmUPn5V6CMeID%2F-LCFLZ9s7iIdLLHrJMwB%2F-LCFMW63gR7yAZwHGLGO%2Fcustom-mm-manifest-file.png?alt=media\&token=ccfc5667-fe4e-44e9-bd16-1e7a76ececac)

The Manifest can be broken down into 3 sections.

* The **Build Module** and **Logout** options.
* The **General Information**.
* The **Build Settings**.

### Build Module

The **Build Module** button allows you to pack the module into a `bundleid.unitypackage` file which can be found next to the **Manifest**.

{% hint style="warning" %}
The **Build Module** option will overwrite any existing Unity Package at that location.
{% endhint %}

The **Logout** option allows you to exit the Manifest editing mode.

### General Information

The General information includes the **Information**, **Version**, **Author**, **Dependencies** and **Tags** information.

#### 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.

#### Version

The version system is an incremental number. We follow the [Semantic Versioning 2.0 standard](https://semver.org/). This means that version are composed of three fields: **X.Y.Z** where

* **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.

{% hint style="danger" %}
On top of this, stable versions always start at **1.0.0**. A **major** version of **0** means that product is in **Beta** or **Alpha** phase and should not be used in production.
{% endhint %}

#### Author

Information about the creator of this module. Used for support inquiries.

#### Dependencies

Here you can list what modules are required to be installed before this module. You can also specify the minimum compatible version.

{% hint style="info" %}
Unless the **minimum dependency** requirements are met, a module won't be neither **installable** nor **updatable**.
{% endhint %}

#### Tags

Tags allow the module to be easily searched.

### Build Settings

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.

{% hint style="info" %}
**Data** is usually used when building an *example* module, which needs previously auto-generated data.
{% endhint %}

In **Game Creator** we publish all the **Logic** at `Assets/Plugins/GameCreator` directory and the **Data** inside `Assets/Plugins/GameCreatorData`.

## Example

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)](https://2174264233-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LAqwYovmUPn5V6CMeID%2F-LiD2J5RjnQ9yv3uDOCG%2F-LiDM0gpOq0y9Xc-dKxy%2Fcustom-module-overview.png?alt=media\&token=edb53382-bb2b-4fcf-9dc7-69de997b99d2)

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 **`Plugins/GameCreatorData/Modules/`**

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.

![](https://2174264233-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LAqwYovmUPn5V6CMeID%2F-LiD2J5RjnQ9yv3uDOCG%2F-LiDOPpfgX0FkMPRroKg%2Fcustom-module-package.png?alt=media\&token=dd4cbbb3-3ebd-49aa-bb3a-8e8fe575a407)

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/CatModule`** we use the path **`Assets/Plugins/CatModule/`** as the source of the module from where it will be built.

{% hint style="warning" %}
The **Code Paths** needs to start with the **`Assets/`** folder
{% endhint %}

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.

![](https://2174264233-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LAqwYovmUPn5V6CMeID%2F-LiD2J5RjnQ9yv3uDOCG%2F-LiDPdWWEmxUFB4-C6LN%2Fcustom-module-build.png?alt=media\&token=4950db7f-1031-403f-a29e-7dbd89703a92)

That's it! If you want to share this module with other users, right click on the **`com.gamecreator.module.cats`** folder and select Export Package. Make sure to **untick** the *Select Dependencies* checkbox.

![](https://2174264233-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LAqwYovmUPn5V6CMeID%2F-LiD2J5RjnQ9yv3uDOCG%2F-LiDQ4pbx3sN1j0eacjp%2Fcustom-module-export.png?alt=media\&token=66d8db56-8450-4703-b7c0-c42915c6a4ee)

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**.

{% hint style="success" %}
Download the Cats Module at the [Game Creator Hub](https://hub.gamecreator.io/content/item/gTG2VJna01L62qPW9MBZ).
{% endhint %}