# Install

## ❱ Requirements

Ensure that you download and install a copy of **rlib** on your server. If you have not yet done this, please follow these instructions:

* Go to [**https://get.rlib.io/**](https://get.rlib.io/) and download the latest version of **rlib**. <br>
* **Extract** the downloaded zip to your computer<br>
* **Create** a new folder on your gmod server called **rlib**
  * *Example: garrysmod/addons/**rlib**/*<br>
* **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;                           📁 **rlib**\
&#x20;                                📁 lua\
&#x20;                                📁 materials

* **Restart** server<br>
* As the server restarts, **view** console **for errors**.&#x20;
  * **If you see errors:** contact the developer with a list of them.
  * **If you do not see errors:** proceed forward<br>
* In the server console, type **rlib.version** and it should display the running version on your server. If you it display the version, proceed to the [**Download & Extraction**](#download-and-extraction) section of this tutorial.

## ❱ Download & Extraction

* Download a copy of **Jasper** to your computer. Downloads will come as a **.zip file** which needs to then be extracted to your compute&#x72;**.**<br>
* **Create** a new folder on your **Desktop** and name it **jasper**. <br>
* **Extract** the addon zip file into this new folder you have created.
  * You may use [**WinZip**](https://www.winzip.com/win/en/), [**7-Zip**](https://www.7-zip.org/), or [**WinRAR**](https://www.rarlab.com/) to extract the file.<br>
* Locate the `addons` folder of your gmod server and create a sub-folder for your addon. Ensure that the new folder you create conforms with the following rules:
  * must **not** contain **spaces**
  * must **not** contain **special characters** *( $ % ^ & )*
  * must **not** contain **uppercase** *( capitalized )* characters
  * must **only** contain **alphanumerical characters** *( a-z, 0-9 )* OR **underscores** *( \_ )*

Examples of acceptable paths / folder names are provided below:

```
garrysmod/addons/name_of_addon
garrysmod/addons/nameofaddon
```

{% hint style="danger" %}
Not following these folder name rules may result in your server skipping the addon folder all-together and not loading it. Different server operating systems accept ways of naming folders/files.
{% endhint %}

* After creating the new server folder; open the folder you created on your desktop and upload everything within the folder to your new addons folder.  Do not upload the desktop jasper folder itself otherwise you'll have the addon too many folders deep.
  * Desktop/jasper  =>  garrysmod/addons/jasper<br>
* After upload is complete, your server should have the following structure:

&#x20;                   📁 garrysmod\
&#x20;                       📁 addons\
&#x20;                           📁 **jasper**\
&#x20;                                📁 lua\
&#x20;                                📁 materials\
&#x20;                                📁 resource

* **Restart** server<br>
* As the server restarts, **view** console **for errors**.&#x20;

  * **If you see errors:** contact the developer with a list of them.
  * **If you do not see errors:** proceed to [**Initialization**](#initialization)

  <br>

## ❱ Initialization

After you've confirmed the addon is installed, you may now connect to your server and test that it is working. How your addon activates depends on what type of addon you have installed.

You can proceed to the [**Configuration** ](https://jasper.rlib.io/setup/broken-reference)page to learn more about how you can customize your addon.