Getting READMEs in place.

This commit is contained in:
Kiri 2023-09-03 08:54:18 -07:00
parent fbb8dca2b3
commit 7f0519fd6d
2 changed files with 101 additions and 0 deletions

19
LICENSE Normal file
View File

@ -0,0 +1,19 @@
Copyright (c) 2023 Kiri Jolly
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

82
README.md Normal file
View File

@ -0,0 +1,82 @@
# SnekTech Discount Party Pack
Are you tired of cheaply manufactured space-age trash churned out by
the Union Aerospace Corporation? Tired of the same identical piece of
equipment kludged together with correct tolerances and specifications?
Looking for a more hand-crafted, artisian tool, harkening back to a
more civilized time? Want a real change to remind you of better days?
Introducing the SnekTech Discount Party Pack! A pack of three
hand-made, finely crafted pieces of equipment, designed to keep YOU
alive on ANY budget!
You can tell the quality difference! Our equipment has up to THREE
TIMES as many layers of duct tape as the UAC's competing equivalent,
forming a sturdier, tougher seal than any so-called "actual machine
shop" could ever hope to achieve.
## Kiri's Wiring Bypass Kit
Have you ever been stuck in Hell because you accidentally blew up a
switch to an important locked door?
Couldn't leave the UAC HQ after giving your two weeks in the form of
too much heavy ordnance, because you broke the elevator?
Can't make it through that broken teleporter to the sweet, sweet
freedom of the end of the level?
Well, have I got the solution for YOU!
### Kiri's Discount Wiring Bypass Kit!
Temporarily restore power to broken electronics (or creepy hellish
teleporter alien magic things) with this handy dandy kit.
Just use this ~~stud finder~~ Wiring Fault Detection Unit to find the
location of a broken ~~linedef~~ internal mechanism, and use the
accompanying TURBO WIRE CUTTER 9000 brand wire strippers, along with a
standard battery, some electrical tape, some wire, and flagrant
disregard for personal safety, and you can make that broken teleporter
into your very own ~~teleporter accident~~ functioning teleporter!
(Batteries NOT included.)
### How to use
Loadout code: jmp
Use the Wiring Bypass Kit item as an inventory item. Approach a broken
switch, teleporter, or other mechanism, and aim the device at the area
of the breakage. It may take a moment to find a repairable fault.
The Wiring Fault Detection Unit has three LEDs indicating the
detection status:
- Red: There is a broken mechanism, that can be repaired.
- Green: Everything is functioning as implemented.
- Yellow: Not close enough to make a determination. Approach the
mechanism.
The LCD indicator can detect the exact nature of the faulty mechanism.
See appendix D for a list of codes.
Once a faulty mechanism has been located, you may attach a charged
battery to the mechanism to temporarily restore some functionality to
it.
Note: Some mechanisms cannot be repaired through simple wiring bypass,
such as doors or elevators, if the damage is on the mechanism itself,
instead of a switch or other remote activator.
TODO: Remove any language not corporate-aligned, such as "teleporter
accident" and "mechanism".
### Appendix D
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.