Skip to content

September 18, 2025

It is important that we spend some time exploring the repository like Indiana Jones, there are many things that were in the process of being changed (for the better) and it is important that we have documentation of all the new architecture stuff that we have done!

So the goal for today is to just create this inventory.md file that acts like a really crude 'map' of the project, and anything that we find that has not been fully implemented yet. This likely wont take too long so I'd also like to start adding some basic pages and even at least one UML diagram. Maybe we add stub pages for some things.

Here is a potential way to structure these docs

/docs
  index.md                     # 1-paragraph overview + big diagram
  /architecture
    context.md                 # C4 Context (Mermaid)
    containers.md              # C4 Containers (Mermaid)
    components.md              # Link to each system component diagram
  /systems
    input.md                   # What owns input? mapping? update loop?
    player.md                  # class diagram + seq: move/jump/attack
    combat.md                  # damage pipeline + seq & class UML
    ai.md                      # state diagram + interfaces
    ui.md                      # screens, event flow, widgets
    audio.md                   # buses, SFX triggers
    save-load.md               # serialization strategy
  /data
    scriptableobjects.md       # list types, responsibilities, relationships
    events.md                  # event bus/signals, pub-sub rules
  /scenes
    index.md                   # brief per-scene purpose, bootstrap order
  /api
    index.md                   # (DocFX output or link)
  /_scratch
    INVENTORY.md               # working list you’re converting into pages

TODO (before session)

  • Create and populate Inventory.md
  • Create stub pages for major findings in Inventory.md
  • Make at least one system sequence diagram depicting a process.

What I Worked On

  • So I started on Inventory.md and actually started indiana jonesing.
    • Project structure
    • Some systems

Roadblocks / Notes

  • So the unrefactored folder that I was so afraid of is not that bad actually. All the work I actually have to do is in ComponentFunctionality/.
  • Looking at ButtonEvents, was there any plans to turn this into a unityevent?

Next Session Goals

  • Need to finish off Inventory.md, was going too into detail I think losing my mind looking at things