Skip to main content

​
Playing

​
Finding a course

Every published course has a start point with a marker (or an ox_target / qb-target zone) and a blip on the map.
  • /minigolf opens the course finder: every open course, nearest first, with holes, par, open lobbies, the course record, your own best and a waypoint button.
  • At the start point, E opens the course menu. /mgmenu opens the menu of the nearest course start, or your lobby.
To open, join or start a game you have to stand at the course start (Config.Game.startDistance, 50 m by default) and be out of your vehicle. Server owners can block players who are dead, cuffed or jailed through hooks.

​
The course menu

The menu also shows the entry fee and rewards (if the course has any), the time limit per hole and your own statistics.

​
Lobbies

The host starts the game and can remove players. A lobby holds up to 8 players, and every player gets their own colour.

​
Inviting players

  • Invite nearby players from the lobby, or invite anyone with /mginvite <server id>.
  • The invited player sees a prompt and accepts with Y or declines with Backspace, no menu needed. Players who are too far away get a waypoint to the course.
  • Players near the course start are told when a new lobby opens there (Config.Game.announceLobbies).
  • Lobby members who walk away from the course leave the lobby automatically (Config.Game.lobbyLeaveDistance, 60 m).

​
Game modes

Everyone at once

Everybody plays their own ball at the same time. The fastest flow, and the default.

Take turns

Classic rules: one player plays the hole out while the others watch. The best score on a hole starts the next one.
In Take turns, nobody waits forever: an idle player sees a countdown and is moved on after Config.Game.turnIdleTimeout (90 s), and the host can skip an idle turn after 30 seconds.

​
Lobby rules

The host can change the stroke limit, the time per hole and the aim guide, and can make the lobby private (invite only). A lobby with changed rules is marked unranked and stays off the leaderboard.
The range the host may pick from is set in Config.Game.lobbyRules (3 to 15 strokes, 0 to 600 seconds per hole by default).

​
Playing a hole

1

Hole intro

A short camera flight from the cup to the tee with a hole card: par, length and the hole record. Skip it with E, Space or Backspace, or turn it off in your settings.
2

Address the ball

Walk to your ball and press E. The player steps up beside the ball with the putter.
3

Aim

Aim with the mouse, fine-tune with ← →, zoom with the wheel. C shows an overview of the whole hole. The aim guide simulates the real roll while you charge: slopes, ramps and walls bend the line, and it ends in the cup when the putt drops. Courses can turn it off.
4

Shoot

Hold LMB or E to charge and release to hit. RMB or Backspace cancels a charged shot.

​
Power control

Each player picks one in their settings. Server default: Config.Game.defaultPowerMode.

​
Rules and penalties

Each course can override the stroke limit, time limit and penalty in the editor. Out of bounds works in one of two ways, set per course:
  • Play area: the ball is out when it leaves the hole’s play area (a radius around the hole).
  • Lane only: the ball is out as soon as it comes to rest on ground that is not part of the course. The edge of the play area shows up when the ball gets close.

​
Shot feedback

Lip-outs, near misses, a last-stroke warning, a camera punch on full-power hits and a trail behind rolling balls in the player colour. Holes-in-one get a celebration, and the other players are told.

​
Track kit obstacles

  • Windmill: the sails block the tunnel in time with the network clock, so every player sees them in the same place. A sail pushes a ball out of its way.
  • Loop: the ball only makes it round with enough speed and comes out in the channel beside the one it went in. Too slow and it rolls back or drops off.

​
During the round

Players near a running game see its balls and the putters of the players (Config.World.showBystanderBalls, needs OneSync).

​
Results and leaderboards

At the end, the results show your place, the course record, your personal best and the gap to your previous best, whether the round was ranked, and why a reward was not paid (if it wasn’t). Play again offers a rematch to the whole group; the offer stays as a prompt after closing the results.
Solo rounds and lobbies with the course’s own rules count. Lobbies with changed rules are unranked. Rounds flagged by the anti-cheat checks are kept off the leaderboard by default (Config.AntiCheat.skipLeaderboardOnFlag).
When an admin changes the number of playable holes or the total par of a course, its leaderboard and hole records start over. The old board is archived, and rounds that were running on the old layout do not enter the new one.
Only when the server owner set rewards, and only for rounds where every hole was holed. The win reward goes to a sole winner only (ties get none). A cooldown per player and course and a minimum round duration apply. Entry fees are refunded whenever a game is cancelled.

​
Player settings

Open the game menu (F9) → Settings. Settings are stored per player.

​
All player controls

All keys are FiveM key mappings. Players can change them under Settings → Key Bindings → FiveM.