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

# Rules

Instructions on configuring your server rules.

## <mark style="color:red;">▸ Server Rule Configuration</mark>

You are viewing the default website configured for your rules.

To change the website used to display your rules, open the navigation config file located in:

&#x20;            <mark style="color:blue;">**`lua\modules\pirithous\cfg\sh_cfg_03_nav.lua`**</mark>

## <mark style="color:red;">▸ Text-Only Rules</mark>

If you wish to use text for your rules instead of a website, open the config file mentioned above and edit the setting:

```lua
cfg.nav.btn.rules_textonly = true
```

## <mark style="color:red;">▸ In-game Browser VS Steam Overlay</mark>

This script has two ways to display websites.

<table><thead><tr><th width="301"></th><th></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Integrated In-Game Browser</strong></mark></td><td>Displays the website using the built-in window feature of Pirithous.</td></tr><tr><td><mark style="color:blue;"><strong>Steam Overlay</strong></mark></td><td>Opens the website using the Steam overlay browser</td></tr></tbody></table>

#### <mark style="color:yellow;">INTEGRATED BROWSER:</mark>

To enable the integrated browser instead of the Steam Overlay browser, open the configuration file:

&#x20;            <mark style="color:blue;">**`lua\modules\pirithous\cfg\sh_cfg_03_nav.lua`**</mark>

Change the following setting to&#x20;

```lua
cfg.nav.btn.rules_openIngame = true
```

When the player clicks a link, a new window will appear leading them directly to the website:

<figure><img src="https://153650087-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MOQZiOKV18NkkUtyHTF%2Fuploads%2FwnlDzHrt2XgRj1LP8vF3%2Fbrowser_integrated.png?alt=media&amp;token=6fcaaa78-5e64-4529-b35f-ab429b6b25e1" alt=""><figcaption><p>Integrated Browser</p></figcaption></figure>

{% hint style="info" %} <mark style="color:orange;">**Important Information:**</mark>

\
The integrated browser feature uses a built-in library that comes with Garry's Mod. Unfortunately, the library is extremely outdated and does not like modern websites.\
\
If you enable the integrated browser and notice that your websites are not showing properly, or you get a pure white page; then your website is not compatible with the garry's mod library. \
\
To correct this, you'll need to enable the <mark style="color:blue;">**Steam Overlay**</mark> browser\
[(See instructions below)](#steam-overlay)
{% endhint %}

#### <mark style="color:yellow;">STEAM OVERLAY:</mark>

To enable this script to use the Steam Overlay browser, open the configuration file:

&#x20;            <mark style="color:blue;">**`lua\modules\pirithous\cfg\sh_cfg_03_nav.lua`**</mark>

Change the following setting to&#x20;

```lua
cfg.nav.btn.rules_openIngame = false
```

When a player clicks on a link, they'll be shown a prompt:

<figure><img src="https://153650087-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MOQZiOKV18NkkUtyHTF%2Fuploads%2FY0nOczvIUWWkCTaLL47A%2Fbrowser_steamoverlay_1.png?alt=media&amp;token=288e71d6-0b79-427f-8da3-d4fbac81da7a" alt=""><figcaption><p>Steam overlay confirmation</p></figcaption></figure>

Once the player clicks **yes**, the website will be opened in steam:

<figure><img src="https://153650087-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MOQZiOKV18NkkUtyHTF%2Fuploads%2FQImOXoFz6TVIMj6Yn1y8%2Fbrowser_steamoverlay_2.png?alt=media&amp;token=212c8121-69fe-4d41-8723-5f4df93dceab" alt=""><figcaption><p>Steam overlay browser</p></figcaption></figure>
