abyssal-garden README

The project's README from github.com/Noniv/abyssal-garden. As one markdown file: README.md.

Abyssal Garden

A dreamy underwater world you can swim through, right in your browser.

Towering kelp forests, sunbeams pouring through a rippling surface, a sunken ship, manta rays gliding overhead. And all of it is made by code: no images, no 3D models, no sound files. The whole world fits in one 96 KB HTML file.

Kelp forest with a stone whale tail and a manta ray

Try it

  1. Download index.html.
  2. Open it in Chrome or Edge on a desktop computer.
  3. Wait a few seconds while the world is built, then press Dive in and start swimming.

Nothing to install, and it works offline. It needs a browser with WebGPU. If you see "This scene needs WebGPU", update your browser or switch to Chrome / Edge.

What's down there

Shipwreck Looking up through the kelp
Barrel sponges Light rays over the kelp basin

The purple grotto

Controls

Keyboard & mouse
Look around Move the mouse
Swim W A S D
Up / down E / Q
Swim faster Hold Shift
Jump to a viewpoint 1 to 6 (the spots in the screenshots)
Menu Esc releases the mouse and opens the menu with the list of controls; Resume takes you back
Sound on / off M (sound starts when you dive in)
Performance stats H
Detail level Low, Medium or High in the menu (reloads the page)

The seabed, cliffs and arches are solid: you glide along the rock instead of swimming into it, and you still fit through every tunnel and arch. Kelp, plants, corals, sponges, loose rocks, the floating boulders, the ship and the whale tail you can swim through.

On a touchscreen: hold one finger down to swim forward and slide it to steer. Put a second finger down to go faster. The ≡ button in the corner opens the menu. Phones always show the scene in landscape and start on Low or Medium detail. (Touch support is experimental.)

Detail levels

The Low, Medium and High buttons in the menu pick the detail level; the current one is lit. Each level is the same world, built with less in it:

Level What it is Picked on a first visit for
High The full scene Computers
Medium Half of the leaves, sparkles and pebbles; small rocks, sponges and corals cast no shadows Phones with 8 GB of memory
Low A quarter of the leaves, no anti-aliasing, coarser rocks and corals, simpler lighting, 480p to start with Other phones, and computers with 4 GB of memory or less

If loading crashes the tab, or the graphics driver gives up, the page starts again one level lower. Your browser remembers the level, and the resolution and draw distance the scene settled on, for the next visit.

How it works

Make it your own

The readable source code is in the source folder. To change something and rebuild index.html you need Node.js 18 or newer:

cd source
npm install
npm run build

This writes a new index.html next to this README. npm run build:readable writes an unminified version instead, which is easier to debug in the browser's developer tools.

npm run build:dev writes a separate dev.html with two extra tools that are not part of index.html: F flies the camera along a one-minute path through the whole world, and B runs that flight as a benchmark and reports frame and GPU times.

File What's inside
source/src/world.js The world layout: rock walls, arches, tunnels, kelp forests, sponge gardens, fish schools, mantas, the ship and the whale tail. A good place to start.
source/src/shaders.js The look: water and fog colors, lighting, kelp, rocks, the water surface and light rays (WGSL shader code)
source/src/main.js The renderer, the camera, the controls, the six viewpoints and the camera path the world is laid out around
source/src/audio.js The soundscape
source/src/quality.js The detail levels: which one a device starts on, and what is remembered between visits
source/src/math.js Noise, random numbers and mesh-building helpers
source/src/dev.js Development tools (fly-through and benchmark), only in dev.html
source/template.html The page around the scene: loading bar, start menu, links and their styles

Some easy first tweaks:

License

MIT: free to use, change and share, including in your own projects.

abyssal-garden (Noniv/abyssal-garden)

Searching Database…

What is this?A dreamy underwater world you can swim through in your browser, with kelp forests, sunbeams, a sunken ship and manta rays. Everything is generated by code, so there are no images, 3D models or sound files.
Is there a goal, or is it just a place to explore?The README describes a scene to explore: you swim, look around and watch the world. No goals or game mechanics are mentioned.
How do I get it running?Download index.html and open it in Chrome or Edge on a desktop computer. Wait a few seconds for the world to build, then press Dive in. There is nothing to install, and it works offline.
Which browser do I need?A browser with WebGPU support. Chrome or Edge on a desktop computer is the recommended choice. If the scene fails to start, update your browser or switch to one of those two.
Does it work on phones too?Yes, experimentally. Hold one finger down to swim forward and slide it to steer, and add a second finger to go faster. The menu button is in the corner. Phones always show the scene in landscape.
Can I reuse it in my own project?Yes. It is MIT licensed, so you can use, change and share it freely, including in your own projects.
How is the whole world built without any images or models?The seabed is sculpted on your graphics card each time the page opens, and the kelp, rocks, ship and whale tail are built from simple mathematical shapes. The sound is synthesized live with the Web Audio API.
What controls does the scene have?Move the mouse to look and use W A S D to swim, with E and Q for up and down. Hold Shift to swim faster, press 1 to 6 to jump to viewpoints, M for sound and H for performance stats. Esc opens the menu.
Can I change the scene myself?Yes. The readable source is in the source folder, and with Node.js 18 or newer you can rebuild index.html. Water colour, sunlight, brightness and swim speed are easy first tweaks.
What do the Low, Medium and High detail levels change?They use the same world with fewer leaves, sparkles and pebbles at lower levels, and Low also drops anti-aliasing and simplifies lighting. The browser remembers your level for the next visit.
Creator
Noniv
Size
1.7 MB
Stars
2.1K
Updated
CommitNov 14
Age
6d
Commits · 90 Days