Log inGet started
World

Pocket Putt Islands

README.md

pocketPutt 0.7.5

The game code of Pocket Putt Islands: a six-hole flick-to-putt mini golf round on floating tropical islands, for touch, mouse and gamepad, played alone or with friends in one shared round. Everything general lives in installable kits; this package holds only what is Pocket Putt's own. Rules and design notes: /source/design/spec.md.

What it is built from

Part of the gameComes from
Drag back from the ball to putt (aim line, power arc, cancel, touch / mouse / gamepad), putter stylesflickShot (FlickShot, preset golfPutt)
The chase camera, the island-to-island sweep and the title orbitflickShot ShotCam
Greens, rails, bumpers, windmills, blockers, ramps, sand, water, cups and flags (theme pocketTropical, rounded ends, striped tee)puttCourse pieces and themes
The round: whose hole, strokes, water penalties, the stroke cap, stars, everyone moving on together, the ranking, and keeping every player's device in stepputtCourse round (one shared, synced round)
Title and pause menusmenusKit
Saved level, XP, unlocks and best roundsaveKit
Screen shakejuiceKit
Confetti on a hole in onetrophyKit (with our own matte confetti material)
Palms, flowers and island dressingtropicalKit (tropicalProps)
Toon water, sea and surfacesanimatedMaterials, toonMaterials
Sky and music/ambiencepaintedSkies, soundstage

Modules

ModuleRequireWhat it does
rulespocketPutt.rulesConstants: pars, the stroke cap, ball physics, camera framing, colours, star rule, XP and putter styles, event names
holespocketPutt.holesThe six hole layouts (puttCourse pieces) and their tee, cup and heading
coursepocketPutt.courseBuilds the islands, greens, sea and dressing (called from the scene build)
roundpocketPutt.roundCreates the shared puttCourse round and does Pocket Putt's part for this player: the ball's cup / water / at-rest checks reported to the round, the tee and cup placement, the ShotCam sweep between islands, XP and the saved best round, and the game events the screens hear
screenspocketPutt.screensHUD, hole toasts, hole in one, scorecard, results, friends panel, sounds
play/PuttBallcomponent pocketPutt.play.PuttBallThe ball's look, the name tag over other players' balls, the ball sinking into the cup

Multiplayer

Every device creates the same puttCourse round (id = "pocketPutt", players = "peers", waitForAll, joinAt = "current"). The owner of its synced PuttRound_pocketPutt entity is the one authority: it counts every stroke and penalty, finishes holes, moves the whole group to the next hole at the same moment and ranks the round, and the other devices read that state. Each player's ball is their own avatar body, simulated on their own device, and a friend who joins mid-round starts on the hole the group is playing.

What players can expect today:

  • Everyone who joins gets their own ball, appears on the scorecard and is ranked at the end.
  • A device that joins a round already running (it opens the game after the round was set up) reads the round's current state, so it shows the same hole and scorecard as the others.
  • A device that already had the engine running when the round was set up can end up showing a different state from the others because of engine issue 19356: an older hole, an empty or stale scorecard, or another player's ball in the wrong place. Its own putts still count (they go to the authority), and the authority still moves the group on, but that screen may not show it. Reloading the game on that device makes it join fresh and show the shared round. Until the issue is fixed, the game does not guarantee that every device always shows the same scorecard.

Performance on a tablet

On an Android tablet the game runs at about 24 to 26 frames a second (about 40 ms a frame, occasional spikes near 90 ms when a putt starts), measured at the tablet's default render scale of 0.76. That rate is set by the engine (issue 26275), not by the game's own scripts. Putting stays accurate at that rate because the drag is read every frame; the camera and the rolling ball look less smooth than at 60. A desktop browser runs faster.

Changes

  • 0.7.5: README: what players can expect in multiplayer while engine issue 19356 stands, the tablet frame rate (issue 26275), version and changes. Uses flickShot 1.2.4 and puttCourse 1.3.2 (documentation releases).
  • 0.7.4: the round runs on puttCourse's shared round (one synced authority; everyone on the same hole, moving on together); the camera is flickShot's ShotCam (the game's own ChaseCam is gone).
  • 0.7.3: bumper and rail knocks play again (the knock read the ball's speed in a way that threw on every contact); flickShot 1.2.2 for the browser mouse.