-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome. This is the top-level landing page for all Fracturing Fog documentation. The docs are split into two audiences — pick the one that matches what you came for.
Just want to install it? See the project README for per-OS downloads and quick install steps, or the Cross-Platform User Guide for the per-OS caveats and gotchas.
You are an end user: you want to explore fractals, save views, paint them, record videos, run slideshows, type your own equations into the editor. Start here:
Highlights (full menu on the index page):
| Page | What it covers |
|---|---|
| Avalonia User Guide | Every menu, button, and dialog in the main shell. |
| Regions Guide | Save, recall, and organise favourite views. |
| Capture Guide | Screenshots, posters, PNG sequences, MP4 video export. |
| Slideshow + Audio-Reactive Guide | Cycle regions + themes on the beat with live audio. |
| Scene Engine Guide | Direct cinematic Scenes: timeline, flying camera, transitions, video. |
| Colour Theme Editor Guide | Live palette editing with the floating editor. |
| ColorGen DSL Guide | One-line palettes in a tiny domain language. |
| CalcGen / User Equation Guide | Author your own fractal formula in C# or DSL pseudo-code. |
| User Bulb 3D Guide | Mandelbulb-style 3-D fractals with raymarched DEs. |
| Relief 3D Guide + Cookbook | 2-D fractals as lit relief / oblique 3-D terrain + mesh export. |
| Volumetric Lighting Guide + Cookbook | God rays, cinematic fog, volumetric clouds — controls + recipes. |
| Client / Server Guide | Drive a heavy render from a thin client over mTLS. |
| Server Admin Guide | Configure the local render server. |
| Cross-Platform User Guide | Per-OS install + capability matrix (Windows / Linux / macOS). |
| Keyboard Shortcuts | The whole cheat-sheet. |
You are a developer or contributor: you want to read the source, ship a new fractal family, hook into the perturbation pipeline, port to a new GPU backend, or add a new shell. Start here:
→ Technical Documentation Index
Highlights (full menu on the index page):
| Page | What it covers |
|---|---|
| Architecture Overview | One-page tour of the whole solution. Read first. |
| Fractal Equation Design Guide | How to add a new fractal family end-to-end. |
| CalculatorGen Architecture + Authoring | Roslyn source-gen of perturbation calculators from DSL equations. |
| Performance Development Plan | SIMD + DD/QD/OD precision + BLA + GPU JIT roadmap. |
| Cross-Platform Roadmap + Implementation Plan | Linux / macOS port plan + per-RID smoke tests. |
| User Bulb 3D Development Plan + Sandbox DevPlan | 3-D Mandelbulb engine + user-equation sandbox. |
| PHASE2 Avalonia Migration | WinForms → Avalonia migration record. |
| Cross-Platform Smoke Tests | Per-phase manual verification matrix. |
These docs span both audiences — they describe what work is open, what shipped, and where the project is going.
| Page | Scope |
|---|---|
| Open Work Plan | Master execution plan rolling up every open item across every roadmap. |
| Performance Roadmap | Tier 1 / 2 / 3 perf wins across the render pipeline. |
| Lighting + FX Roadmap | HDR DoF, bloom, GGX importance sampling, HDRI environments. |
| Fractal Expansion Roadmap | New families (KIFS, L-systems, Apollonian, Flame, Bicomplex, …). |
| Animation Roadmap | Animated FractalParameters, Animation asset, Animation Slideshow. |
| Scene Engine Roadmap | Cinematic Scenes: timeline + camera paths, resource governor, HW tiers. |
| CalculatorGen Roadmap | Perturbation + SA + DD/QD/OD + cluster-rebase pipeline. |
| Documentation Plan | What is still being written and how to contribute. |
| Resources & Bibliography | Citations for every formula, algorithm, and paper referenced in code. |
Every page links back to either User/_Index.md or Technical/_Index.md
through a "Companion pages" line at the top. If you wandered into a
page that turns out to be the wrong altitude for what you wanted to
read, follow that companion line back to the matching index and try
again from there.
If a page reads as if it should exist but doesn't, please open an issue — the Documentation Plan tracks what is queued.