> For the complete documentation index, see [llms.txt](https://rtx-dev.gitbook.io/rtxdev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rtx-dev.gitbook.io/rtxdev/rtx-shell-creator/installation.md).

# Installation

Install RTX Shell Creator on your server.

This guide covers the **complete installation process** of RTX Shell Creator.

RTX Shell Creator is a **standalone resource** and needs **no database**.

***

## Before You Start

* You bought RTX Shell Creator on Tebex: <https://rtx.tebex.io/package/7763334>
* Ensure your server artifacts are up to date
* You downloaded the asset from the **CFX Asset Portal**

***

## Resource Setup

{% stepper %}
{% step %}

### Download

Download RTX Shell Creator from:\
<https://portal.cfx.re/assets/granted-assets>
{% endstep %}

{% step %}

### Place resources into your server

Put both resources into your server resources folder, for example into `resources/[rtx]/`:

```
resources/
└── [rtx]/
    ├── rtx_shellcreator_assets
    └── rtx_shellcreator
```

| Resource                  | What it is                                                                  |
| ------------------------- | --------------------------------------------------------------------------- |
| `rtx_shellcreator_assets` | The building kit models - walls, floors, doors, windows, stairs and details |
| `rtx_shellcreator`        | The shell creator itself                                                    |

The models live in their own resource, so `rtx_shellcreator` can be restarted at any time.

{% hint style="info" %}
If you own the **RTX Toolkit**, its `rtx_toolkit_assets` works too. You don't need both.
{% endhint %}
{% endstep %}

{% step %}

### Add to server.cfg

```cfg
ensure rtx_shellcreator_assets
ensure rtx_shellcreator

add_ace group.admin rtxshellcreator.admin allow
add_ace resource.rtx_shellcreator command.refresh allow
add_ace resource.rtx_shellcreator command.ensure allow
add_ace resource.rtx_shellcreator command.start allow
add_ace resource.rtx_shellcreator command.stop allow
```

* The first `add_ace` line gives your admins the shell creator.
* The other four let it **install and start** the shells you finish, and the walk mode preview, straight away.

{% hint style="warning" %}
Without the four `resource.rtx_shellcreator` lines everything is still saved, but you have to start finished resources yourself and walk mode cannot bake the shell. The server console prints the missing lines on start, and the Home screen shows them too.
{% endhint %}
{% endstep %}

{% step %}

### Set your framework and language

Open `config.lua`:

```lua
Config.Framework = "esx" -- "esx", "qbcore", "qbox" or "standalone"

Config.Language = "English"
```

| Framework          | Value          |
| ------------------ | -------------- |
| ESX                | `"esx"`        |
| QBCore             | `"qbcore"`     |
| QBox               | `"qbox"`       |
| Standalone / other | `"standalone"` |
| {% endstep %}      |                |

{% step %}

### Restart and open it

Restart your server and type in game:

```
/shellcreator
```

You can also set a key in `Config.Keys.open`.

<figure><img src="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FXegxRabCh1XcmPuwjppu%2Fshell-creator-editor-3d.webp?alt=media" alt="The editor"><figcaption><p>The editor is open - you are ready to build.</p></figcaption></figure>
{% endstep %}
{% endstepper %}

{% hint style="info" %}
Next: [Your First Shell](/rtxdev/rtx-shell-creator/guides/your-first-shell.md) - from `/shellcreator` to a finished shell in a few minutes.
{% endhint %}

***

## Who Can Use It

The shell creator is for admins only. A player can open it when **any** of these is true:

* the player has the ACE `rtxshellcreator.admin`
* the player's identifier is in `Config.Admins.identifiers`
* the player's framework group is in `Config.Admins.groups`

```lua
Config.AdminAce = "rtxshellcreator.admin"

Config.Admins = {
    groups = {"admin", "superadmin", "god"},
    identifiers = {},
}
```

The check is done on the server and lives in `IsAdminRTX` in `server/other.lua`, so you can change it to anything you want.

***

## Optional Settings

### Big shells

For very big shells, raise the object pool in `server.cfg` and `Config.Shells.maxparts` in `config.lua`:

```cfg
increase_pool_size "Object" 2000
```

```lua
Config.Shells.maxparts = 4000
```

### Doors in finished shells

If the doors of a finished shell do not swing, add this to `server.cfg`:

```cfg
setr game_enableDynamicDoorCreation "true"
```

***

## Your Data

Everything you build is saved in `rtx_shellcreator/data/`.

{% hint style="danger" %}
**Back up the `data` folder** with your server, and keep a copy of it when you update the resource. Your shells, their history and your templates are in it.
{% endhint %}

***

## Need Help?

If you get stuck during the installation, contact us on Discord and we will help you.

<a href="https://discord.gg/rtxdev" class="button primary">Join our Discord</a>