scallyw4g · scallyw4g · Feb 16, 2025 · Feb 16, 2025 · Feb 18, 2025 · Feb 19, 2025
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,8 @@ levels/
 
 brushes/_untitled.brush
 
+runtime_settings/*
+
 bin/
 tmp/
 

diff --git a/assets/white.bmp b/assets/white.bmp
diff --git a/brushes/black_castle_wall.brush b/brushes/black_castle_wall.brush
diff --git a/brushes/black_castle_wall_broken.brush b/brushes/black_castle_wall_broken.brush
diff --git a/brushes/black_castle_wall_rough.brush b/brushes/black_castle_wall_rough.brush
diff --git a/brushes/dirt_path.brush b/brushes/dirt_path.brush
diff --git a/brushes/eraser.brush b/brushes/eraser.brush
diff --git a/brushes/foliage.brush b/brushes/foliage.brush
diff --git a/brushes/granite_wall.brush b/brushes/granite_wall.brush
diff --git a/brushes/granite_wall_paint.brush b/brushes/granite_wall_paint.brush
diff --git a/brushes/grass.brush b/brushes/grass.brush
diff --git a/brushes/small_gravel.brush b/brushes/small_gravel.brush
diff --git a/brushes/spackled_base.1.brush b/brushes/spackled_base.1.brush
diff --git a/brushes/spackled_base.brush b/brushes/spackled_base.brush
diff --git a/brushes/spackled_stone.1.brush b/brushes/spackled_stone.1.brush
diff --git a/brushes/spackled_stone.brush b/brushes/spackled_stone.brush
diff --git a/brushes/spackled_stone_green.1.brush b/brushes/spackled_stone_green.1.brush
diff --git a/brushes/spackled_stone_green.brush b/brushes/spackled_stone_green.brush
diff --git a/brushes/spackled_stone_green2.brush b/brushes/spackled_stone_green2.brush
diff --git a/brushes/stone_path.brush b/brushes/stone_path.brush
diff --git a/brushes/test.brush b/brushes/test.brush
diff --git a/brushes/vines.brush b/brushes/vines.brush
diff --git a/brushes/wood_horizontal.brush b/brushes/wood_horizontal.brush
diff --git a/brushes/wood_horizontal.brushdw.brush b/brushes/wood_horizontal.brushdw.brush
diff --git a/brushes/wood_vertical.1.brush b/brushes/wood_vertical.1.brush
diff --git a/brushes/wood_vertical.brush b/brushes/wood_vertical.brush
diff --git a/brushes/wooden_door.1.brush b/brushes/wooden_door.1.brush
diff --git a/brushes/wooden_door.brush b/brushes/wooden_door.brush
diff --git a/ctags.sh b/ctags.sh
@@ -0,0 +1,4 @@
+#! /usr/bin/env bash
+
+# This tells ctags abouit the poof macro, which frequently confuses its parser
+ctags -R -I poof+ .
diff --git a/docs/00_getting_started.md b/docs/00_getting_started.md
@@ -0,0 +1,25 @@
+
+# Getting Started
+
+## Prebuilt Binaries
+
+The fastest way to get started with Bonsai is to grab the prebuilt binaries from
+the [Latest Releases](../../releases/latest) page.  Windows and Linux are supported.
+
+
+## Running an Example
+
+Bonsai ships with several pre-built example projects, under the `bin/game_libs`
+folder.  To run an example, simply launch `bin/game_loader.exe` and select the
+example from the menu presented.  Alternatively, you may specify which example
+to run from a command line as an argument.  For example,
+`bin/game_loader.exe bin/game_libs/terrain_gen_loadable.dll`
+
+## Terrain Generation
+
+The terrain_gen example provides users with a convenient playground for
+experimenting with terrain generation.  Just fire up your favorite editor,
+navigate to `shaders/terrain/shaping/default.fragmentshader`, and edit away!
+Terrain shaders hot-reload, so you have a fast edit-compile-run loop for
+experimentation.
+
diff --git a/docs/controls.md b/docs/controls.md
@@ -0,0 +1,64 @@
+# Legend
+
+This is notation for the single keystroke 'a'
+```
+a
+```
+
+This is notation for a single keystroke of any of 'w', 'a', 's', 'd', 
+```
+wasd
+```
+
+This is notation for the chord 'Ctrl + s'
+```
+<C-s> 
+```
+
+This is notation for the chord 'Alt + Shift + s'
+```
+<A-S-s> 
+```
+
+
+# General
+
+`f1` : toggle debug menu
+
+`escape` : load "project\_and\_level\_picker", or quit
+
+# Camera Controls
+
+`wasd` : move camera on a horizontal plane
+
+`q` : move camera down
+
+`e` : move camera up
+
+hold `rmouse` : rotate camera
+
+
+# Editor
+
+Select the 'World Edit' tab from the top menu
+
+`<C-s>` : Begin area selection
+
+`lclick` : Finish area selection
+
+`<C-g>` : Center camera on selection
+
+`<C-lclick>` : Multi-select
+
+## With area selected
+
+`<S-lclick>` : Scale along axis
+
+`<S-C-lclick>` : Scale along axis; both sides
+
+`<S-C-A-lclick>` : Scale along all axies
+
+`<A-lclick` : Translate in plane
+
+`<A-C-lclick>` : Translate along axis
+
diff --git a/docs/editor.md b/docs/editor.md
@@ -0,0 +1,51 @@
+# Editor
+
+To enter world edit mode, select "World Edit" from the menu in the top-left corner
+of the screen.
+
+## Brushes
+
+Brushes are the backbone of the world editing system.  Brushes describe how a
+world edit affects the selected area.
+
+### Creation
+
+To create a brush, select "New" from the "Brush Settings" window.
+
+### Brush Settings Window
+
+Here we'll detail each option in the "Brush Settings window, in order.
+
+* Brush Name
+  The name of the brush, on disk.
+
+* Layer Count
+  The number of layers the brush has
+
+* Affect World
+  Should the brush interact with voxels from world-gen, or strictly voxels from
+  edits.
+
+---
+
+### ----- LAYERS ------
+
+* Brush Type : Noise | Shape
+  Changes the type of the brush
+
+* Brush Type(Noise)
+    * Noise Type : Perlin | Voronoi | White
+
+
+* Value Modifier
+    * ClampPos : max(0, sample), after applying ValueBias and Power
+    * ClampNeg : min(0, sample), after applying ValueBias and Power
+    * Threshold : Set sample to 0 if it does not pass threshold, before Power and ValueBias
+    * Discard : Set sample to 0
+
+* Blend Mode
+    * Additive    : output = sample + previous
+    * Subtractive : output = previous - sample
+    * Multiply    : output = previous * sample
+    * Threshold   : output = sample > threshold ? threshold : sample
+    * Disabled    : output = output
diff --git a/docs/world_gen.md b/docs/world_gen.md
@@ -0,0 +1,40 @@
+# World Generation
+
+Terrain generation in Bonsai is composed of several stages, some of which are
+user reconfigurable.  The stages are as follows:
+
+1. Terrain Shaping
+2. Terrain Normal Calculation
+3. Terrain Decoration
+5. World Edit applications
+6. Meshing
+7. Drawing
+
+
+Stages (1) and (3) are easily configurable by users of the engine.  There is an
+example project named `terrain_gen` that makes it easy to switch between
+different shaping and decoration shaders.
+
+
+## Terrain Shaping
+
+The Terrain Shaping stage is typically responsible for the overall shape of the
+terrain.  Set the `NoiseValue` and `ColorValue` variables inside the block
+marked ` -- user code -- ` to any values you like.  A final value above zero is
+solid, a value below zero is air.
+
+To add a new Terrain Shaping shader, copy `shaders/terrain/shaping/default.fragmentshader`
+to a new file in the same directory. 
+
+
+## Terrain Decoration
+
+The Terrain Decoration stage has the `NoiseValue` and `ColorValue` passed through
+from the previous Shaping stage, as well as an additional `NormalValue`, which
+is the normal to the surface at that point.  The Terrain Decoration stage is
+typically used to apply small details, coloring, and texturing to the final terrain.
+
+To add a new Terrain Decoration shader, copy `shaders/terrain/decoration/default.fragmentshader`
+to a new filename in the same directory.
+
+
diff --git a/dottedboxguy.make.sh b/dottedboxguy.make.sh
@@ -0,0 +1,7 @@
+#! /usr/bin/env bash
+
+# OPT="-O2"
+
+./make.sh $OPT                                                 \
+  BuildSingleExample examples/terrain_gen                      \
+  BuildExecutables                                             \
diff --git a/examples/blank_project/game.cpp b/examples/blank_project/game.cpp
@@ -2,8 +2,6 @@
 #define BONSAI_DEBUG_SYSTEM_API 1
 
 #include <bonsai_types.h>
-
-#include <game_constants.h>
 #include <game_types.h>
 
 // NOTE(Jesse): This is an optional function that gets called for each worker
@@ -32,8 +30,10 @@ BONSAI_API_WORKER_THREAD_CALLBACK()
     // NOTE(Jesse): Render commands should never end up on a general purpose work queue
     InvalidCase(type_work_queue_entry__bonsai_render_command);
 
+    case type_work_queue_entry_build_chunk_mesh:
+    case type_work_queue_entry_finalize_noise_values:
     case type_work_queue_entry_async_function_call:
-    case type_work_queue_entry_update_world_region:
+    /* case type_work_queue_entry_update_world_region: */
     case type_work_queue_entry_rebuild_mesh:
     case type_work_queue_entry_init_asset:
     case type_work_queue_entry_init_world_chunk:
@@ -68,9 +68,9 @@ BONSAI_API_MAIN_THREAD_INIT_CALLBACK()
   world_position WorldCenter = {};
   canonical_position CameraTargetP = {};
 
-  StandardCamera(Graphics->Camera, 10000.0f, 1000.0f);
+  StandardCamera(Graphics->Camera, 30000.0f, 1000.0f);
 
-  AllocateWorld(World, WorldCenter, WORLD_CHUNK_DIM, g_VisibleRegion);
+  AllocateWorld(World, WorldCenter, VisibleRegionSize_128);
 
   GameState = Allocate(game_state, Resources->GameMemory, 1);
   return GameState;

diff --git a/examples/blank_project/game_constants.h b/examples/blank_project/game_constants.h
diff --git a/examples/project_and_level_picker/game.cpp b/examples/project_and_level_picker/game.cpp
@@ -1,6 +1,4 @@
 #include <bonsai_types.h>
-
-#include <game_constants.h>
 #include <game_types.h>
 
 BONSAI_API_WORKER_THREAD_CALLBACK()
@@ -17,8 +15,10 @@ BONSAI_API_WORKER_THREAD_CALLBACK()
       Result = True;
     } break;
 
+    case type_work_queue_entry_build_chunk_mesh:
+    case type_work_queue_entry_finalize_noise_values:
     case type_work_queue_entry_async_function_call:
-    case type_work_queue_entry_update_world_region:
+    /* case type_work_queue_entry_update_world_region: */
     case type_work_queue_entry_rebuild_mesh:
     case type_work_queue_entry_init_asset:
     case type_work_queue_entry_copy_buffer_ref:
@@ -33,9 +33,9 @@ BONSAI_API_MAIN_THREAD_INIT_CALLBACK()
 {
   UNPACK_ENGINE_RESOURCES(Resources);
 
-  AllocateWorld(World, {}, WORLD_CHUNK_DIM, g_VisibleRegion);
-
+  AllocateWorld(World, {}, VisibleRegionSize_128);
   GameState = Allocate(game_state, Resources->GameMemory, 1);
+
   return GameState;
 }
 

diff --git a/examples/project_and_level_picker/game_constants.h b/examples/project_and_level_picker/game_constants.h
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,8 @@ levels/ @@
     brushes/_untitled.brush
+    runtime_settings/*
     bin/
     tmp/
@@ Expand Down @@