module

Bakelite::Docs

The Bakelite::Docs module is the authoritative technical reference and documentation guide.

Learning Tracks & Topic Index

The documentation is paced into 6 distinct tracks:

1. Overview (A_OVERVIEW)

Submodule Title Description
INTRODUCTION Introduction to Bakelite High-performance virtual filesystem and binary container engine for Crystal.

2. Architecture (B_ARCHITECTURE)

Submodule Title Description
CHUNKING_AND_IO Chunking and Streaming IO Architecture of bounded-memory streaming and random access IO.

3. Dsl (C_DSL)

Submodule Title Description
MACROS_AND_VOLUMES Compile-Time DSL and Volumes Using Bakelite macros to embed and organize assets in code.

4. Containers (D_CONTAINERS)

Submodule Title Description
BINARY_CONTAINERS Binary Containers and CLI Toolchain Post-compile executable overlay and standalone archive manipulation.

5. Scale (E_SCALE)

Submodule Title Description
LARGE_ASSET_STREAMING Large Asset Streaming and Scale (100MB & 1GB) Memory bounds, streaming architecture, and scale testing for massive assets.

6. Concurrency (F_CONCURRENCY)

Submodule Title Description
THREAD_SAFETY Concurrency and Thread Safety Thread-safe container sharing, multi-fiber reads, and synchronized IO.

Class methods

topic_01_quick_start

Quick-Start Commands: Essential commands for building, running, and testing.

Bakelite Quick Start:

shards install
crystal spec
bin/bakelite pack bin/game.exe assets/ --mount assets
Source
topic_02_reading_paths

Learning Tracks & Reading Paths: Curated reading order from beginner to advanced.

Structured Learning Tracks

1. Overview (A_OVERVIEW)
  • A_OVERVIEW::INTRODUCTION: Introduction to Bakelite — High-performance virtual filesystem and binary container engine for Crystal.
2. Architecture (B_ARCHITECTURE)
  • B_ARCHITECTURE::CHUNKING_AND_IO: Chunking and Streaming IO — Architecture of bounded-memory streaming and random access IO.
3. Dsl (C_DSL)
  • C_DSL::MACROS_AND_VOLUMES: Compile-Time DSL and Volumes — Using Bakelite macros to embed and organize assets in code.
4. Containers (D_CONTAINERS)
  • D_CONTAINERS::BINARY_CONTAINERS: Binary Containers and CLI Toolchain — Post-compile executable overlay and standalone archive manipulation.
5. Scale (E_SCALE)
  • E_SCALE::LARGE_ASSET_STREAMING: **Large Asset Streaming and Scale (100MB & 1GB)** — Memory bounds, streaming architecture, and scale testing for massive assets.
6. Concurrency (F_CONCURRENCY)
  • F_CONCURRENCY::THREAD_SAFETY: Concurrency and Thread Safety — Thread-safe container sharing, multi-fiber reads, and synchronized IO.
Source
topic_03_table_of_contents

Master Table of Contents: Complete hierarchical topic index.

Complete Documentation Index

A_OVERVIEW
  • A_OVERVIEW::INTRODUCTION: Introduction to Bakelite — High-performance virtual filesystem and binary container engine for Crystal.
B_ARCHITECTURE
  • B_ARCHITECTURE::CHUNKING_AND_IO: Chunking and Streaming IO — Architecture of bounded-memory streaming and random access IO.
C_DSL
  • C_DSL::MACROS_AND_VOLUMES: Compile-Time DSL and Volumes — Using Bakelite macros to embed and organize assets in code.
D_CONTAINERS
  • D_CONTAINERS::BINARY_CONTAINERS: Binary Containers and CLI Toolchain — Post-compile executable overlay and standalone archive manipulation.
E_SCALE
  • E_SCALE::LARGE_ASSET_STREAMING: **Large Asset Streaming and Scale (100MB & 1GB)** — Memory bounds, streaming architecture, and scale testing for massive assets.
F_CONCURRENCY
  • F_CONCURRENCY::THREAD_SAFETY: Concurrency and Thread Safety — Thread-safe container sharing, multi-fiber reads, and synchronized IO.
Source

Nested types