puttCourse.package
README.md
puttCourse 1.3.2: mini golf course kit
Build mini golf holes from a short declarative description. 23 low-poly pieces on a 2 m grid, six themes switched by one setting, five flag styles, four cup effects, a multi-player strokes-vs-par scorecard in six styles, a multi-hole stroke-play round module (strokes, penalties, par cap, stars, ranking, one synced authority), and ball behaviour on the engine's own physics (colliders, physics surfaces with friction / restitution / rolling resistance, triggers) that turns into events naming the ball and its player. Multiplayer-safe and tuned for phones and tablets. Ships PuttHole / CoursePiece components for scene authoring, a live gallery scene, a test suite and two guides.
Installing gives a world: puttCourse.course (the API below), puttCourse.pieces, .themes, .flags, .effects, .scorecard, .geom, puttCourse.round (stroke play, below), the PuttHole, CoursePiece, CourseRuntime, PuttGallery, RoundState components, puttCourse.gallery scene (6 theme rows of all 23 pieces, the 5 flag styles, the 4 cup effects replaying, the 6 scorecard styles cycling on screen), the puttCourse test suite (32 tests, run in edit mode: tools.use("tests", "run", { suite = "puttCourse" })) and the guides how-to-build-a-mini-golf-course and example-make-a-three-hole-mini-golf-game. Depends on platformsKit (motion maths), animatedMaterials (toon water, conveyor belts) and optionally juiceKit (sparkle / confetti VFX).
Quick start
local Course = require("puttCourse.course")
Course.setTheme("candyCartoon") -- THE one theme setting
local hole = Course.buildHole({
id = "h1", number = 1, par = 3, origin = { 0, 0, 0 },
pieces = "tee 0 0; straight 0 1; sand 0 2; windmill 0 3; curve 0 4; cup 1 4 rot=90",
})
local ball = Course.spawnBall({ hole = hole, colour = "#ff5d5d" }) -- on the tee, owned by this machine
Course.shoot(ball, 0, 1, 3.5) -- direction (x, z), speed m/s → physics impulse
hole:on("ballInCup", function(ev) print(ev.player, ev.strokes) end)
Grid and frame
- Tile = 2 m × 2 m (
Course.TILE), turf top at y = 0 of the tile, slab 0.3 m thick, rails 0.12 m wide × 0.16 m high, cup radius 0.15 m. - Entry
{ kind, gx, gz }puts the tile centre atorigin + (gx*2, y, gz*2). A ball enters a piece on its local −Z side and leaves on +Z;curve/cornerleave on +X (mirror=true, orcurveLeft/cornerLeft, leave on −X).rot= degrees about up (90 turns +Z to +X).y=raises a tile (after aslope h=0.5, put the next tile aty=0.5). - The tee anchor is 0.45 m behind its tile centre; the cup is 0.3 m ahead of its tile centre.
Pieces (Course.PIECES)
tee, straight, curve, corner, slope, slopeDown, ramp, loop, bridge, tunnel, wall, windmill, blocker, bumper, spring, sand, ice, water, conveyor, teleporter, funnel, cup, flag
Aliases: launchPad/launch→spring, rail/border→wall, start→tee, hole→cup, curveLeft/curveRight→curve, cornerLeft/cornerRight→corner, portal→teleporter, jump→ramp, bunker→sand, pond→water, belt→conveyor, spinner→windmill, slider→blocker.
Per-piece settings (in a layout key=value, or a table entry): slope/slopeDown/ramp h; ramp jump; wall len, h; windmill speed (deg/s, 55), offset (s), stripes, stripeCount; blocker speed (m/s), span, wait, offset; bumper kick (m/s, 2.2), spots; spring power (4.5), up (3.2); conveyor speed (1.4, negative = backwards), cross; teleporter link ("A"), role (in|out|both); funnel depth; loop radius; bridge width; cup/funnel/flag flagStyle, number. Course.pieces.DESCRIPTIONS[kind] describes each. Any setting may be a table (spots = {{-0.5, 0.1}, {0.5, 0.1}}, stripes = {"#ff6f61", "#ffffff"}): the piece cache is keyed on every setting, tables included, so two holes with different bumper layouts get their own pieces (no unique tag needed).
Jump ramp
ramp alone is a 0.26 m kicker: a fast ball hops off it, and a full-width water tile is too wide for it. ramp jump=true is a 0.34 m jump ramp with a kick zone from its foot to its lip: a ball moving forward into it at minSpeed (1.5 m/s) or more leaves at up (3.2 m/s) climb with its forward speed held between carry (5) and maxCarry (6) m/s. That flies about 3.2 m from the foot, so it clears the next tile: a water tile, or a bridge you mean to be jumped. A slower ball rolls back down. The kick fires ballLaunched with jump = true.
"tee 0 0; straight 0 1; ramp 0 2 jump=true; water 0 3; straight 0 4; cup 0 5"
Striped windmill
windmill stripes={c1, c2} bands the tower (the feet and the body) in stripeCount (6) horizontal stripes of the two colours (hex strings or {r, g, b}). stripes=true takes the theme's house and houseStripe (else roof). A theme that sets houseStripe stripes its windmills by default (candyCartoon does), and stripes=false turns that off. The stripes are vertex colours in the same merged mesh: a few more quads, no extra draw call, nothing per frame.
{ "windmill", 0, 2, stripes = { "#ff6f61", "#ffffff" } } -- coral and white
Course.themes.define("myIsland", { base = "tropicalIsland", houseStripe = "#ff6f61" })
Themes, flags, cup effects, scorecards
- Themes (
Course.THEMES):tropicalIsland, candyCartoon, pixel, neonSciFi, stoneRuins, cozyGarden.Course.setTheme(name)switches every hole built without its owntheme(rebuilt at once).Course.themes.define(name, spec)adds one. - Flag styles (
Course.FLAG_STYLES):classic, numbered, pirate, tropical, neon. A theme's optionalflagClothhex recolours the classic pennant (e.g.flagCloth = "#ffd23a"for a sunny yellow one). - Rounded greens and a striped tee: a theme with
roundEnds = truegives every closed lane end (the tee, the cup, a dead end) rounded corners, curved wooden rails joining the side rails to the end rail, with the corner outside the curve painted in the theme'sedgecolour, so a straight hole reads as a soft stadium-shaped green instead of a box.teeStripe(a hex colour) turns the tee mat into bands ofteeMatandteeStripewith ateeStripeframe. Both are off in the six built-in themes, so they look as before; turn them on withCourse.themes.define("myTheme", { base = "tropicalIsland", roundEnds = true, teeStripe = "#ffffff" }). - Cup effects (
Course.CUP_EFFECTS):sparkle, confetti, glowRing, splash(andnone). - Scorecard styles (
Scorecard.STYLES):classicPaper, tropicalWood, neonArcade, pixelArcade, candyPop, parchment.
API: puttCourse.course
| Call | What it does |
|---|---|
buildHole(desc) → hole | Build a hole. desc: id, number, par, theme (nil = follow setTheme), origin {x,y,z}, yaw, parent (entity), flagStyle, cupEffect, waterPenalty (1), autoReset (true), killDepth (4), pieces = layout string or list of { kind, gx, gz, rot=, y=, mirror=, ...settings }. Idempotent: the same id replaces the old hole. |
| hole handle | id, number, par, theme, tee {x,y,z}, cup {x,y,z}, pieces, root, colliderCount, hole:on(event, fn) → off, hole:destroy(), hole:rebuild(theme?), hole:setTheme(name), hole:teePosition(), hole:cupPosition() |
spawnPiece(kind, opts) → piece | One piece: theme, position, rot, mirror, parent, name + settings. Handle { id, kind, root, anchors, position, worldRot, destroy() } |
parseLayout(text) | "tee 0 0; cup 0 3 rot=90" → entries |
hole(id), holes(), clear() | Look up / remove everything this machine built |
setTheme(name), theme() | The one course-wide theme setting |
spawnBall(opts) → entity | hole (placed on its tee), position, player, colour, radius (0.07), synced (play: true), name |
registerBall(entity, {player, hole}) | Make your own body a course ball (needs a collider + dynamic Physics) |
shoot(ball, dx, dz, speed) | Impulse + roll, counts a stroke, emits ballStruck. Owner only. |
resetBall(ball, pos?, reason?), placeBall(ball, hole) | Back to last shot / onto a tee (strokes 0) |
ball(ball) | { id, player, hole, strokes, sunk, stopped, lastShot, lastSafe } |
ballSpeed(ball), removeBall(ball) | |
on(event, fn, holeId?) → off | Listen ("*" = all) |
emit(name, ev) | Fire locally and to every peer |
now() | Shared clock (multiplayer.sessionTime()) |
setSurface(name, values) | Tune turf, rail, sand, ice, bumper, ball physics surfaces |
paramKey(kind, theme, settings) | The piece cache key: kind, theme and every setting (tables serialised in a stable order; position/parent/hole left out) |
clearPieceCache() | Forget cached piece descriptions and meshes (the cache outlives a module reload: call it after editing piece code or a theme in a running session, then rebuild) |
SAND_DAMPING, ICE_GLIDE, CONVEYOR_GRIP | Zone tuning numbers |
Components: PuttHole (fields holeId, number, par, theme, layout, flagStyle, cupEffect, waterPenalty, autoReset; :handle(), :rebuild()), CoursePiece (kind, theme, mirror, settings, flagStyle, number; :handle()).
Scorecard: Scorecard.new(pars, players) → card (card:addPlayer{id,name,colour}, card:record(playerId, holeIndex, strokes), total, toPar, leader, par), Scorecard.render(cardOrPlayers, pars?, style, {width, title, current}) → widget tree, Scorecard.show(...), hide(), isShown(), onCallback(id).
Events (Course.EVENTS)
Every event is a table: event, ball (entity id), player (peer id or your value), hole (id), holeNumber, par, piece (kind), pieceId, position {x,y,z}, strokes, plus remote=true, fromPeer when it came from another machine.
| Event | Extra fields |
|---|---|
ballInCup | speed |
ballInWater (older name ballEnteredWater still delivered) | penalty, resetTo: with autoReset the ball goes back after 0.7 s and ballReset{reason="water"} follows |
ballOnSand / ballLeftSand, ballOnIce / ballLeftIce, ballOnConveyor / ballLeftConveyor | |
ballBumped | bumper (index) |
ballLaunched | power, up (jump = true from a jump ramp) |
ballTeleported | to, link |
ballHitWindmill, ballHitBlocker | |
ballOutOfBounds | penalty (below origin.y - killDepth) |
ballStruck | speed, direction |
ballStopped | (at rest 0.35 s) |
ballReset | reason (water, outOfBounds, placed, manual) |
Hazards and resets
- Water and out of bounds penalise a ball once per visit: two touching water tiles cost one penalty; the ball can be penalised again only after it is reset, shot or placed. A sunk ball is never penalised.
- The ball goes back after
Course.RESET_DELAY(water 0.7 s, out of bounds 0.3 s), in edit and in play, to the spot the hole'sresetTorule picks:"lastShot"(default, where it was hit from),"lastSafe"(its last rest spot) or"tee". - Out of bounds: falling below
origin.y - killDepth, or (unlessbounds = false) leaving the pieces' footprint plusboundsMargin(1.5 m) sideways.outPenaltydefaults towaterPenalty. - Your own triggers become hazards with
Course.addZone(entity, "water" | "out" | "cup" | "sand" | "ice", opts)(oraddWaterZone).Course.penalize(ball, reason, opts)andCourse.checkBall(ball)judge by hand. - A ball your own controls shoot counts through
Course.noteShot(ball)(call it just before the impulse): stroke,lastShotandballStruck.
Stroke-play round: puttCourse.round
local Round = require("puttCourse.round")
local round = Round.new({ id = "main", holes = { h1, h2, h3 }, players = "peers", maxOverPar = 3 })
round:on("holeFinished", function(ev) print(ev.player, ev.strokes, ev.toPar, ev.stars, ev.holeInOne) end)
round:on("roundFinished", function(ev) print("winner", ev.ranking[1].player) end)
Every player plays at the same time, each on their own current hole. Strokes come from the course balls on their own (ballStruck +1, ballInWater / ballOutOfBounds + the penalty, ballInCup finishes the hole, ballStopped ends a capped hole); events from a hole that is not the player's current hole are ignored. Games without course balls call shot, penalty, holed themselves.
Round.new(opts) option | Default | What it does |
|---|---|---|
id | "round" | Same id on every machine; a new round with a live id replaces it |
holes | Ordered hole handles or ids (pars = {...} for ids not built yet) | |
players | {} | List of ids or { id, name, colour }, or "peers": every machine joins and leaves with the session |
maxOverPar | 3 | Cap = par + N strokes (false: no cap). At the cap the hole finishes when the ball stops, hits a hazard or after capDelay (6 s); the ball is put in the cup |
stars | { holeInOne = 3, under = 3, par = 2, over = 1, capped = 1 } | Table rule or function(strokes, par, { holeInOne, capped }) -> number |
waitForAll | false | A player who holed out waits until every active player has finished that hole; then the whole group starts the next hole at the same moment (after the last finisher's advanceDelay) |
advanceDelay | 1.5 | Seconds between finishing a hole and the next holeStarted |
placeBalls | true | Each machine puts the balls it owns on their player's next tee (and in the cup when capped) |
joinAt | "first" | "current": a late player starts at the lowest hole being played, earlier holes scored at the cap with 0 stars ("skipped") |
listenCourse | true | Count strokes from the course ball events |
synced | true in play | Keep the state on a synced RoundState entity |
scoreKit | nil | Pass require("scoreKit.score") and the stars won on each hole go to the player's score (the round never requires scoreKit) |
autoStart | true | false: call round:start() |
Round handle: on(event, fn) -> off, addPlayer(id, {name, colour}) (a returning player keeps their card; on a player already in the round it updates their name and colour), removePlayer(id), shot(id), penalty(id, n, reason), holed(id), stopped(id), start(), restart() (everyone still here back to hole 1, epoch + 1), state(), player(id), pars(), ranking(), scorecardPlayers() (feeds Scorecard.render(round:scorecardPlayers(), round:pars(), style)), isAuthority(), destroy(). Also Round.get(id), Round.stars(rule, strokes, par, info), Round.rank(players, holeCount).
A player record in state().players: id, name, colour, hole (current index, holes + 1 when done), status (playing, holed, finished), left, and per hole strokes, penalties, stars, pars, result ("", holed, capped, skipped). state().phase is waiting, playing or finished.
| Round event | Fields |
|---|---|
roundStarted | holes, players |
holeStarted | player, name, hole (id), holeIndex, holeNumber, par, strokes |
shot | same as holeStarted, strokes so far |
penalty | + penalty, reason (water, outOfBounds or yours) |
holeFinished | player, name, hole, holeIndex, holeNumber, strokes, par, toPar, stars, holeInOne, capped, penalties, total |
roundFinished | ranking: { place, player, name, colour, total, toPar, stars, holes, complete, left }, lowest total first, then most stars; ties share a place; players who left before the end come last |
playerJoined / playerLeft | player, name, hole (rejoined = true on a return) |
roundRestarted | epoch |
Multiplayer model: every machine creates the same round (same id and holes). In play the lowest peer spawns the synced entity PuttRound_<id> with a RoundState component (roundId, version, state); its owner is the only authority. It applies the rules, writes state and sends each round event to every machine once (ev.remote = true elsewhere). Other machines read state() from the component and send their manual calls to the authority. When the owner leaves, the engine hands the entity to a peer that stays, which carries on from the last written state. Each machine moves only the balls it owns. In edit mode (or synced = false) the round is local, which is how the tests run it.
Multiplayer
- Pieces are local temporary entities built from the same description on every peer (never replicated), so build the same holes everywhere (scene component or shared code).
- Windmills, blockers and flag sway are posed from
multiplayer.sessionTime(), so every peer sees the same phase. - A ball is a synced dynamic body owned by the peer that spawned it; only the owner judges zones and sends each event once over
multiplayer.send("puttCourse:ev"). Any number of balls per hole.
Known engine issues
These are engine problems, not kit bugs, and they stand until the engine fixes them:
- Issue 19356 (synced state on a device that was already running): a device that already had the engine running when the round was set up can end up seeing a different synced state from the other devices. In this kit that is the round's
RoundStateentity (PuttRound_<id>): on an affected deviceround:state(), the scorecard and each player's current hole can show something different from what everyone else sees (an older hole, an empty or stale card), even though the authority is still applying the rules for everyone. Balls are synced too, so another player's ball may also sit in the wrong place there. Round events (holeFinished,roundFinished, ...) are sent as messages, not as synced state, so they still arrive. Reloading the game on the affected device makes it join fresh and read the current state. Until the issue is fixed, do not promise players that every device always shows the same card. - Issue 26275 (frame rate on tablets): on an Android tablet the engine draws a six-island course like Pocket Putt Islands at about 24 to 26 frames a second (about 40 ms a frame, occasional spikes near 90 ms), measured at the tablet's default render scale of 0.76. The kit keeps its own per-frame work small (below), but it cannot raise that rate; expect smooth-enough putting, not 60 fps.
Performance (Android tablet)
- One merged vertex-coloured mesh per layer per piece (solid / glow / water / belt / mover); meshes cached per kind+theme+settings (every setting, tables included).
- A hole's axis-aligned floor and rail boxes are merged (7-tile test hole: 33 boxes → 16 colliders); bumpers are capsules, only the cup liner and funnel bowl are mesh colliders.
- Per frame: transform writes only (movers, flag sway, effect parts) into reused tables, no Model tint or
visiblewrites (≈27 µs each on Android vs ≈2 µs for a transform). - Sand = linear damping set once on enter; ice/conveyor push from
Physics.onBeforeSteponly while a ball is inside.
Changes
- 1.3.2: documentation only: title with the version, the test count and suite name corrected, a Known engine issues section (19356, 26275).
- 1.3.1: with
waitForAllthe whole group starts the next hole at the same moment;addPlayeron a player already in the round updates their name and colour. Two tests. - 1.3.0: theme options
roundEnds(rounded closed lane ends with curved rails) andteeStripe(striped tee mat with a frame).