HippieStation has tried to keep /tg/station as an upstream and to stay up-to-date with it. Previous attempts failed due to the number of conflicts, so the coders have decided to keep everything modularized. The less code in any folder that isn't this hippiestation one, the fewer conflicts will exist in future updates.
Something is modular when it exists independent from the rest of the code. This means that by simply adding something modular to the DME file, it will exist in-game. It is not always possible to completely modularize something, but if standards are followed correctly, then there should be few to none conflicts with /tg/station in the future.
All modifications to non-hippie files should be marked.
- Single line changes should have
// hippie -- reasonat the end of the exact line that was edited - Multi line changes start with
// hippie start -- reasonand end with// hippie end. The reason MUST be included in the change in all cases, so that future coders looking at the line will know why it is needed. - The reason should generally be about what it was before, or what the change is.
- Commenting out some /tg/ code must be done by putting
/* hippie start -- reasonone line before the commented out code, with said line having only the comment itself, andhippie end */one line after the commented out code, always in an empty line. - Some examples:
var/obj/O = new(hippie) // hippie -- added hippie argument to new
/* hippie start -- mirrored in our file
/proc/del_everything
del(world)
del(O)
del(everything)
hippie end */
Once marking your changes to the /tg/ files with the proper comment standards, be sure to include the file path of the tg file in our changes.md in this folder. Keep the alphabetical order.
Do not alter the tgstation.dme file. All additions and removals should be to the hippiestation.dme file. Do not manually add files to the dme! Check the file's box in the Dream Maker program. The Dream Maker does not always use alphabetical order, and manually adding a file can cause it to reorder. This means that down the line, many PRs will contain this reorder when it could have been avoided in the first place.
Icons are notorious for conflicts. Because of this, ALL NEW ICONS must go in the "hippiestation/icons" folder. There are to be no exceptions to this rule. Sounds don't cause conflicts, but for the sake of organization they are to go in the "hippiestation/sounds" folder. No exceptions, either. Unless absolutely necessary, code should go in the "hippiestation/code" folder. Small changes outside of the folder should be done with "hook" procs. Larger changes should simply mirror the file in the "hippiestation/code" folder.
If a multiline addition needs to be made outside of the "hippiestation" folder, then it should be done by adding a proc called "hook" proc. This proc will be defined inside of the "hippiestation" folder. By doing this, a large number of things can be done by adding just one line of code outside of the folder! If possible, also add a comment in the hippie file pointing at the file and proc where the "hook" proc is called, it can be helpful during upstream merges and such.
If a file must be completely changed, re-create it with the changes inside of the "hippiestation/code" folder. Make sure to follow the file's path correctly (i.e. code/modules/clothing/clothing.dm.) Then, remove the original file from the hippiestation.dme and add the new one.
Defines only work if they come before the code in which they are used. Because of this, please put all defines in the `code/__DEFINES/~hippie_defines' path. Use an existing file, or create a new one if necessary.
New clothing items should be a subtype of "/obj/item/clothing/CLOTHINGTYPE/hippie" inside of the respective clothing file. For example, replace CLOTHINGTYPE with ears to get "/obj/item/clothing/ears/hippie" inside of "ears.dm" in "code/modules/clothing." If the file does not exist, create it and follow this format.
New actions and spells should use the "hippiestation/icons/mob/actions.dmi" file. If it is a spell, put the code for the spell in "hippiestation/code/modules/spells." To make sure that the spell uses the Hippie icon, please add "action_icon = 'hippiestation/icons/mob/actions.dmi'" and the "action_icon_state" var.
New reagents should go inside "hippiestation/code/modules/reagents/drug_reagents.dm." In this case, "drug_reagents" is an example, so please use or create a "toxins.dm" if you are adding a new toxin, etc. Recipes should go inside "hippiestation/code/modules/reagents/recipes/drug_reagents.dm." Once again, "drug_reagents" has been used as an example.
You can manipulate the products, contraband, and premium items of vending machines by adding items to the following:
hippie_products
hippie_contraband
hippie_premium
Like their counterparts, these are associative lists. The index is a reference to the object and the value is how many of that object. If you want to add 3 items to the products list, you do hippie_products = list(/path/to/that/object = 3). This also works with lowering the count of items.
If you take away more items then there is then the entry is removed.
For example if the products list has a entry of /obj/item/screwdriver and this a value of 5, and we put an entry of /obj/item/screwdriver with a value of -6 into hippie_products then there will be no screwdrivers in the vending machine. A large negative value is recommended for this purpose (e.g. -100 just to be safe)