Conventions

The intent of this page is to try to define conventions to represent similar situations in a consistent way across the project.

Proposed conventions

Impossible actions

Impossible paths through a room, or doors that cannot be unlocked, can have the requirement "never" to indicate a req that can never be fulfilled.

Links from a node to itself

It's almost always possible to go from a node to itself, but sometimes coming out of an un unlocked door can still lock the player out of that same door, e.g. via crumble blocks.

We can handle this by leaving out links from a node to itself in all normal cases where there are no requirements, and only define the link if it has special requirements

Inconsistencies

Node types

Cleanup.json has doors with the nodeType "exit", while the region files usually have "door". Which one do we want to settle on?

Accepted conventions