> For the complete documentation index, see [llms.txt](https://organized-chaos.gitbook.io/organized-chaos-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://organized-chaos.gitbook.io/organized-chaos-docs/riftgate/overview.md).

# Overview

Waypoints players discover and travel between, and town portals to the nearest town. Four hand-built platforms, map blips and an in-game editor.

Riftgate adds waypoints and town portals to your server.

Players discover waypoints across the map by walking onto them: the runes light up and the waypoint is theirs. From then on they can travel between every waypoint they have found, from the waypoint menu. A town portal scroll opens a swirling portal in front of the player, with its twin in the nearest town: step in to cross, step back to return.

{% embed url="<https://www.youtube.com/watch?v=V5IRnxA5L_E>" %}
The preview video
{% endembed %}

## What you get

* **Four waypoint platforms**, modelled and textured by hand: a waystone, a marble dais, a gothic arch gate with a portal in it, and a shrine of standing stones.
* **Runes that light up** when a player discovers a waypoint, and glow at night.
* **Portals in four colours**: blue, red, gold and violet, each with spinning layers of energy and a rune circle on the ground.
* **The town portal scroll**: an inventory item with its own hand-held model.
* **A waypoint menu** with regions as tabs, and a **map blip** for every waypoint.
* **Place waypoints in game.** An admin form, no config editing, no restart.
* **Job and gang waypoints.** A police-only network, a gang hideout, a VIP spot.
* **No escape button.** Nobody travels or opens a portal while dead, handcuffed or in a fight.
* **Portals for your party.** Only the players with you when it opened can follow you through.
* **Discovery saved per character**, without a database.
* **Eight languages**: English, German, French, Spanish, Portuguese, Polish, Dutch and Italian.
* **Discord logging**, and exports and events for your own scripts.
* **Original sound effects** for travel, discovery, portals and the menu.

## The platforms

| Style           | Look                                                                        | Glow      |
| --------------- | --------------------------------------------------------------------------- | --------- |
| Waystone        | Square, weathered limestone, four rune posts crowned with crystals. 3.4 m.  | Blue      |
| Dais            | Three tiers of veined marble, a sigil inlaid in gold, four lanterns. 4.5 m. | Pale blue |
| Arch gate       | A 5 m gothic arch of basalt with a portal in the arch, and braziers.        | Ember red |
| Standing stones | A round shrine of slate with three leaning standing stones. 4.8 m.          | Teal      |

## Requirements

|               |                                                                                         |
| ------------- | --------------------------------------------------------------------------------------- |
| OneSync       | Required. It is on by default on txAdmin servers                                        |
| A framework   | Not needed. ESX, QBCore or Qbox for travel costs, jobs, gangs and the scroll item       |
| ox\_target    | Optional, to aim at platforms and portals. Without it players use the E key             |
| ox\_lib       | Optional, for notifications, the text UI and a progress circle while reading the scroll |
| ox\_inventory | Optional, for the scroll as an ox\_inventory item                                       |

## Where to go next

* [Installation](/organized-chaos-docs/riftgate/installation.md)
* [Waypoints](/organized-chaos-docs/riftgate/waypoints.md)
* [Town portals](/organized-chaos-docs/riftgate/town-portals.md)
* [Integrations](/organized-chaos-docs/riftgate/integrations.md)
* [Configuration](/organized-chaos-docs/riftgate/configuration.md)
* [Commands and permissions](/organized-chaos-docs/riftgate/commands-and-permissions.md)
* [Exports and events](/organized-chaos-docs/riftgate/exports-and-events.md)
* [Discord logging](/organized-chaos-docs/riftgate/discord-logging.md)
* [Troubleshooting](/organized-chaos-docs/riftgate/troubleshooting.md)