- Read the Submission Rules before posting otherwise the mod may be rejected if it doesn't comply with these rules. (Updated February 10, 2023)
- I'm aware of the current Submission Rules
- Author does not approve the use of his content in other addons without his permission
- Yes
BoatMode is a reusable script that transforms bog-standard water into a unique gimmick, a second road with incredible handling and acceleration!
BoatMode is not designed to be loaded as a standalone addon.
The "DS_BoatTestMap" file is not required to be downloaded, but useful if you want to check out the documentation inside the map wad, or just for messing around with the boat controls. (Its map name is "TESTMAP" if you're using the map command)
If you encounter any bugs, please send them in the Discussions thread, or shoot me a message on my discord! (@epixgamer3333333)
BoatMode is not designed to be loaded as a standalone addon.
E-Brakes function somewhat the same. They will slow you down and bring you back to the surface, useful if you're way above it and need to get back on as quickly as possible. The downwards momentum won't sink you. Spindashes and Respawns will drop you down to the seafloor, but this is slow so only use it as a last resort.
Drifting still charges sparks, and handles the same for all classes. If your racer tilts DOWN while drifting, you'll "Dolphin Dive" into the water at sparks above a red. If you don't want this, "null drift" before releasing your charge (drifting without accelerating). Otherwise, if your racer tilts UPWARDS, drifting will redirect your speed to your direction. You cannot sliptide on water, for technical reasons, and any wavedash charge you build up will be automatically used up.
Trailing and orbiting items should act as normal, with some exceptions. Holding them for too long will drag you down to the seafloor until you release them. Maybe there could be some goodies down there? Bananas, Eggmarks, Orbinauts, and Gachaboms should all automatically water run or float on water. Both mines and Drop Targets cannot, for technical reasons.
Drifting still charges sparks, and handles the same for all classes. If your racer tilts DOWN while drifting, you'll "Dolphin Dive" into the water at sparks above a red. If you don't want this, "null drift" before releasing your charge (drifting without accelerating). Otherwise, if your racer tilts UPWARDS, drifting will redirect your speed to your direction. You cannot sliptide on water, for technical reasons, and any wavedash charge you build up will be automatically used up.
Trailing and orbiting items should act as normal, with some exceptions. Holding them for too long will drag you down to the seafloor until you release them. Maybe there could be some goodies down there? Bananas, Eggmarks, Orbinauts, and Gachaboms should all automatically water run or float on water. Both mines and Drop Targets cannot, for technical reasons.
BoatMode offers multiple mapheader options and in-map sector actions for maximum customizability.
Map Header Options: (case insensitive)
This was achieved with the following map headers:
Sector Actions:
Call these with Action 443 "Call Lua Function". Recommended: Repeatable action, When player enters
Default format: (3 = Map Default (map header defined), 2 = Yes, 1 = No, 0 = Leave as is)
Action
Action
Map Header Options: (case insensitive)
Lua.Boat - (true/false) Must be set to something in order for any of the controls to take affect.Lua.Boat_DriftDip - (true/false) Toggles diving for drifting, i.e., the tilting and dipping downwards when releasing a drift. See also: Sector ActionsLua.Boat_BoatOnByDefault - (true/false) If ON, players will NOT enter boat controls by default and must be set manually through "BOAT_SETPVARS" actions. A bit misleading, I know.Lua.Boat_DolphinJump - To be used in conjunction with Lua.Boat_DriftDip = true, players exiting the water will get a huge vertical boost depending on the level of sparks they charged.Lua.Boat_Prop_Sprite - Cosmetic sprite change for the propeller sprite. Accepts "SPR_XXXX" and "XXXX", referring to sprite names.Lua.Boat_Prop_Frame - Cosmetic frame for the propeller sprite. Accepts letters or numbers ("C" and "2" are equivalent)Lua.Boat_PropOV_Sprite - Same as above, but for the propeller's overlay (the little circle that doesn't rotate)Lua.Boat_PropOV_Frame - Same as above, but for the propeller's overlay (the little circle that doesn't rotate)This was achieved with the following map headers:
Code:
Lua.boat_prop_sprite = SPDB
Lua.boat_prop_frame = C
Lua.boat_propov_sprite = SPR_SMCESector Actions:
Call these with Action 443 "Call Lua Function". Recommended: Repeatable action, When player enters
Default format: (3 = Map Default (map header defined), 2 = Yes, 1 = No, 0 = Leave as is)
Action
BOAT_SETPVARS: Toggles variables related to boat behavior.| Argument slot | Name | Acceptable values | Description |
|---|---|---|---|
| Argument 1 | "DriftDip" | Default format | If on, the player will dip down when they mini turbo. |
| Argument 2 | "AllowBoat" | Default format | If on, players will NOT enter the boating state when they touch water. Useful if you want to have a mix of boating sections and underwater section. |
| Argument 3 | "DolphinJump" | Default format | If on, and combined with "DriftDip", players exiting the water will gain a huge height boost after mini turbo-ing. |
Action
BOAT_DODOLPHIN: Call this when you need bots to perform a Dolphin Dive, since they cannot drift on their own.| Argument slot | Name | Acceptable values | Description |
|---|---|---|---|
| Argument 1 | "Spark Level" | "Emulated spark stage" (1 - 4) | The spark stage used for height calculations. The higher the level, the deeper the dive and the bigger the jump. |
| Argument 2 | "AllowPlayers" | Anything other than 0 | By default, this action will not affect players. Setting this argument to anything other than 0 will make players perform a Dolphin Dive aswell, maybe for some automation. |
The "DS_BoatTestMap" file is not required to be downloaded, but useful if you want to check out the documentation inside the map wad, or just for messing around with the boat controls. (Its map name is "TESTMAP" if you're using the map command)
If you encounter any bugs, please send them in the Discussions thread, or shoot me a message on my discord! (@epixgamer3333333)
