The official formatting and documentation standard for all Midnight Waterz codebases (Google Apps Script, HTML, CSS). All Builder Surfers must use these Tags to ensure the ecosystem remains readable, secure, and immersive.
The Master Header (SECTION / CHUNK)
Every major function must be broken into numbered SECTIONS. Every smaller mechanism within a section must be broken into CHUNKS. Bounded by === lines.
[ LORE ]
The thematic, in-universe explanation of what the code is doing (e.g., "The Vault's front door."). Keeps the developer immersed in the Syndicate reality.
[ LOGIC ]
The literal, technical explanation of the code (e.g., "Checks the PIN against the Directory array.").
Edit Risk: (Traffic Light System)
π΄ HIGH: Core engine math or database routing. Do not touch unless authorized.
π‘ MEDIUM: Logic pathways. Edit with extreme caution.
π’ LOW: UI, text, and colors. Safe for junior builders to tweak.
Lead Dev: [ NAME ]
Identifies who wrote the chunk, so the team knows who to ask if it breaks.
π§― IF IT BREAKS:
A quick troubleshooting tip for the most likely failure point (e.g., "Check if the Google Sheet ID changed.").
ποΈ Tweak Zone:
Highlights variables (like XP payouts, costs, or colors) that are 100% safe to change for game balancing.
Example :
π¨ UI Beacon:
Marks any code that physically renders on the player's screen (HTML/CSS blocks).
Example :
π§ Path A / B / C:
Used to map out If/Else statements so the logic branches are easy to read.
Example :
πΎ RNG Engine:
Marks any code that uses Math.random() to generate loot or unpredictable events.
Example :
π₯ System Event:
Marks a massive, global trigger (like sending a team-wide email or triggering an Overclock).
Example :
"What you do today can improve all your tomorrows."