From 9cea72bc2dd968a716d81b5fd23beba6cac7f5e0 Mon Sep 17 00:00:00 2001 From: Kiri Date: Sun, 3 Sep 2023 16:33:10 -0700 Subject: [PATCH] Documentation fixups. --- README.md | 15 +++++++++++++-- TODO.md | 9 ++++++--- zscript/gretchencounter.zs | 13 +++++++++++++ zscript/jumpercables.zs | 11 +++++++++++ zscript/snektech.zs | 10 ++++++++-- 5 files changed, 51 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index efc11c7..0de1346 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ TIMES as many layers of duct tape as the UAC's competing equivalent, forming a sturdier, tougher seal than any so-called "actual well-funded machine shop" could ever hope to achieve. -## Kiri's Gretchen Counter +## Gretchen Counter ![Gretchen Counter pickup sprite](sprites/gretchencounter/kgcpa0.png) @@ -53,7 +53,7 @@ The battery may be accessed (**Unload**/**Reload**) by removing the rear battery bay panel. *May exhibit erratic behavior if used with a low battery.* -## Kiri's Wiring Bypass Kit +## Wiring Bypass Kit ![Wiring Bypass Kit pickup sprite](sprites/jumpercables/jmpka0.png) @@ -118,5 +118,16 @@ Appendix D is unavailable in the Kiri's Discount Wiring Bypass Kit manual. To obtain a copy of appendix D, please purchase a subscription to Kiri's Discount Wiring Bypass Kit: Professional Edition. +## Cursed Cacodemon Plushie +![Caco plushie pickup sprite](sprites/cacoplush/cacoplushie_pickup.png) + +Some random junk we found in the bin behind SnekTech HQ. Give it to +your kid or something as a gift. + +Caution: May bite. + +### How to use + +Loadout code: kac diff --git a/TODO.md b/TODO.md index d12c116..1e43594 100644 --- a/TODO.md +++ b/TODO.md @@ -8,9 +8,12 @@ - Caco plush - ~~Caco plush spawnflags~~ - ~~Add caco plush to menu~~ - - Caco plush documentation - - Brightmaps for caco plush - - Set actual chance for caco plush spawn + - ~~Caco plush documentation~~ + - ~~Brightmaps for caco plush~~ + - ~~Set actual chance for caco plush spawn~~ + - Caco plush sprite scaling + +- Headers and comment formatting pass - Organize source_data diff --git a/zscript/gretchencounter.zs b/zscript/gretchencounter.zs index cdec994..e88dfde 100644 --- a/zscript/gretchencounter.zs +++ b/zscript/gretchencounter.zs @@ -1,3 +1,16 @@ +// ---------------------------------------------------------------------- +// Gretchen Counter +// ---------------------------------------------------------------------- +// +// This object clearly looks like it was recycled from a very old +// Geiger counter. +// +// Smells kind of like rotting meat. +// +// Try not to think about it. +// + + #include "zscript/snektech.zs" const HDLD_KIRI_GRETCHENCOUNTER = "kgc"; diff --git a/zscript/jumpercables.zs b/zscript/jumpercables.zs index 4848e3a..63a3848 100644 --- a/zscript/jumpercables.zs +++ b/zscript/jumpercables.zs @@ -1,3 +1,14 @@ +// ---------------------------------------------------------------------- +// Wiring Bypass Kit +// ---------------------------------------------------------------------- +// +// This is just a pile of electronics maintenance equipment. The usual +// stuff is here, like electrical tape, wire cutters, etc. +// +// There's also a meter that looks like it was made out of some beat +// up piece of equipment, and held together with duct tape. +// + const HDLD_KIRI_JUMPERCABLES = "jmp"; const jumperCablesRaycastRange = 48; // Same range as the DERP. diff --git a/zscript/snektech.zs b/zscript/snektech.zs index 6070518..8f67551 100644 --- a/zscript/snektech.zs +++ b/zscript/snektech.zs @@ -1,3 +1,10 @@ +// ---------------------------------------------------------------------- +// Snektech +// ---------------------------------------------------------------------- +// +// Spawn flags for SnekTech items handled here. +// + enum SnekTechSpawnFlags { SNEKTECH_GRETCHENCOUNTER = 0, @@ -98,8 +105,7 @@ class SnekTechEventHandler : EventHandler DoSnekTechReplacement( SNEKTECH_CACOPLUSHIE, "BlurSphere", "KiriCacodemonPlushie", - // FIXME: Chance. - 256, e); + 6, e); } }