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

# Overview

What RTX Minigolf is and what it can do.

### ⛳ Mini Golf For Your FiveM Server

👉 **Purchase on Tebex:**\
<https://rtx.tebex.io/package/7811022>

🎬 **Preview video:**\
<https://www.youtube.com/watch?v=A3XYeAEIR8A>

<figure><img src="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2Fyms3NTDTM1KDtcGeS4xR%2Frtx-minigolf-sunset-on-the-course.webp?alt=media" alt="RTX Minigolf course on Vespucci Beach at sunset"><figcaption><p>Sunset on the Vespucci Beach Minigolf course.</p></figcaption></figure>

***

## What is RTX Minigolf?

**RTX Minigolf** is a complete minigolf system for FiveM.

Players walk up to a course, pick a game mode and putt their way through every hole with real ball physics, cameras that follow the ball, a live score card and leaderboards. Admins build new mini golf courses right in the game with the **course creator** - ramps, waves, loops, windmills, castles and 32 ready holes - and put them anywhere on the map, with no restart and no config editing.

It is designed to be:

* fun for players - real putting, real physics and up to 8 players in one match
* easy for admins - build a whole course in a few minutes, right in the game
* fully synchronized - every putt is decided by the server, every player sees the same roll
* safe - works with `sv_entityLockdown "strict"`, nothing to whitelist, nothing to cheat
* light - no database, nothing networked, courses are only spawned near players

{% embed url="<https://www.youtube.com/watch?v=A3XYeAEIR8A>" %}

***

## Vespucci Beach Minigolf Map Included

RTX Minigolf ships with its own map: a **fenced mini golf ground on Vespucci Beach** with paths, palm trees, flowers, lights and its own **Los Santos Beach Mini Golf kiosk**.

<figure><img src="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FSxQMty5sT3KNk4twSjM6%2Frtx-minigolf-kiosk.webp?alt=media" alt="Los Santos Beach Mini Golf kiosk"><figcaption><p>The Los Santos Beach Mini Golf kiosk at the entrance of the map.</p></figcaption></figure>

A ready **12-hole course, Vespucci Beach Minigolf (par 43)**, is built on it - windmills, a loop, a castle, ramps, waves and tricky corners - ready to play the moment your server starts.

The map is in `rtx_minigolf_props` and is always loaded. Change the course in the creator like any other, or clear it and build your own on the same ground.

More: [Vespucci Beach Minigolf Map](/rtxdev/rtx-minigolf/guides/vespucci-beach-minigolf-map.md)

***

## Standalone & Framework Support

RTX Minigolf is a **standalone resource**.

### Supported out of the box:

* **ESX**
* **QBCore**
* **QBox**
* **Standalone** (ACE and identifiers)

The framework is used for money (price, stakes, rewards), items and the admin groups of the creator. Money, items and admin checks are open-source in `server/other.lua`, so any other framework plugs straight in.

***

## How It Works

{% stepper %}
{% step %}

### Walk up

Walk to the start of a course and press **E**. The menu shows the course record, your best, the four game modes, the ball, the stroke limit and the aim guide.

<figure><img src="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FGSr9559CGPFPKfPPMzLo%2Frtx-minigolf-course-menu.webp?alt=media" alt="The minigolf course menu"><figcaption><p>The course menu - record, your best, game modes and match settings.</p></figcaption></figure>
{% endstep %}

{% step %}

### Putt

Step up to your ball, aim with the mouse, pull back for power and let go. The camera follows your ball all the way to the cup.

<figure><img src="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2F8hTjhoUxtucYAPTEr50i%2Frtx-minigolf-aim-guide.webp?alt=media" alt="Aiming a putt with the aim guide"><figcaption><p>The aim guide shows the real roll of the ball while you aim.</p></figcaption></figure>
{% endstep %}

{% step %}

### Play together

Open a lobby and invite the players standing nearby. Up to 8 players take turns, play together or play for money.

<figure><img src="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FiXTp1IJ8ybYkDpY66AMU%2Frtx-minigolf-lobby.webp?alt=media" alt="Minigolf lobby with invited players"><figcaption><p>A lobby - invite the players standing near you and start the match.</p></figcaption></figure>
{% endstep %}

{% step %}

### Build your own

Type `/minigolfcreator`, start a course where you stand and put down the tee, the lanes and the cup - or a whole ready hole with one click. Save it and it is live for everyone.

<figure><img src="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FeGeHGsohhOSRMqdwjBbN%2Frtx-minigolf-course-creator.webp?alt=media" alt="The minigolf course creator"><figcaption><p>The course creator - every piece snaps onto the open end of the lane.</p></figcaption></figure>
{% endstep %}
{% endstepper %}

***

## Features

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Real putting</strong></td><td>Aim guide, two power controls, cameras and real ball physics.</td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FOc0dLNWvBh6SN9pKoOkU%2Frtx-minigolf-power-bar.webp?alt=media">rtx-minigolf-power-bar.webp</a></td><td><a href="/rtxdev/rtx-minigolf/guides/putting-aim-and-cameras.md">Putting, Aim &amp; Cameras</a></td></tr><tr><td><strong>4 game modes</strong></td><td>Turns, Together, Solo and Practice any hole.</td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FAUSEdXXHM3Pg7pk2KCXZ%2Frtx-minigolf-four-game-modes.webp?alt=media">rtx-minigolf-four-game-modes.webp</a></td><td><a href="/rtxdev/rtx-minigolf/guides/game-modes-and-matches.md">Game Modes &amp; Matches</a></td></tr><tr><td><strong>Play together</strong></td><td>Up to 8 players, lobbies, invites, stakes and a rematch.</td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2F9ZK45qWkUEbITlpPRwBO%2Frtx-minigolf-rooftop-multiplayer.webp?alt=media">rtx-minigolf-rooftop-multiplayer.webp</a></td><td><a href="/rtxdev/rtx-minigolf/guides/game-modes-and-matches.md">Game Modes &amp; Matches</a></td></tr><tr><td><strong>Score card &#x26; banners</strong></td><td>Live hole card, birdie, eagle, hole in one and lip out.</td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FliFre0DBwktq625JnWn9%2Frtx-minigolf-birdie-banner.webp?alt=media">rtx-minigolf-birdie-banner.webp</a></td><td><a href="/rtxdev/rtx-minigolf/guides/playing-minigolf.md">Playing Minigolf</a></td></tr><tr><td><strong>Leaderboards</strong></td><td>All time, month and week, hole records and player stats.</td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FFQIYrcRMB01jjWVVwHXn%2Frtx-minigolf-leaderboard-and-records.webp?alt=media">rtx-minigolf-leaderboard-and-records.webp</a></td><td><a href="/rtxdev/rtx-minigolf/guides/leaderboards-and-fair-play.md">Leaderboards &amp; Fair Play</a></td></tr><tr><td><strong>Course creator</strong></td><td>Build whole courses in the game, every piece snaps into place.</td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FNa3m0YCSYNDWOW3GL1kZ%2Frtx-minigolf-slopes-and-waves.webp?alt=media">rtx-minigolf-slopes-and-waves.webp</a></td><td><a href="/rtxdev/rtx-minigolf/guides/the-course-creator.md">The Course Creator</a></td></tr><tr><td><strong>32 ready holes</strong></td><td>A whole playable hole with one click, or the path tool.</td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FDWq9aIntA1yJXf6Oe5bs%2Frtx-minigolf-ready-holes.webp?alt=media">rtx-minigolf-ready-holes.webp</a></td><td><a href="/rtxdev/rtx-minigolf/guides/ready-holes-and-path-tool.md">Ready Holes &amp; Path Tool</a></td></tr><tr><td><strong>Windmills, loops &#x26; colours</strong></td><td>Ramps, waves, a bridge, 8 obstacles and 17 colours.</td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FRnpgTKV0y2z4kzZYMOe7%2Frtx-minigolf-windmills-and-loops.webp?alt=media">rtx-minigolf-windmills-and-loops.webp</a></td><td><a href="/rtxdev/rtx-minigolf/guides/pieces-obstacles-and-colours.md">Pieces, Obstacles &amp; Colours</a></td></tr><tr><td><strong>Run it as a business</strong></td><td>Give a course to a job and earn from every round.</td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FPcBtwFwo6KbVyXT8Vm8v%2Frtx-minigolf-run-by-a-job.webp?alt=media">rtx-minigolf-run-by-a-job.webp</a></td><td><a href="/rtxdev/rtx-minigolf/guides/running-a-course-as-a-business.md">Running a Course as a Business</a></td></tr></tbody></table>

* **4 game modes** - Turns, Together, Solo and Practice
* **Up to 8 players** in one match, up to 6 matches on one course at the same time
* **Lobbies and invites** - invite the players standing nearby, they accept with one key
* **Real ball physics** - ramps and waves pull the ball, rails bounce it, windmill sails knock it back, the loop needs speed, a fast ball lips out
* **Aim guide** that simulates the real roll of the ball, bounces included
* **Two power controls** - pull back or timing bar, every player picks their own
* **3 balls** - Normal, Heavy and Heavier
* **Cameras** - hole fly-over, aim camera, overhead camera and ball camera
* **Live hole card** with par, strokes, total, score to par, distance to the cup and a shot clock
* **Banners** for hole in one, albatross, eagle, birdie, par, bogey, lip out and your turn
* **Leaderboards** for all time, this month and this week, a record for every hole and player stats
* **Price, stakes and rewards** - a price per round, money on the match, rewards for wins and records
* **In-game course creator** - up to 36 holes per course, every piece snaps to the lane by itself
* **32 ready holes**, a **path tool** and **piece by piece** building
* **Track kit** - straights, turns, corners, 3 ramps, 2 waves, a bridge, a windmill, a loop and 8 obstacles
* **17 colours** for the course, a hole or a single piece
* **Decorations** - benches, plants, lamps, parasols or any prop by its model name
* **Course list** - teleport, edit, copy, move a whole course to where you stand, trash with restore
* **Copy a course as Lua or JSON** and import it on another server
* **Run a course as a business** with a job and a society account
* **Player courses** with a kit item and admin approval
* **Spectators** see every ball and every putt near a course
* **Fair play** - suspicious rounds are kept off the leaderboards and logged
* **3D sounds** for every putt, rail, obstacle, windmill and cup
* **Vespucci Beach Minigolf map** with a ready 12-hole course
* **18 languages**

***

## Fully Synchronized

Every putt is decided by the server. The player sends only the direction and the power, the server runs the physics and every player's screen plays the very same roll at the very same moment, starting exactly when the putter hits the ball.

The windmill turns on the server clock, so its sails are in the same place on every screen and a ball that hits them does so for everybody. No player can cheat a ball into the cup.

<figure><img src="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2F8fbRqCpP45dOL3jk8BTs%2Frtx-minigolf-your-turn.webp?alt=media" alt="Your turn banner in a minigolf match"><figcaption><p>A match in Turns - the hole card and the YOUR TURN banner.</p></figcaption></figure>

***

## Built With It

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Vespucci Beach castle</strong></td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2Fza9vyffjQFDccyyWm56U%2Frtx-minigolf-castle-hole.webp?alt=media">rtx-minigolf-castle-hole.webp</a></td></tr><tr><td><strong>Vespucci Beach loop</strong></td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FYlKDOQiDGcQmhnTR5GGz%2Frtx-minigolf-loop.webp?alt=media">rtx-minigolf-loop.webp</a></td></tr><tr><td><strong>Rooftop downtown</strong></td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FneoictYCZSZBu9CLKPbl%2Frtx-minigolf-rooftop-sunset.webp?alt=media">rtx-minigolf-rooftop-sunset.webp</a></td></tr><tr><td><strong>Rooftop from above</strong></td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2Fuk3S2zTeCp8XLDXr9PPd%2Frtx-minigolf-rooftop-course.webp?alt=media">rtx-minigolf-rooftop-course.webp</a></td></tr><tr><td><strong>Desert loop</strong></td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2F9jaEhoyCGYWFcqqJcgCi%2Frtx-minigolf-desert-loop.webp?alt=media">rtx-minigolf-desert-loop.webp</a></td></tr><tr><td><strong>Vespucci Beach at night</strong></td><td><a href="https://1804361591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCGSsnvBAI11nCFRWfpsr%2Fuploads%2FdS8y91JhWr5oHIRfVmXQ%2Frtx-minigolf-night-course.webp?alt=media">rtx-minigolf-night-course.webp</a></td></tr></tbody></table>

***

## Performance & Optimization

* **No networked entities** - every piece, ball, flag and putter is created on each player's own screen
* Courses are only spawned for players near them
* Works with `sv_entityLockdown "strict"` without any extra setup
* No database - courses and leaderboards are saved in the `data` folder, in two copies so a crash never loses a record
* Props in their own resource, so `rtx_minigolf` can be restarted while the server runs

***

## Developer Friendly

RTX Minigolf provides:

* a fully commented config
* open-source client and server bridges (`client/other.lua`, `server/other.lua`)
* client and server exports
* events when a match starts or ends, a hole is finished, a record is set and a business earns
* your own track pieces and obstacles in `configs/pieces.lua`
* Discord logs

***

## Need Help?

If you have any questions, issues or feature requests, feel free to contact us on Discord:

<a href="https://discord.gg/rtxdev" class="button primary">Join our Discord</a> <a href="https://rtx.tebex.io/package/7811022" class="button secondary">Buy on Tebex</a>