Samuel Bouchet c9f8a9566a Add adventure secret branches, Destiny finale, crafting system, and project docs

Integrate stats, resources, and cosmetics into adventures via conditional
branches gated by game state checks. Each of the 9 adventures now has a
secret branch that rewards exploration and encourages replay with subtle
hints on locked choices. The endgame box now triggers a Destiny adventure
that acknowledges all completed adventures and secret branches, with four
ending tiers culminating in an ultimate ending when all 9 secrets are found.

Also adds the crafting engine, CLAUDE.md and specifications.md for faster
onboarding.

2026-03-11 17:50:37 +01:00

2.4 KiB

Raw Blame History

Open The Box

Project Overview

A console-based incremental/idle game built in C# (.NET 9) where players open boxes to discover items, unlock features, and progress through themed adventures. Uses Spectre.Console for rich terminal rendering and Loreline for interactive narrative scripting.

Architecture

See specifications.md for detailed content organization.

Key Directories

src/OpenTheBox/ — Main game source code
content/data/ — JSON data files (items, boxes, crafting recipes)
content/adventures/ — Loreline .lor adventure scripts (one folder per theme)
content/localization/ — Translation files

Source Code Structure

Core/ — Game state, enums, item/character models
Core/Enums/ — All enum types (StatType, ResourceType, AdventureTheme, CosmeticSlot, etc.)
Adventures/ — AdventureEngine (Loreline bridge + custom functions)
Simulation/ — Game engines (BoxEngine, MetaEngine, ResourceEngine, CraftingEngine, GameSimulation)
Rendering/ — IRenderer interface, SpectreRenderer, RenderContext, panel components
Rendering/Panels/ — Individual UI panels (PortraitPanel, ResourcePanel, StatsPanel, etc.)
Data/ — ContentRegistry, ItemDefinition, BoxDefinition data loading
Persistence/ — SaveManager, SaveData (JSON serialization)
Localization/ — LocalizationManager, Locale enum

Build & Run

dotnet build
dotnet run --project src/OpenTheBox

Test

dotnet test

Adventure System

Adventures use Loreline .lor script format. Custom functions available in scripts:

Inventory: grantItem(id, qty), hasItem(id), removeItem(id)
Resources: hasResource(name, min), getResourceValue(name), addResource(name, amount)
Stats: hasStat(name, min), getStatValue(name)
Cosmetics: hasCosmetic(id), hasEquipped(slot, style)
Progression: hasCompletedAdventure(theme), markSecretBranch(id), hasSecretBranch(id), countSecretBranches(), allSecretBranches()

Hints for disabled choices use ||| separator: Option text|||Hint text #label [if condition]

Conventions

C# 12 with file-scoped namespaces, primary constructors where appropriate
Immutable records for value types, sealed classes for services
GameState is mutable, passed by reference to engines
All user-facing strings go through LocalizationManager
Enum names match JSON string values (PascalCase)

2.4 KiB Raw Blame History