> For the complete documentation index, see [llms.txt](https://cylexdev.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cylexdev.gitbook.io/docs/cylex-housing/installation-and-configuration.md).

# Installation & Configuration

<details>

<summary>Step 1: Download Script</summary>

Log in to keymaster.fivem.net, click on "Granted Access" on the left side, search for \[cylex\_housing] and click Download on all the options that come up.

</details>

<details>

<summary>Step 2: Extract Zip</summary>

Unzip all the cylex\_housing zip folders you downloaded and create a folder \[housing] in the resources folder and unzip them all from the zip.

</details>

<details>

<summary>Step 3: Start Script</summary>

Open the server.cfg file in your server files. \
\
Add \
**start \[housing]**\
at the bottom of the file.

</details>

<details>

<summary>Step 4: Edit Script</summary>

**Open the cylex\_housing/shared/config.lua file.** \
Edit the parts in the image below according to your server. For example Your language setting, your inventory script, your clothing script. (The scripts in the next section are supported. If you do not have a script, you can open a ticket for me to add support via discord)

</details>

<figure><img src="https://2441530673-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtxqtJ91rcI0EHH3xURdT%2Fuploads%2FimyeSqqcmg1f6tHK3vc7%2Fcode.png?alt=media&amp;token=bd2988ec-6dca-4dcc-a877-d140edb7e51e" alt=""><figcaption></figcaption></figure>

<details>

<summary>Step 5: Change Framework</summary>

Open the **cylex\_housing/core/coreConfig.lua** file. \
\
Edit the **Framework** section according to your own framework.\
(Currently, the frameworks written on the right side are supported. If you are using an unsupported framework, you can open a ticket on discord and get support)

</details>

<details>

<summary>Step 6: Setting Webhooks</summary>

Open **cylex\_housing/shared/server\_config.lua**. \
\
In this section, you can specify to which discord webhook the will be sent for logging.

</details>