Skip to main content

​
Installation

Road Minigolf lets your admins build minigolf courses anywhere on the map with an in-game editor, and lets players play them alone or with friends: aim camera, power meter, raycast ball physics, par scoring, lobbies, leaderboards and rematches. It ships with its own streamed track kit and a finished demo course on a roof garden. It runs standalone. ESX, QBCore and Qbox are detected automatically for character names, entry fees, rewards and admin groups.
Do not use FileZilla. It can corrupt or skip hidden files during upload. We recommend WinSCP.
There is no SQL file and no transaction ID to enter. Road Minigolf stores courses, leaderboards and statistics in JSON files inside its own data/ folder. The download comes from the cfx.re Portal.

​
📋 Prerequisites

FiveM server

Any recent server artifact (Lua 5.4).

OneSync

Recommended. Needed for start guards, nearby invites, lobby announcements and the bystander view. Everything else works without it.

Framework

Optional: ESX, QBCore or Qbox for character names, entry fees and rewards.

Target script

Optional: ox_target or qb-target for the course start points.

​
🚀 Setup Instructions

1

Extract the resource

Put the folder into your resources. We recommend a [road] folder alongside our other scripts:
The folder name must stay road_minigolf. The track kit and the demo map are streamed from this resource, and exports are called by this name.
2

Start it and give your admins access

server.cfg
The ACE line works on every framework. Admins are also recognised from ESX groups (admin, superadmin), QBCore permissions (admin, god), the Qbox ACE group of the same name (group.admin), fixed identifiers or your own function. See Configuration.
3

Make sure the data folder is writable

The server writes courses, leaderboards and statistics into road_minigolf/data/. If it cannot write there, the console says which file failed and nothing is overwritten.
4

Optional: fill in config.server.lua

Admin identifiers, custom money functions, a society account and Discord webhooks go into config.server.lua. This file is loaded on the server only and never sent to players.For a first start you can leave it as it is.
5

Build your first course

Start the server, press F7 in game (or type /mgedit) and build a course. New courses are unpublished until you publish them in the General tab or the course list; admins can playtest unpublished courses alone.

Course editor

From an empty spot to a playable hole in a few clicks

​
🌐 Language

Set the server language in config.lua:
config.lua
13 languages are built in: English (en), German (de), French (fr), Spanish (es), Italian (it), Dutch (nl), Polish (pl), Portuguese (pt), Turkish (tr), Czech (cs), Russian (ru), Greek (el) and Chinese (zh). Missing text falls back to English.

​
🏙️ The demo map

Road Minigolf comes with SkyGarden: a streamed roof garden on the Rockford Plaza mall with a finished nine-hole course built from the track kit. The course is installed on the first start.

SkyGarden demo map

What it changes on the map, and how to leave it out

​
✅ Verification

  1. The server console shows no road_minigolf errors on start. On the very first start it prints that the demo course “SkyGarden” was installed.
  2. In game, the SkyGarden course has a blip and a start marker on the Rockford Plaza roof (unless you turned the demo off).
  3. As an admin, F7 opens the editor. As a player, /minigolf opens the course finder with every published course.

​
📚 Next Steps

Playing

Lobbies, game modes, controls and scoring

Course editor

Build, test and publish courses

Configuration

Permissions, economy, logs and hooks

FAQ

Any problems or questions?