Log inGet started
World

Pocket Putt Islands

README.md

pocketPutt.rules

Shared constants and scoring rules for Pocket Putt Islands, read by every part of the game (course, round, screens, chase camera).

  • Round shape: HOLE_COUNT (6), MAX_PLAYERS (4).
  • Strokes: a hole caps at par + CAP_OVER_PAR (3), then the ball is placed in the cup; water costs WATER_PENALTY (1).
  • Ball: radius, mass, rest detection and maximum putt speed (the flickShot golfPutt preset is scaled to it).
  • SURFACES: physics surfaces (green, sand, rail, bumper, wood) with friction, restitution and rolling resistance.
  • Stars per hole (3 for hole-in-one or under par, 2 for par, 1 over par) and the ranking order (lowest total, then most stars).
  • Camera settings, ball colours per player, the palette and the event names the slices share.
local Rules = require("pocketPutt.rules")
print(Rules.HOLE_COUNT, Rules.CAP_OVER_PAR)