> For the complete documentation index, see [llms.txt](https://xtask.rlib.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://xtask.rlib.io/setup/install.md).

# Install

Instructions for installing this addon.

## <mark style="color:red;">▸ Requirements</mark>

* Download the <mark style="color:blue;">**addon**</mark> purchased from gmodstor**e**
* Download or subscribe to <mark style="color:blue;">**rlib library**</mark>

## <mark style="color:red;">▸ Install Rlib</mark>

To install rlib, you can either manually download the script, or you can add the rlib workshop to your server's workshop collection. `Do not do both:`

<mark style="color:yellow;">`Select One:`</mark>

<table data-header-hidden><thead><tr><th width="297"></th><th></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Workshop Collection</strong></mark></td><td><a href="https://steamcommunity.com/sharedfiles/filedetails/?id=2953724703"><strong>Subscribe Here</strong></a></td></tr><tr><td><mark style="color:blue;"><strong>Manual Download</strong></mark></td><td><a href="https://get.rlib.io/"><strong>Download Here</strong></a></td></tr></tbody></table>

<details>

<summary><mark style="color:blue;">[ Option 1 ]:     Install rlib with workshop collection</mark></summary>

#### <mark style="color:yellow;">▸ WORKSHOP COLLECTION</mark>

If you want to subscribe to the rlib workshop collection instead of manually installing, [**visit the workshop here**](https://steamcommunity.com/sharedfiles/filedetails/?id=2953724703), and subscribe with the instructions below:

<img src="https://4278373638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LfFHG-Ci09gjQjjmdgE%2Fuploads%2FG5c5WVAIDUTmVC4f1w01%2Frlib_ws_install_0.png?alt=media&amp;token=cc2f9f24-c9ba-48df-87d1-b3a1ff85cca8" alt="" data-size="original">

* At the bottom of the cover image on the workshop page, select <img src="https://4278373638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LfFHG-Ci09gjQjjmdgE%2Fuploads%2FXRnXAywfN3BDISgLQl6b%2Frlib_ws_install_00.png?alt=media&amp;token=a81f851f-c6d4-40c3-a885-02c90e843b31" alt="" data-size="line">

![](https://4278373638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LfFHG-Ci09gjQjjmdgE%2Fuploads%2FzG3Irie2WXD2njehhgl6%2Frlib_ws_install_000.png?alt=media\&token=4dfa7458-3612-4716-9eda-3a032ac28064)

* Place a ![](https://4278373638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LfFHG-Ci09gjQjjmdgE%2Fuploads%2FhOCsN8HNIm41i45FrFKk%2Frlib_ws_install_01.png?alt=media\&token=b4b80f4b-a5ed-46df-aac7-016176c365e7) checkmark next to your server's workshop collection and press <img src="https://4278373638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LfFHG-Ci09gjQjjmdgE%2Fuploads%2FXCKzcq420OzE3U0ieSaV%2Frlib_ws_install_02.png?alt=media&amp;token=78e637d8-5c35-4ca4-9014-5834c856bef0" alt="" data-size="line">
* Restart your gmod server and rlib will automatically be installed
* Once you connect to your server and have superadmin; type <mark style="color:yellow;">**`?setup`**</mark> in chat.

</details>

<details>

<summary><mark style="color:blue;">[ Option 2 ]:     Install rlib manually</mark></summary>

#### <mark style="color:yellow;">▸ MANUAL INSTALL</mark>

* Go to [**https://get.rlib.io/**](https://get.rlib.io/) and download the latest version of **rlib**.&#x20;
* **Extract** the downloaded zip to your computer
* **Create** a new folder on your gmod server called <mark style="color:red;">**rlib**</mark>
  * *Example: garrysmod/addons/<mark style="color:red;">**rlib**</mark>/*
* **Upload** the extracted rlib zip files to the newly created folder.&#x20;
  * Ensure you are uploading the files to match the following file structure:

&#x20;                   📁 garrysmod\
&#x20;                       📁 addons\
&#x20;                           📁 <mark style="color:red;">**`rlib`**</mark>\
&#x20;                                📁 lua\
&#x20;                                📁 materials\
&#x20;                                📁 resource

* **Restart** the server
* As the server restarts, **view** the console **for errors**.&#x20;
  * If you see errors, contact the developer with a list of them.
  * If you do not see errors, proceed forward
* Once you connect to your server and have superadmin; type <mark style="color:yellow;">**`?setup`**</mark> in chat.

</details>

## <mark style="color:red;">▸ Install Addon</mark>

Download the addon's ZIP from the link below:

{% embed url="<https://www.gmodstore.com/market/view/xtask-achievements>" %}

* **Extract** the download zip to your computer
* **Create** a new folder on your gmod server called the name of the addon
  * Make sure the folder name contains **NO SPACES**, **NO SPECIAL CHARACTERS**, and **NO CAPS**
  * *Example:  garrysmod/addons/**xtask***
* **Upload** the extracted addon files to the newly created folder
  * Upload the files to match the following file structure:

&#x20;                   📁 garrysmod\
&#x20;                       📁 addons\
&#x20;                           📁 <mark style="color:red;">**`xtask`**</mark>\
&#x20;                                📁 lua\
&#x20;                                📁 materials\
&#x20;                                📁 resource

* **Restart** the server
* As the server restarts, **view** the console **for errors**.&#x20;
  * If you see errors, view [**Script Throwing Errors**](/untitled/script-errors.md)
  * If you do not see errors, proceed forward

## <mark style="color:red;">▸ What's Next?</mark>

Try some of the links below:

* [Subscribe to the client workshop collection for fonts, resources, sounds, etc.](/setup/workshop.md)
* [Manually host static and live wallpapers](/setup/docs-web.md)
* [Translate your addon](/configuration/languages.md)