Update outdated/unclear parts of the mapping guide #358
Conversation
| - Waste loop: #990000 (dull red) | ||
| - Distro loop: #0055cc (subdued blue) | ||
| - Air: #03fcd3 (cyan) | ||
| - Mix: #947507 (brownish) | ||
| - Waste loop: #FF1212FF (red) | ||
| - Distro loop: #0335FCFF (blue) | ||
| - Air: #03FCD3FF (cyan) | ||
| - Mix: #947507FF (brownish) |
There was a problem hiding this comment.
I don't like that we're changing the standards because mappers can't read the standards, but fine.
There was a problem hiding this comment.
I've checked multiple maps and everyone is using raw colors instead of the custom distro/waste colors
There was a problem hiding this comment.
That's not what I said, but it's fine.
|
|
||
| 3. Make changes | ||
| 3. Make all your changes. |
There was a problem hiding this comment.
I always recommend implied second person as adding "you" and its contractions does not add clarity. In this particular case "changes" does not add any new context by having the reader own them. If you feel this needs more clarity, then I would recommend specifying "mapping changes," but that can also be implied by the context.
There was a problem hiding this comment.
Some of this file uses explicit "you", some of it does not. As far as I am aware docs does not have a standard. I would recommend picking one. That is either use "you", its contractions, and possessive indicators everywhere or nowhere. IMO, "you" never adds context that cannot be had when it is omitted, so there is no reason to add it.
|
|
||
| 4. If needed, run `fixgridatmos GID` | ||
| 4. If you have created new rooms, run `fixgridatmos GID` before saving. |
There was a problem hiding this comment.
step 4 occurs before 5. "before saving" is implied, so only add this if it causes project loss if forgotten.
Same feedback for "you".
|
|
||
| ## Common Tools and Commands | ||
| * <kbd>SHIFT-Click</kbd>: place a **line** of tiles/item/anything with a snap grid | ||
| * <kbd>CTRL-Click</kbd>: place a **square** of tiles/item/anything with a snap grid | ||
| * By default, the `P` ("Pick") key will select the entity or tile currently under your mouse for placement. | ||
| * By default, the `P` ("Pick") key will select the entity or tile currently highlighted under your mouse for placement. |
There was a problem hiding this comment.
last writer but, mouse -> cursor.
2nt person
|
|
||
| After this, run the command `dotnet run --project Content.MapRenderer {your_map_id_here}`, with the game map prototype ID. You can also set command line arguments through your IDE and run it that way. The image should be inside Resources/MapImages once completed. | ||
| After this, run the command `dotnet run --project Content.MapRenderer {your_map_id_here}` in your IDE or Git CLI, with the game map prototype ID (case-sensitive). You can also set command line arguments through your IDE and run it that way. The image should be inside Resources/MapImages once completed. |
There was a problem hiding this comment.
If users do not know where to run a command, then it is also likely that their environments are not setup correctly. If including where, then include how or more specifically a link to how.
2nt person
|
|
||
| 4. If you have created new rooms, run `fixgridatmos GID` before saving. | ||
| 4. If new rooms were created, run `fixgridatmos GID`. |
There was a problem hiding this comment.
The passive voice was used. The passive voice is a bit weaker and less clear than the active voice. It was also good to clarify that this should be run before saving.
|
Aaaa, should I use active voice or passive voice then ? I can't do both and most of the guide that I haven't touched alternates between both |
After many headaches trying to follow the mapping guide as written and not understanding why it's not working properly, I am humbly offering these updates to make it easier for people like me who are just starting on SS14 mapping to understand what's going on: