From 177c409e19c902c99567e76b07d16677ca0f5b37 Mon Sep 17 00:00:00 2001
From: tildearrow <tildearrow@protonmail.com>
Date: Sun, 6 Mar 2022 22:36:32 -0500
Subject: [PATCH] add more notes when working with new systems

---
 src/engine/dispatch.h   | 6 ++++++
 src/engine/instrument.h | 3 +++
 src/engine/playback.cpp | 1 +
 3 files changed, 10 insertions(+)

diff --git a/src/engine/dispatch.h b/src/engine/dispatch.h
index 300b0033b..e697cccbe 100644
--- a/src/engine/dispatch.h
+++ b/src/engine/dispatch.h
@@ -29,6 +29,12 @@
 
 #define addWrite(a,v) regWrites.push_back(DivRegWrite(a,v));
 
+// HOW TO ADD A NEW COMMAND:
+// add it to this enum. then see playback.cpp.
+// there is a const char* cmdName[] array, which contains the command
+// names as strings for the commands (and other debug stuff).
+//
+// if you miss it, the program will crash or misbehave at some point.
 enum DivDispatchCmds {
   DIV_CMD_NOTE_ON=0,
   DIV_CMD_NOTE_OFF,
diff --git a/src/engine/instrument.h b/src/engine/instrument.h
index 27ce2a4ce..a0d37523e 100644
--- a/src/engine/instrument.h
+++ b/src/engine/instrument.h
@@ -23,6 +23,9 @@
 #include "dataErrors.h"
 #include "../ta-utils.h"
 
+// NOTICE!
+// before adding new instrument types to this struct, please ask me first.
+// absolutely zero support granted to conflicting formats.
 enum DivInstrumentType {
   DIV_INS_STD=0,
   DIV_INS_FM=1,
diff --git a/src/engine/playback.cpp b/src/engine/playback.cpp
index f0f43dc1a..7114a7c2a 100644
--- a/src/engine/playback.cpp
+++ b/src/engine/playback.cpp
@@ -42,6 +42,7 @@ const char* notes[12]={
   "C-", "C#", "D-", "D#", "E-", "F-", "F#", "G-", "G#", "A-", "A#", "B-"
 };
 
+// update this when adding new commands.
 const char* cmdName[DIV_CMD_MAX]={
   "NOTE_ON",
   "NOTE_OFF",