Open Boat Racing

A configurable, open-source server-side minecraft minigame mod built using the Nucleoid project!

This mod comes with 3 different game modes:

• TimeTrial: Compare personal bests against other players.
• Qualifying: Set a best lap time to qualify for a grid position.
• Race: "The only place that matters is first." - Max Verstappen

With support for teams, pit-stops, OpenBoatUtils¹, strange lightning rods, and more!

Join the Mumbo Jumbo discord server where we occationally run events with this among other mods within the Nucleoid project :3

Usage

Use /game open boatrace:example to get started! The mod does not include any maps. You will have to create maps or join a server (like ours!) that already have maps for this mod.

Mapping

You will need Nucleoid Creator Tools to create a map, you can follow their tutorial here to get started. Open Boat Racing uses the following regions with the following nbt in /map region (Region) and additional data nbt with /map data (Data).

(Region) `checkpoint` and `grid_box`

{
    "index": [Int],
    "yaw": [Float], // default: 0
    "pitch": [Float], // default: 0
}

(Region) `spawn` and `pit_lane`

{
    "yaw": [Float], // default: 0
    "pitch": [Float], // default: 0
}

(Data) `track_format`

2 // this must be a constant and included with every map.

(Data) `meta`

{
    "name": [String], // default: Unknown Name
    "authors": [List[String]], // default: Unknown Authors
    "description": [String], // Optional
    "url": [String], // Optional
}

(Data) `attributes`

{
    "time_of_day": [String],
    "layout": ["circular" | "linear"] // default: "circular"
}

(Data) `openboatutils` TODO document me https://github.com/Abaan404/boatrace/blob/3508adb0c3d3d0266115a162424e49f5bbd58c6c/src/main/java/com/abaan404/boatrace/compat/openboatutils/OBUTrackConfig.java

Config

Check out the plasmid docs on creating a config to make a minigame. To choose a specific game mode, you must omit or include these fields accordingly:

• TimeTrial: exclude qualifying and race.
• Qualifying/Race: include qualifying and race.
• Race: exclude qualifying but include race.
• OpenBoatUtils (experimental): adding this field makes the game require OpenBoatUtils, anyone who doesnt have the client mod will be forced into spectator.

config

{
    "type": "boatrace:game",
    "track": [Identifier],
    "team": {
        "size": [Int] // default: 1
    },
    "qualifying": {
        "duration": [Long], // in ms
        "laps": [Int] // optional
    },
    "race": {
        "max_duration": [Long], // in ms
        "max_laps": [Int], // default 1
        "no_respawn": [Bool], // default: false
        "accept_unqualified": [Bool], // default false
        "pits": {
            "success": {
                "duration": [Long], // default 2000ms
                "random": [Long] // default 3000ms
            }
            "failure": {
                "duration": [Long], // default 2000ms
                "random": [Long] // default 0ms
            }
            "count": [Int] // default 0
        }
        "grid_type": ["normal" | "reversed" | "random"], // default "normal"
        "go_countdown": {
            "duration": [Long], // default 5000ms
            "random": [Long] // default 2000ms
        }
        "scoring": [List[Int]], // default: [10, 9, 8, 7, 6, 5, 4, 3, 2, 1]
    },
    "openboatutils": {
        "filter": [List[String]],
        "collision": ["vanilla" | "no_collision_with_any_entities" | "filtered_collision" | "no_collision_with_boats_and_players_plus_filtered_collision"],
        "resolution": [Byte],
    }
}

¹ OpenBoatUtils support is experimental and is seperately marked with +OBU, additional game configs will be required to setup the client.