search

davidtcalabrese / minnetonka

a project to practice collaboration on github
0 stars 1 forks source link

Document the room layout and logical connections between each #6

Open EmbeddedMan opened 3 years ago

EmbeddedMan commented 3 years ago

For now probably just in a table in a big comment block at the top of the file.

davidtcalabrese commented 3 years ago

I found this lucid website that let's you make diagrams and I started sketching out the options we have so far.

You're right though, it would probably be best to just start with what's in each room and then create a flowchart type thing once we have a better idea where this is going. flowchart.pdf

EmbeddedMan commented 3 years ago

Cool! I can see this going into a "docs/" folder in the repo to document the code. But it should be in a format that can be edited, not PDF. So for example *.graphml (for yEd).

EmbeddedMan commented 3 years ago

I feel like the first thing I need to do here is get the physical room layout down, with each 'stoppable' area in the game named (nodes) and each link defined between the room/area labeled (edges). That's my task for today.

EmbeddedMan commented 3 years ago

OK, first pass at documenting what we have now in graph form. What I added (docs/GameLoic.graphml) is lacking much of the information of your PDF, but it's a start, and it reflects the current state of the game. Rooms, Game Overs and connections between rooms are documeted.

EmbeddedMan commented 3 years ago

BTW, the free tool I used to create the graphml file is called yEd and it's very common for software folks who don't want to pay for Visio. https://www.yworks.com/products/yed

It takes a little getting used to, but for basic stuff like state diagrams and flowcharts it's super quick to whip out something that looks pretty good.