Sport: ball matches and golf (sport.* kits) #

Team ball games and a golf round, as rules and data. Readable offline: gripforge docs sport, or the MCP tool gripforge_docs (topic sport).

What it is for #

Turn it on #

gripforge_gamekit_install   { project_id: "gkp_…", id: "sport.ball" }
gripforge_gamekit_configure { project_id: "gkp_…", id: "sport.ball",
                              config: { "mode": "foot", "teamSize": 3, "match": { "seconds": 180, "overtime": "golden_goal" } } }

Both kits require input.actions, world.ground and game.engine. Pair sport.ball with world.arena (same size, a gap of the goal's size in the end walls) or any flat ground; in mode: "cars" also install vehicle.driveable. sport.golf pairs with a camera kit that frames the ball (a top-down or third-person character kit, or a strategy camera).

sport.ball #

The field runs along z, centred on the origin: team 0 defends the -z end, team 1 the +z end. Settings are grouped; the main ones and their defaults:

Rules in short: on foot, hold the kick key to charge and release to kick where the character faces (within kick.reach of the ball, then kick.cooldown); a kick of charge c gives an impulse between minImpulse and maxImpulse, the ball leaves at impulse over mass, capped at maxSpeed. A goal is the whole ball over the line inside the mouth. Kickoff, then play, then goal, then kickoff; the team that conceded kicks off. At 0 the leader wins; a draw follows match.overtime. With match.endGame the end of the match ends the game: game.won or game.lost for the player's team.

Service sport.match: state(), ball(), ballPosition(), ballVelocity(), setBall(p, v?), kick(athlete, charge, dir?), kickoff(team?), restart(), score(), clock(), overtime(), athletes(), goals(), holder(), spotOf(athlete). Verbs sport_kickoff, sport_restart, conditions sport_score_at_least, sport_leading. Events sport.kickoff, sport.live, sport.kick, sport.touch, sport.goal, sport.out, sport.overtime, sport.ended, game.won, game.lost. The whole state is saved.

sport.golf #

A course is a document { id, name, holes: [...] }; a hole has id, par (2 to 7), tee and cup ([x, z]), green ({ radius, at? }), fairway strips ({ from, to, width }), bunkers and water (circles or strips), bounds and a fixed wind. Surfaces are the registry golf_surfaces (friction, bounce, grip, power, penalty, drop, lost) and clubs the registry golf_clubs (carry, loft; a putter rolls the ball). Ball flight: gravity, drag and the wind; landing uses the surface bounce and grip; rolling uses its friction and the slope. A rest in water or out of bounds costs the surface's penalty strokes and drop.

Service sport.golf: state(), course(), hole(), players(), scorecard(), clubs(), club(), setClub(id), aimAt(point), aimYaw(yaw?), swing(power, accuracy?), cancel(), ball(player?), distanceToCup(player?), surfaceAt(x, z), wind(), setWind(direction, speed), nextHole(), restart(). Verbs golf_next_hole, golf_restart, golf_set_wind, conditions golf_hole_is, golf_leading. Events golf.round_started, golf.hole_started, golf.wind, golf.turn, golf.swing, golf.landed, golf.penalty, golf.holed, golf.hole_ended, golf.finished. Variables golf.hole, golf.par, golf.stroke, golf.player, golf.phase, golf.gauge, golf.club, golf.wind_speed, golf.distance, golf.to_par, golf.surface. The course position, cards, balls, gauge and wind are saved.

Hooks and modding #

{ "id": "long_shots", "hook": "sport.kick", "match": { "human": true }, "mul": { "power": 1.25 } }

Touches, possession, tackles, balls out of bounds and the choices of the bots are facts, not hooks: react to their events. Moddable for sport.ball: field, ball, kick, impact, teams, teamSize, roles, match, possession, hold, ai (not mode, humans, playerTeam). For sport.golf: holes, players, layout, ball, hole, shot, wind, flow, ai, hidePlayer, and the collections golf_courses, golf_clubs, golf_surfaces.

Engines #

Both kits run as the same Rust logic on the web and in the native player, with the web interface fragment for the golf hud (hole, par, strokes, gauge, wind, club buttons for touch screens, card). Their engine targets are the web and the native player.

When it does not do what you expect #