From f702e8e7e0bdadb26639eb61ea9eba610a20c5e2 Mon Sep 17 00:00:00 2001 From: austin Date: Thu, 7 Mar 2024 17:12:44 -0500 Subject: [PATCH] more documentation --- .../highlevel-design/highleveldesignindex.md | 4 + .../highlevel-design/items/itemcategories.md | 169 ++++++++++++++++++ docs/src/highlevel-design/items/itemsindex.md | 6 + .../puzzles/puzzlehighlevelflow.md | 3 + .../highlevel-design/puzzles/puzzleideas.md | 11 ++ .../highlevel-design/puzzles/puzzleindex.md | 7 + docs/src/progress/renderertodo.md | 4 + 7 files changed, 204 insertions(+) create mode 100644 docs/src/highlevel-design/items/itemcategories.md create mode 100644 docs/src/highlevel-design/items/itemsindex.md create mode 100644 docs/src/highlevel-design/puzzles/puzzlehighlevelflow.md create mode 100644 docs/src/highlevel-design/puzzles/puzzleideas.md create mode 100644 docs/src/highlevel-design/puzzles/puzzleindex.md diff --git a/docs/src/highlevel-design/highleveldesignindex.md b/docs/src/highlevel-design/highleveldesignindex.md index fc8f5f54..4f6c773f 100644 --- a/docs/src/highlevel-design/highleveldesignindex.md +++ b/docs/src/highlevel-design/highleveldesignindex.md @@ -1,5 +1,7 @@ @page highleveldesignindex High Level Game Design +Discussion of, at a high game-design level, how everything should work and connect together + [TOC] - @subpage biomesindex - @subpage macroWorldPartitioning @@ -9,3 +11,5 @@ - @subpage creaturesindex - @subpage macrosimtimeline - @subpage narrativemanager +- @subpage itemsindex +- @subpage puzzleindex \ No newline at end of file diff --git a/docs/src/highlevel-design/items/itemcategories.md b/docs/src/highlevel-design/items/itemcategories.md new file mode 100644 index 00000000..808b440a --- /dev/null +++ b/docs/src/highlevel-design/items/itemcategories.md @@ -0,0 +1,169 @@ +@page itemcategories Item Categories + +raw materials categories + - ores + - stone + - dirt + - fluids + - plant materials (fruits, roots, stems, fibers, leaves, sap, liquids, flowers, seeds, logs, pollen, branch) + - minerals (eg crystals) + - gases + - animal products (milk, meat, furs, leather, wool, sinew, organs, bones, shells, eggs, honey, feathers, mandibles/teeth, horns) + +equippable items + - clothing + - armor + - shields + - weapons + - hand tools + - utensils + - jewelry + +consumables + - medicine + - poison + - augments/positions that don't heal + - food + - cheese + - prepared meet + - noodles + - grains/rices + - drinks + - SOME raw plant materials + - SOME raw animal products + +Music instruments + - Horn + - Piano + - Guitar + - Lute + - Lyre + - Harp + - Accordion + +Weapons, Melee + - Sword & variants + - Pick + - Axe + - Pitchfork + - Hammer + - Spear + - Pike + - Knife + - Mace + - Staff + - Flail + - Whip + - Scythe + - Shovel + +Weapons, Ranged + - Bow + - Crossbow + - Rifle + - Pistol + - Explosive + - Boomerang + +Gems + +Blocks + +Boulders + +Furnitures + +Chains + +Containers + - Pouches + - Liquid Bearers + - Baskets + +Toys + +Corpse + +tools + - Compass + - Lantern + - Candleholder + - Pickaxe + - Axe + - Shovel + - Pitchfork + - Hammer + - Screwdriver + - Saw + - Mirror + - Comb/Brush + - Pocketwatch + - Measuring Stick/Tape + - Writing Utensil + - Seal + - Map + - Key + +Armors + - Shields + +Ammunition + +Glob (fat, pastes/pressed objects, small amounts of molten rock) + +Medical Instruments + - Splint + - Crutch + - Bandage + - Casts + +Readables + - Books + - Scrolls + - Parchments + - Notes + - Letters + - Manuals + - Pamplets + +Currency + - Coins + - Tablets + - Notes + +Pouches + - Skins + - Bags + - Wallets + +Liquid Bearers + - Cups + - Goblets + - Jars/Small Pots + - Buckets + - Flasks + - Glasses + - Vials + +Machine Parts + - Gears + - Chains + - Wheels + - Shafts + - Lever + - Button + - Plate + - Cable + - Pipe + - Screw (liquid screw) + +Structure Materials + - Blocks + - Planks + - Walls + - Floors + - Slabs + - Stairs + - Ladders + - Rooves + - Railroad Ties \ No newline at end of file diff --git a/docs/src/highlevel-design/items/itemsindex.md b/docs/src/highlevel-design/items/itemsindex.md new file mode 100644 index 00000000..c37d3526 --- /dev/null +++ b/docs/src/highlevel-design/items/itemsindex.md @@ -0,0 +1,6 @@ +@page itemsindex Items + +Everything about items + +[TOC] + - @subpage itemcategories \ No newline at end of file diff --git a/docs/src/highlevel-design/puzzles/puzzlehighlevelflow.md b/docs/src/highlevel-design/puzzles/puzzlehighlevelflow.md new file mode 100644 index 00000000..d17ad455 --- /dev/null +++ b/docs/src/highlevel-design/puzzles/puzzlehighlevelflow.md @@ -0,0 +1,3 @@ +@page puzzlehighlevelflow Puzzle High Level Flow + +How should the gameplay flow look for puzzles \ No newline at end of file diff --git a/docs/src/highlevel-design/puzzles/puzzleideas.md b/docs/src/highlevel-design/puzzles/puzzleideas.md new file mode 100644 index 00000000..c10b7a74 --- /dev/null +++ b/docs/src/highlevel-design/puzzles/puzzleideas.md @@ -0,0 +1,11 @@ +@page puzzleideas Puzzle Ideas + +Specific ideas for puzzles + +Raise an island from a body of water to create a bridge (put spell crafter at start to craft island raising spell) + +Use spring to launch object into target + +Correctly ordering blocks to press a button + +Maze that uses teleportation spell to confuse in three dimensions \ No newline at end of file diff --git a/docs/src/highlevel-design/puzzles/puzzleindex.md b/docs/src/highlevel-design/puzzles/puzzleindex.md new file mode 100644 index 00000000..3737b353 --- /dev/null +++ b/docs/src/highlevel-design/puzzles/puzzleindex.md @@ -0,0 +1,7 @@ +@page puzzleindex Puzzles + +Everything puzzles + +[TOC] +- @subpage puzzlehighlevelflow +- @subpage puzzleideas \ No newline at end of file diff --git a/docs/src/progress/renderertodo.md b/docs/src/progress/renderertodo.md index 1df2758e..58130883 100644 --- a/docs/src/progress/renderertodo.md +++ b/docs/src/progress/renderertodo.md @@ -269,6 +269,10 @@ Terrain Chunks: - Texture atlasing (512x512) Render pipeline updates to support multiple pipelines defined in different files - Grouping meshes together independent of actor so don't have to rebind shader programs or VAOs to redraw +Loot Generator + - System that can generate items that would be appropriate reward given some variables + - ie you tell it 'this is this character's stats, this is the relative level of loot I want to provide' + - it then searches through the lore to generate appropriate weapons, armor, materials, consumables, etc