Skip to main content

Addons

Addons are optional scripts the plugin installs next to the module in ReplicatedStorage (OceanBuoyancy, OceanSwimming and so on). Each is independent: the module works without any of them, and you can add or remove one at any time from More > Addons or during Quick Start. An installed addon gets its own dropdown at the top of the panel with its settings; those settings are attributes on the addon script, so scripts can change them too.

More > Addons

Quick Start: pick the addons

Buoyancy​

Unanchored parts tagged OceanFloat ride the surface: lift from the water they displace, drag, and spin damping, tuned by the Buoyancy Physics settings and per part by the OceanBuoyancy (lift multiplier) and OceanDrag (drag multiplier) attributes; OceanServerOwned keeps a heavy assembly's physics on the server, so a player walking up to a big ship does not take it over (Make hull turns it on for boats without a VehicleSeat). With streaming on, floats far from every player are parked (anchored) until someone comes near; OceanAwake on a part keeps it simulated anyway, for a ship out on a scripted voyage. Without it the sea is visuals only and parts fall straight through.

The addon's dropdown in the panel has a Boats and floating parts section with everything the Tags section offers for OceanFloat: tag or untag the selection, select everything tagged, Make hull for selected boat, Make sail, and the per-part OceanBuoyancy and OceanDrag.

A welded assembly with several tagged parts floats on all of them, so a wide hull rides level. Make hull for selected boat in the Tags section adds one invisible OceanHull part sized to the boat, makes it the model's PrimaryPart (RootPriority -100), sets its OceanBuoyancy so the boat floats at the height it stands at in Studio, gives it an attachment and an AlignOrientation that keep the deck level, and puts Quenty's qPerfectionWeld script in the model so the boat is welded together when the game starts. Make sail turns the selected part into a sail, or adds an OceanSail part to the selected boat: it gets a FluidForceSensor and a script that pushes it, every Heartbeat, with the force the sensor measures from workspace.GlobalWind. The part's SailPower attribute (100 by default) sets how hard the wind pushes; 0 furls the sail.

Parts inside an OceanDry region that belongs to the same model still float (a submarine's hull) while loose cargo inside it does not.

Swimming​

Characters swim in the sea: a damped float at the surface, water drag, and diving when the camera looks down. The water resists anything faster than swimming pace, so a jump or a fall into the sea is spent within about 20 studs. It sets the Humanoid's Swimming state, so skip it if your game has its own swim system.

SettingDefaultWhat it does
EnabledtrueCharacters swim
CanJumptruePlayers can jump while swimming
SwimSpring30How stiffly a swimmer is held at the surface
SwimIdleDrag3Slowdown while no movement key is held
DepthBuoyancyModifier0.6How much a swimmer's lift fades over the first 10 studs below rest depth: 0 = full lift, 1 = none

Drowning​

Under the surface oxygen runs out over OxygenSeconds, then the character drowns. Blackout fades the view to TintColor over DrownSeconds and then kills; Damage takes DamagePerSecond instead. Surfacing for RecoverSeconds refills the breath. Players drown through their own client (the server confirms the kill); NPCs tagged OceanDrown (any Model with a Humanoid) drown on the server.

SettingDefaultWhat it does
EnabledtrueCharacters can drown
ModeBlackoutBlackout: pass out over DrownSeconds, then die. Damage: lose DamagePerSecond while drowning
OxygenSeconds30Seconds of breath under the surface
DrownSeconds10Blackout: seconds from out of breath to death
RecoverSeconds5Seconds at the surface to refill oxygen and clear the view
DamagePerSecond10Damage: health lost per second while drowning
TintColorblackBlackout: the colour the view fades to
TintMaxOpacity1Blackout: how fully the tint covers the view at the end

WaterSplash​

A spray burst and a positional sound when a character, or anything tagged WaterSplash, hits the water faster than MinSpeed, plus spray on wave crests near the camera (the SplashRate and SplashHeight visual settings); a puff's size, speed and count follow the height of the crest that throws it, so small waves only throw small puffs. Per instance, the SplashSoundId, SplashVolume and SplashDistance attributes override the addon defaults.

SettingDefaultWhat it does
CharacterstrueSplash for player characters too
MinSpeed8Downward studs/s needed to splash
SoundIdimpact_waterDefault splash sound
Volume0.8Loudness of the splash sound
Distance120Studs the sound carries
Particles24Spray at MinSpeed; grows with impact

Ambience​

The sound of the sea and the wind, and the world going quiet under it. It ships no sounds: give the loops asset ids (blank = silent). Client-only, so each player hears the sea around their own camera.

  • Every loop cross-fades into its next pass (two AudioPlayers take turns), so a loop whose end does not match its start, or a very short one, still runs without a seam.
  • The ocean loop is louder in a rougher sea and near the surface.
  • The wind loop follows workspace.GlobalWind (or the Weather addon's WindSpeed) and gets louder with height.
  • Underwater, both give way to an underwater loop, and everything the Ocean plays goes dull: a low-pass filter on the Audio API chain all the sea's sounds share fades in, and SoundService.AmbientReverb becomes the underwater reverb. Both are put back when the camera surfaces. Every sound of the Ocean and its addons is an AudioPlayer, played from an AudioEmitter in the world (thunder, splashes) or heard everywhere (the loops), through one AudioListener on the camera: no legacy Sound is made.
SettingDefaultWhat it does
EnabledtrueThe addon plays
OceanSoundId / OceanVolume(blank) / 0.5The sea's loop and how loud it is at its loudest
WindSoundId / WindVolume(blank) / 0.5The wind's loop and how loud it is at its loudest
UnderwaterSoundId / UnderwaterVolume(blank) / 0.6The loop heard underwater
MuffleUnderwatertrueEverything the Ocean plays goes dull underwater (a low-pass filter on the shared Audio API chain)
MuffleStrength0.85How much of the highs the muffle takes away (0 to 1)
FadeSeconds0.6How long a change of volume or muffle takes

Thunder, the strike's crack and distant thunder are settings of the Weather addon.

Weather​

Random weather. The sea's global weather rotates on its own clock through a list you build in the panel: each entry is a sea state and a Lighting setup saved from the place, with a draw weight, and optional rain and lightning. Rain falls in the rainy ones (buildthomas' Rain), lightning strikes near players in the stormy ones (Quasiduck's Lightning-Beams) with thunder and optional damage. In Edit mode, Preview this weather shows any entry live, with its rain and its lightning.

The Weather addon

GroupSettingDefaultWhat it does
CycleEnabledtrueThe weather rotates on its own
CycleMinDuration120Shortest time a weather lasts (seconds)
CycleMaxDuration300Longest time a weather lasts (seconds)
CycleTransition20Seconds the sea and Lighting cross-fade between weathers
RainRainRate400Drops per second
RainRainSoundId(rain loop)Looping rain sound
RainRainVolume0.5Loudness of the rain sound
LightningStrikeMin / StrikeMax4 / 15Shortest and longest gap between strikes (seconds)
LightningStrikeRadius200Strikes land within this of a random player
LightningBoltHeight300How tall a bolt is (studs)
LightningBoltColorpale blueColour of the bolt
LightningFlashBrightness2How bright the sky flashes on a strike
LightningStrikeSoundId / StrikeVolume(blank) / 1The crack of a strike, heard after a delay by its distance (blank = silent). Several ids, comma separated: one is picked each time
LightningThunderSoundId(blank)The thunder that rolls in after a strike (blank = silent). Several ids, comma separated
LightningDistantThunderSoundId(blank)A dull rumble from far off, in a random direction, now and then while the weather has lightning (blank = silent)
LightningDistantThunderVolume / DistantThunderRate0.9 / 3Loudness of the distant thunder and how many rumbles come per minute (0 = none)
LightningThunderVolume / ThunderDistance1 / 1500Loudness of the thunder and how far it can be heard (studs)

The strike, thunder and distant thunder are each measured once (silently, in the background) and brought to a clear level over the sea's loops, so a quiet upload is still heard; their volumes are relative to that level. | Damage | DamageMode | Damage | None: light show only. Damage: humanoids in range take Damage. Explosion: that plus a blast | | Damage | Damage | 50 | 0 = no health loss | | Damage | DamageRadius | 12 | Studs | | Damage | BreakJoints | false | Characters in range fall apart | | Damage | ExplosionPressure | 500000 | Explosion mode: how hard the blast throws things | | Wind | Wind | true | The wind runs | | Wind | WindAngle | 17 | Direction the wind blows (degrees around the Y axis) | | Wind | WindSpeed | 20 | How fast the streaks travel and the foliage sways | | Wind | WindPower | 0.5 | How far the foliage sways | | Wind | FollowGlobalWind | true | Direction and speed come from workspace.GlobalWind instead of WindAngle and WindSpeed | | Wind | Foliage | true | Parts tagged WindShake sway | | Wind | WindLines | true | Streaks of wind near the camera | | Wind | LineLifetime | 2 | Seconds a streak lasts | | Wind | LineSpawnRate | 15 | Streaks per second |

The wind is one you can see: streaks drifting past the camera, and parts tagged WindShake (leaves, grass, flags) swaying in it, on each player's own screen, so tag decoration and not things players stand on. Per part, the WindPower and WindSpeed attributes override the addon's wind. With FollowGlobalWind or the ocean's UseWind on, direction and speed come from workspace.GlobalWind. Built on boatbomber and CloneTrooper1019's WindShake and WindLines.

DayCycle​

Day Cycle: the sun rises and sets. Lighting.ClockTime runs from sunrise to sunset over DayMinutes and back round over NightMinutes, on the server's clock, so every player sees the same time. While it runs, the Weather and Zones addons leave ClockTime alone when they change the lighting: the weather sets the look of the sky, Day Cycle keeps the time.

GroupSettingDefaultWhat it does
EnabledtrueThe clock runs
DayMinutes10Minutes from sunrise to sunset
NightMinutes10Minutes from sunset to sunrise
StartTime8Time of day when the server starts (ClockTime)
LightingMatchLightingtrueA colour correction follows the clock: gradually darker and tinted towards midnight, warm at dawn and dusk
LightingNightDarkness0.15How much darker the night is
LightingNightTint170, 190, 255Colour of the night
LightingSunsetTint255, 205, 160Colour of dawn and dusk

Lighting through the day in the addon's dropdown is the list of lighting looks the day goes through (Sunny Day, Golden Hour, Night Time, Foggy Void Sea, Dark Lighthouse). Each row is a time and a look: the arrows move a look earlier or later, the cross removes it, and clicking the row opens it to set its time and its lighting or to show it in Studio. Add a look puts one in the longest stretch without one. The list is kept in the addon's Schedule attribute as text, 7 Foggy Void Sea; 12 Golden Hour; 20 Night Time, so a script can set it too.

With a Schedule, the looks are the lighting: the MatchLighting colour correction stands down, and the Weather and Zones addons no longer change the lighting. Each look eases into the next, and an effect that one look has off fades out instead of switching off.

Zones​

Areas with their own ocean. A zone is a part tagged OceanZone linked to an Ocean preset (every setting, its Lighting, or both), with optional physics, visual and lighting overrides on top. The sea cross-fades across the zone's rim over OceanBlend studs; a player entering the zone gets its look everywhere they look and its Lighting fades in over OceanTransition seconds. Zones can move and their settings change live. Preview zones in the viewport outlines them while editing.

The Zones addon

Because a zone's look takes over the whole sea for a player inside it, keep zone looks close to the global one unless the change is the point.

DevTools​

A debug panel for developers: every setting live, weather and zone buttons, spawnable crates, rafts and buoys, a surface probe and a water-event log. It opens in Studio playtests and, in a live game, for the place owner, group members at MinGroupRank or above, and any ExtraUserIds, or for every player when Everyone is on. Toggle it with the chat command or the keybind, or from your own script (a topbar button) through the local player's OceanDevToolsOpen attribute: it appears once the player has access, follows the window, and setting it opens or closes the window.

local player = game.Players.LocalPlayer
player:SetAttribute("OceanDevToolsOpen", not player:GetAttribute("OceanDevToolsOpen"))
SettingDefaultWhat it does
EnabledtrueThe window can be opened
ToggleWithBothWhat toggles the window: the chat command, the keybind, or either
ChatCommand/oceanTyped in chat to toggle the window
KeybindF8Key that toggles the window (an Enum.KeyCode name)
MinGroupRank254Group games: the lowest group rank that gets the tools
ExtraUserIds(blank)More user ids that get the tools, comma separated
EveryonefalseEvery player gets the tools (for a showcase place)

AgentSupport (for MCP)​

Only a README. It puts OceanAgentSupport in ReplicatedStorage, a StringValue that tells MCP agents and command-bar scripts how to drive the plugin through shared.InfiniteOcean (install, presets, settings, tags, zones, weather, preview) and how to use the module API. It runs nothing and changes nothing; remove it before shipping if you want a tidy place.