WaterBox Demo (godot-waterbox-demo)

This repository is a playable Godot 4 demo project for the WaterBox addon.

It shows how to configure a water volume, how buoyancy behaves with and without marker-based points, and how drag affects floating rigid bodies.

Purpose

Use this project as:

• A reference setup for integrating WaterBox into your own game.
• A sandbox for tuning water_density and water_drag.
• A quick visual check for addon behavior after updates.

Requirements

• Godot 4.x
• 3D physics project using RigidBody3D

Compatibility note:

• Tested on Godot 4.0.1.
• It may work on other 4.x releases, but this is not guaranteed.

Quick Start

1. Open this repository folder in Godot.
2. Ensure plugin WaterBox is enabled:
   • Project > Project Settings > Plugins
3. Run the project.

Default startup scene:

• res://levels/sample_1.tscn

Demo Scenes

• levels/sample_1.tscn

  • Multiple floating prefabs (floating_cube, floating_capsule)
  • Demonstrates general floating behavior with preconfigured buoyancy markers

• levels/sample_2.tscn

  • Single RigidBody3D capsule with a local BuoyancyComponent
  • Good for testing marker-based setup in a minimal environment

WaterBox Setup Used In This Demo

Minimal node hierarchy:

1. Node3D with script res://addons/waterbox/scripts/water_box.gd
2. Child Area3D
3. CollisionShape3D under Area3D

WaterBox tracks bodies entering the Area3D and applies:

• Buoyancy force
• Water drag damping

Project Structure

.
|-- addons/
|   `-- waterbox/                 # Addon plugin, scripts, prefabs, materials
|-- assets/                       # Demo materials and shaders
|-- docs/
|   |-- addon/
|   |   |-- installation.md
|   |   `-- api_reference.md
|   `-- demo/
|       `-- overview.md
|-- levels/
|   |-- sample_1.tscn
|   `-- sample_2.tscn
|-- project.godot
`-- README.md

Documentation Index

• Addon installation: docs/addon/installation.md
• Addon API: docs/addon/api_reference.md
• Demo overview: docs/demo/overview.md

License

Distributed under the terms in LICENSE.