establish code standards/conventions

[jackmakesthings]

Main areas I'm starting to see fragmentation:

• [x] Filenames: NPC vs _NPC?
• [x] Filename suffixes: .example, .draft, .Manager, etc
• [x] General naming: functions, vars

Should do this soon - while the number of scripts/files is still manageable.

[jackmakesthings]

Current filename conventions (work in progress):

• Singletons and their scripts don't start with underscores.
  Inventory.gd
Utils.gd
Dialogue.gd / Dialogue.tscn *
• Classes that are designed to be extended/instanced multiple times get the underscore.
  _Item.gd
_NPC.gd
_Environment.gd
• Classes that can be instanced, then, will typically end up with two scripts associated with them: the root class definition starts with an underscore, while an individual script on the instance should not.
  Example:
  _Environment.gd = all the essential environment functions
  _Environment.tscn = template scene, demonstrates the tree any _Environment should use.
  Laboratory.tscn = unique instance scene, based on _Environment.tscn
Laboratory.gd = script on the base node of Laboratory.tscn; extends _Environment.gd.

*note: this one's not implemented yet, might rename to MessageUI and get the UI more like the previous version first

• Suffixes in use:
  • .draft.tscn for works in progress that are close enough to done to move out of /sandbox
  • .Manager.tscn for managing nodes (used by Quest and NPC currently)
  • .example.tscn - should probably drop this one and let it be implied by the other conventions
  • .test.tscn - this needs to be either standardized or dropped. maybe rename to .spec, or switch .spec.gd to test.gd
  • .spec.gd for script test suites

[jackmakesthings]

Code conventions (also a work in progress):