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

Gives the Corporate Liaison a map-specific lore-brief about the map. #7356

Merged
merged 6 commits into from
Oct 26, 2024

Conversation

Detective-Google
Copy link
Contributor

@Detective-Google Detective-Google commented Oct 22, 2024

About the pull request

This PR adds a new variable to map configs, called liaison_briefing, which is inputted into a piece of paper that spawns on the liaison's fax machine roundstart.

The idea is to insert a bit of lore about the colony the marines are going to, as well as to give the liaison some roleplay primers to start the round with.

If the map does not have a "liaison_briefing" set, it will default to a placeholder message explaining that there isn't a colony briefing available for that colony (todo; pretty the placeholder up)

For now, I've only written the trijent one, as it had the most concrete existing lore I could pull from to write a document about, some of the other maps (like LV, especially) don't have very well established lore, and will need working out with the lore guys on what best to include. If you want to write a briefing for your/your favorite map, feel free, I recommend preparing it in paperwork sim; paperwork sim, and I'll be more than happy to convert it to HTML and add it to this PR or PR it for you :)

Explain why it's good for the game

It always seemed weird to me that a lot of the time the CL has very little clue about this colony that they supposedly care about and don't want to get bombed to the stone age, out of everyone on the Almayer, the Liaison's ties to the company mean he should likely be the best informed about the colony. To this end, I've created a framework to brief the liaison about the map and it's interesting quirks, as well as giving them some fluff about why it may have gone dark(which conveniently never mentions xenomorphs.) My hope is that this'll aid the liaison in seeming knowledgable about the colony, as well as provide an avenue to inject some of the lore directly into the game, instead of being on a somewhat obscure subpage of a subpage of the wiki.

Testing Photographs and Procedure

Spawn in on map with a liaison_briefing set, verify the briefing spawns, and is properly filled out, spawn on a map without a liaison_briefing set, verify the briefing spawns, and is populated with the placeholder explaining the lack of a briefing.

Screenshots & Videos Ingame appearance of the trijent brief:

zhlFP0BGLC
paperwork sim view of the trijent brief:

image
placeholder briefing unavailable brief:

image

Changelog

🆑detectivegoogle
add: the CL now gets a briefing about the lore of the active map, assuming one has been written.
/:cl:

@cmss13-ci cmss13-ci bot added Mapping did you remember to save in tgm format? Feature Feature coder badge labels Oct 22, 2024
@Detective-Google
Copy link
Contributor Author

image

updated message for maps without a briefing set

@Detective-Google Detective-Google marked this pull request as ready for review October 22, 2024 06:32
@Detective-Google
Copy link
Contributor Author

pencode(1).txt

and here's the pencode for the form I used for the Trijent form, for anyone who wants to work on a briefing and have it be consistent.

@Detective-Google
Copy link
Contributor Author

image

a briefing for Kutjevo has been written, pulling info from the really nice Kutjevo lore doc

Copy link
Member

@harryob harryob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this won't work on the prod server as <img src = wylogo.png> is not using the cdn. on the production server, you get assets served to you on a funny url like http://cdn.cm-ss13.com/live/00/asset.00347bf0e1b4d6aa3adc389ddf49f4a6.png (see? random tacmap)

the best way would be to specify in the json a html file stored elsewhere in the repo, ie
"liaison_briefing": "html/briefings/trijent.html"

then you replace "wylogo.png" with %%WYLOGO%%

<center>
    <img src="%%WYLOGO%%" /><br /><small><b>Weyland-Yutani Corporation</b><br />\"Building Better Worlds\"</small>
</center>
<br /><u>Special Services Division</u><br />Liaison Colony Briefing<br />

<!-- and so on... -->

in your /obj/item/paper/liaison_brief/Initialize() you would do

/obj/item/paper/liaison_brief/Initialize(mapload, ...)
	. = ..()
	if(SSmapping.configs[GROUND_MAP].liaison_briefing)
		var/datum/asset/asset = get_asset_datum(/datum/asset/simple/paper)

		info = file2text(SSmapping.configs[GROUND_MAP].liaison_briefing)
		info = replacetext(info, "%%WYLOGO%%", asset.get_url_mappings()["wylogo.png"])
	else
		// fallback code

@harryob harryob marked this pull request as draft October 26, 2024 11:12
@Detective-Google Detective-Google marked this pull request as ready for review October 26, 2024 14:18
Copy link
Member

@harryob harryob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

last bits

code/modules/paperwork/paper.dm Outdated Show resolved Hide resolved
code/modules/paperwork/paper.dm Outdated Show resolved Hide resolved
maps/map_briefings/cl_brief_trijent.html Outdated Show resolved Hide resolved
maps/map_briefings/cl_brief_placeholder.html Outdated Show resolved Hide resolved
maps/map_briefings/cl_brief_kutjevo.html Outdated Show resolved Hide resolved
@harryob harryob added this pull request to the merge queue Oct 26, 2024
Merged via the queue into cmss13-devs:master with commit 01497c4 Oct 26, 2024
27 checks passed
cmss13-ci bot added a commit that referenced this pull request Oct 26, 2024
@Detective-Google Detective-Google deleted the CL-briefing branch October 27, 2024 01:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature Feature coder badge Mapping did you remember to save in tgm format?
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants