Cyborg module guidelines + cyborg whitelisted hands

src/SUMMARY.md

@@ -288,6 +288,8 @@ Space Station 14
 
 		- [Proposals]()
 			- [Lawset Modification](en/space-station-14/departments/silicon/proposals/lawset_modification.md)
+          	- [Cyborg Module Guidelines](en/space-station-14/departments/silicon/proposals/cyborg_modules_guidelines.md)
+            - [Cyborg Whitelisted 'Hands'](en/space-station-14/departments/silicon/proposals/silicon_hand_whitelist.md)
 
 General Proposals
 ================

src/en/space-station-14/departments/silicon/proposals/cyborg_modules_guidelines.md

@@ -0,0 +1,86 @@
+||VERY WIP||  
+||I'm not sure how to write comments, so I might be just doing those lines||  
+||It currently contains the info I think should be put in to this doc, and later it shall be discussed with #silicon maintainers||  
+||TODO:||
+- Module clusters - how many slots should be in each module, how to split all the items/slots for a Cyborg for each module, how many modules slots Cyborg should have
+- Evil modules - Antagonist exclusive modules: Xenoborg, Syndicate Cyborg modules
+- what items can be whitelisted
+- when to use a hand slot and alternatively make it an item
+- unique Cyborg items and when you should add them/ make them
+
+||Ideas and drafts:||  
+||
+- If a slot allows for carrying a lot of diverse materials, it should be whitelisted (produce, materials, tiles, etc.)
+- If a slot holds unique Cyborg tooling (upgraded buckets, stronger versions of items that are not possible to acquire by crew) it should be an unremovable
+- A small amount of whitelisted hands for things like tools may be allowed, but only if having hand-per-tool would cause the amount of hands to be unreasonably big
+- Any whitelisted hand should only allow for items from a single category, a whitelist hand cannot for example hold materials AND tiles, those would have to be 2 separate hands  
+
+||
+
+||Actual start of the document:||
+
+# Cyborg modules guideline
+
+This document is about guidelines on how to create or modify Cyborg modules
+It was created because of the lack of consistency and quality between Cyborg modules
+Those guidelines are to help figuring out how to structure singular modules or structure whole specialized Cyborg modules.  
+
+## Cyborg modules
+Cyborg modules are an item that is designed to inserted in to a cyborg that grants them items or slots they can use.
+Most modules are already build into a Cyborg when selecting a chassis or spawning in, in cases of derelicts, Xenoborgs and
+Syndicate Cyborgs. Some modules have to be fabricated in exosuit fabricator usually located in robotics/science department, 
+fabricated in Xenoborg core or bought through an uplink. Cyborgs drop all their modules on the floor when destroyed.
+Modules can be looked at or added from a cyborg if their maintenance panel is open, but not always remove them  
+Some modules provide items that are strictly better than humanoid counterpart and usually have infinite uses with regenerative delay
+
+## Module slots
+Module slots are the primary way Cyborgs interact with their environment.
+
+Slots are the Cyborg equivalent of humanoid hands, but unlike hands, they are fixed loadouts that the Cyborg must cycle through to use. Since Cyborgs lack conventional equipment slots for additional inventories like humanoids, this is the main way they "store" items for them to use around their environment. 
+
+There are two types of slots in a module:
+- An embedded tool that cannot be removed from the module.
+- A whitelisted 'hand' slot in which only specific items can be picked up and dropped.
+
+When making slots, a few precautions must be taken:
+
+### For embedded slots:
+- Ensure the item is thematically related to the module it is a part of, filling a "gardening module" with a crowbar does not make sense as the crowbar has no gardening functionality.
+- Do not use items that require deployment to function, the point of the tool is that it integrated into the Cyborg, if it must be detachable, a whitelisted 'hand' is better suited for it.
+- Do not use items that are consumable or have limited use, if the item gets exhausted, the slot would be rendered useless for the remainder of the slot's installation.
+- If an existing exhaustable item is a perfect candidate for a slot, make a new self-sufficient or renewable variant for Cyborg exclusive use.
+
+### For 'hands':
+- Ensure the 'hand' slots are restricted in what they can hold, if a hand lacks any restriction, it bypasses limitations that Cyborgs are designed around.
+- Do not use categories that are too broad, having a "medical" 'hand' is too vague and involves whitelisting many functionally unrelated items.
+- Use narrow item categories that have too many options to be embedded in a reasonable amount of slots, like instruments, topical medicine, and construction materials.
+- Never put Cyborg exclusive technology in a whitelisted 'hand', even if a superior version of it exists, Cyborg exclusive items are meant to stay in the modules.
+
+## Generic modules
+Generic modules are modules that can fit into any chassis, regardless of model.
+
+A generic module can be fit into any Cyborg and come in a variety of designs, 
+(tools, jet modules for space movement, module for carrying materials without an ability to use them)  
+Specialized modules are modules that are only designed to fit in to one type of Cyborg chassis.
+
+Generic modules:
+- should contain item/slots that aren't department locked and are of general use ||what is general use|| to cyborgs. (tools, jet modules for space movement)
+- ||add more examples||
+
+Specialized modules:
+- Should fit the theme of the department in which they are specialized in
+- Should include the tools that department usually use ||maybe add examples||
+- ||add more examples||
+
+### Upgrade modules
+Some research unlocks an upgraded version of modules. Those modules are only specialized and that is the only upgrade 
+to them.  
+- Upgraded modules should do everything that its predecessor could do or more.
+
+### Module slots and how to slice them
+Borg usually have all their items separated in to groups, which are then put in to modules.  
+- Each module should contain 6 or fewer items, otherwise the slots are put on top of each other, exception to this rule
+might be hand slots for storing things. ||might want to rewrite this||
+- Every module should have a theme it tries to achieve, and shouldn't try to fit several themes at once 
+(gardening module over a module that has both gardening tools and chemistry tools)
+

src/en/space-station-14/departments/silicon/proposals/silicon_hand_whitelist.md

@@ -0,0 +1,73 @@
+# Cyborg Whitelisted 'Hands'
+
+| Designers  | Implemented | GitHub Links                                                                                            |
+|------------|-------------|---------------------------------------------------------------------------------------------------------|
+| ThatGuyUSA | Yes         | [Borg hands & hand whitelisting](https://github.com/space-wizards/space-station-14/pull/38668), [Cyborg module guidelines](https://github.com/space-wizards/docs/pull/615) |
+
+## What are whitelisted Cyborg 'hand' slots?
+
+Whitelisted 'hand' slots are the solution to future proofing Cyborg inventories.
+
+Essentially it is a traditional 'hand' that would be on a humanoid, that can only hold items of the corresponding tag or component that we tell it to.
+
+They must follow the [Cyborg module guidelines](https://github.com/space-wizards/docs/pull/615)* like any other module slot in order to maintain consistency amongst Cyborgs design choices.
+
+\* At the time of writing, the Cyborg module guideline design document is incomplete.
+
+## Before its implementation
+
+Cyborgs were given 'empty stack' prototypes that could exclusively hold the item assigned to it.
+
+Before [PR #38668](https://github.com/space-wizards/space-station-14/pull/38668), Cyborgs were given slots that could only hold one specific item, indicated by a silhouette of that item. It had a shortcoming of scaling terribly, making for a poor user experience the more 'hands' someone had to interface with in a single module.
+
+If a Cyborg wanted to hold reinforced uranium glass, a "reinforced uranium glass hand" would have been created to be placed into a module. While it accomplished what we needed, it would a huge commitment for an uncommon material that one might not even interact with in most rounds.
+
+Due to how Cyborgs navigate their inventory, swapping between larger lists of slots and tools can become tedious quickly leading to a diminished user experience.
+
+## Implementation
+
+Whitelisted Cyborg 'hands' aim to generalize things a cyborg can hold utilizing Tags and Components, while still limiting their freedom.
+
+Instead of having one slot each for gauze, bruise packs, and ointment, they can have 3 slots that can hold any topical medication. If someone wants to exclusively stack up on gauze and blood packs, they may do so as they please.
+
+This allows the Cyborg player to fill their inventory to better suit their needs, while maintaining the restrictions of whatever module the hand is part of.
+
+## Empowering embedded tools
+
+Embedded tools should not be obsoleted by 'hands', they should compliment each other's existence.
+
+The centerpiece of a cyborg module should never be the 'hands', the embedded tools should be the main reason a Cyborg would want a certain module. It is important for keeping Cyborgs exclusive tools the reason a player would want to be a Cyborg.
+
+If the 'hands' are too versatile, then it undermines the limitations of being a Cyborg. For this reason they must be limited in what they can carry. If a Cyborg needs to carry tools it is preferred they are made into embedded slots rather than whitelisted 'hands'.
+
+## Broad categories
+
+Whitelisted items for slots must be contextually related to the module they are a part of.
+
+If there are too many options in a category to make into a reasonable amount of embedded slots, whitelisted slots may be used in place of them. However, the items must be related both functionally and contextually.
+
+Giving a Cyborg a "machine construction" 'hand' that can hold machine parts, all cable types, batteries, igniters, and beakers may seem like a good idea as they are all related to constructing / upgrading machines. But giving the slot so much versatility has inadvertently made other modules redundant. 
+
+That slot can pour drinks, and lay cables. Both of which have modules dedicated to doing so, and should be avoided. It is a common pitfall to make a 'hand' overly useful, so development should be done with extreme caution.
+
+## Dos and Don'ts
+
+### What whitelisted 'hands' should be:
+
+- A slot that can hold produce and seeds.
+
+- A slot that can hold all construction materials ranging from Wood to Uranium, but not tiles.
+
+- A slot that can hold flatpacks.
+
+- A slot that can hold reagent containers such as beakers, vials, small bottles and jugs.
+
+### What a whitelisted 'hand' SHOULDN'T be:
+
+- A functionally identical, and nearly indistinguishable single humanoid hand.
+
+- A slot that can hold machine components such as boards and batteries, but also things like beakers and cables.
+
+- A slot that can hold functionally similar things such as knives and swords, when it should be an embedded slot instead.
+
+- A whitelisted slot that holds a piece of unique cyborg tech, which can be dropped and exchanged for something else.