> For the complete documentation index, see [llms.txt](https://grp-development.gitbook.io/solid-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://grp-development.gitbook.io/solid-scripts/resources/solid-shellcreator/installation.md).

# Installation

Get SOLID Shell Creator running in a few minutes.

{% stepper %}
{% step %}
**Download**

Download `solid-shellcreator` from [portal.cfx.re](https://portal.cfx.re/) under Assets > Granted Assets. It needs the free `solid-bridge`, so update the bridge to its latest version too.
{% endstep %}

{% step %}
**Add it to server.cfg**

Start `solid-bridge` after your framework, then `solid-shellcreator`.

{% code title="server.cfg" %}

```cfg
ensure solid-bridge
ensure solid-shellcreator
```

{% endcode %}

{% hint style="warning" %}
Keep the folder name `solid-shellcreator`.
{% endhint %}
{% endstep %}

{% step %}
**Give your admins access**

Framework admins can use `/shellcreator` by default. For an ace instead, add:

{% code title="server.cfg" %}

```cfg
add_ace group.admin solidshell.admin allow
```

{% endcode %}
{% endstep %}

{% step %}
**Optional: bake helper**

Only needed for ps-housing, qbx\_properties and esx\_property, which load a shell by model name. Download `solid-shellbake` too, start it after the creator and let it create the shell resources:

{% code title="server.cfg" %}

```cfg
ensure solid-shellbake
add_ace resource.solid-shellbake command.refresh allow
add_ace resource.solid-shellbake command.ensure allow
add_ace resource.solid-shellbake command.start allow
add_ace resource.solid-shellbake command.stop allow
```

{% endcode %}

Baked shells are saved as resources in a `[solid-shells]` folder next to the creator and start by themselves.
{% endstep %}

{% step %}
**Restart and build**

Restart the server. The database tables are created on the first start. Type `/shellcreator`, press **New** and pick a template or an empty plot.

{% hint style="info" %}
For in-game photos of your shells, run `screenshot-basic`. Without it you upload a picture or paste a link instead.
{% endhint %}
{% endstep %}
{% endstepper %}

#### How to update

{% stepper %}
{% step %}
**Download the new version**

The server console tells you when an update is out. Get it from [portal.cfx.re](https://portal.cfx.re/).
{% endstep %}

{% step %}
**Replace the folder**

Delete the old folder and drop in the new one. Copy over your `config.lua`, `config` folder, your `edits` changes and your own `locales` changes. Shells, versions, templates, pictures and teleporters are saved in the database and stay.
{% endstep %}

{% step %}
**Restart the server**
{% endstep %}
{% endstepper %}