cyberpresidentvanellope/CHOMPStation2
1
0
Fork 0
mirror of https://github.com/CHOMPStation2/CHOMPStation2.git synced 2025-12-10 18:22:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md for mapping

Browse Source
This commit is contained in:
Razgriz
2023-07-06 00:04:10 -07:00
committed by GitHub
parent 8bd7689427
commit b4313e29fc
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
.github/CONTRIBUTING.md vendored
View File

@@ -32,6 +32,14 @@ By participating, you are expected to uphold this code.
Unsure where to begin contributing to Chomp Station? You can start by looking through the issues tab. Unsure where to begin contributing to Chomp Station? You can start by looking through the issues tab.
### Chomp Station Map Edits
* Our base map files are in [map/southern_cross/].
* Our stationary overmap location files are in [maps/southern_cross/overmap/].
* Our random overmap POI files are in [modular_chomp/code/modules/overmap/].
* Our wilderness POI map files are in [modular_chomp/maps/submaps/wilderness/].
* Map changes must be in tgm format. See the [Mapmerge2 Readme] for details, or use [StrongDMM] which can automatically save maps as tgm.
### Chomp Station Coding Standards ### Chomp Station Coding Standards
Any code submissions that do not meet our coding standards are likely to be rejected, or at the very least, have a maintainer request changes on your PR. Save time and follow these standards from the start: Any code submissions that do not meet our coding standards are likely to be rejected, or at the very least, have a maintainer request changes on your PR. Save time and follow these standards from the start:
@@ -55,7 +63,6 @@ Mostly for chomp exclusive stuff, otherwise if you need to modify a base file fo
* Change whitespace as little as possible. Do not randomly add/remove whitespace. * Change whitespace as little as possible. Do not randomly add/remove whitespace.
* Any new files should preferrably go into the modular_chomp folder following the file structure of where it would be placed normally. The old method was to have "_ch" at the end. For example, "life_ch.dm". * Any new files should preferrably go into the modular_chomp folder following the file structure of where it would be placed normally. The old method was to have "_ch" at the end. For example, "life_ch.dm".
* Do not make changes to base icon files. New icon files should go into modular_chomp and code should be changed to point to the new file. * Do not make changes to base icon files. New icon files should go into modular_chomp and code should be changed to point to the new file.
* Map changes must be in tgm format. See the [Mapmerge2 Readme] for details, or use [StrongDMM] which can automatically save maps as tgm.
The `attempt_ch()` proc has been added for your convienence. It allows a many-line change to become a single-line change in the existing Polaris files, preserving mergeability and allowing better code separation while preventing your new code from causing runtimes that stop the original code from running. If you are wanting to inject new procedures into an existing proc, called `update_atoms()` for example, you would create `update_atoms_ch()` in a nearby `_ch.dm` file, and then call to it from a single line in the original `update_atoms()` with `attempt_ch()`. The `attempt_ch()` proc has been added for your convienence. It allows a many-line change to become a single-line change in the existing Polaris files, preserving mergeability and allowing better code separation while preventing your new code from causing runtimes that stop the original code from running. If you are wanting to inject new procedures into an existing proc, called `update_atoms()` for example, you would create `update_atoms_ch()` in a nearby `_ch.dm` file, and then call to it from a single line in the original `update_atoms()` with `attempt_ch()`.