Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds a "Mapper Comment" mapping helper #12077

Merged
merged 2 commits into from
Jan 1, 2025

Conversation

BarteG44
Copy link
Contributor

@BarteG44 BarteG44 commented Dec 24, 2024

About The Pull Request

Adds a "Mapper Comment" mapping helper. Code has comments so maps should be able to have them too.

Why It's Good For The Game

Allows mappers to comment on their design choices and decisions within the mapping editor. This mainly aims to make the map review process easier as mappers can explain why they did things a certain way ahead of a maintainer having to manually ask, eliminating at least some of the unnecessary back and forth.

The second, more soulful, purpose of these is documenting the mapping process. Imagine if something like this had been added back when the game was still new. We could be reading the years of comments left on box station, allowing us not only to understand how the map came to be what it is today but also to learn from the successes and mistakes of past mappers. History records are always cool. Think Dev commentary nodes in Valve games like TF2 and Half Life 2.

Testing Photographs and Procedure

Screenshots&Videos Example of how multiple of them would be visible in SDMM:

image

image

Desktop.2024.12.24.-.23.27.06.05.mp4

Changelog

🆑
add: Added a "Mapper Comment" mapping helper object visible only in a mapping editor
/:cl:

@BarteG44 BarteG44 changed the title Adds a mapper comment mapping helper Adds a "Mapper Comment" mapping helper Dec 24, 2024
@ClownMoff
Copy link
Contributor

Good PR

code/modules/mapping/mapping_helpers.dm Outdated Show resolved Hide resolved
@Dejaku51 Dejaku51 added this pull request to the merge queue Jan 1, 2025
Merged via the queue into BeeStation:master with commit c73970d Jan 1, 2025
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants