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

Drink titles and soda vendor consistency #34178

Merged
merged 32 commits into from
Jan 9, 2025

Conversation

Alpaccalypse
Copy link
Contributor

@Alpaccalypse Alpaccalypse commented Jan 2, 2025

About the PR

Makes drinks with proper names consistently use title case when seen by the player. Fixes some mis-matched descriptions and other naming oddities with drinks. Moves a few missing drinks to random spawners.

Why / Balance

There was inconsistency over the use of title case with branded drinks and cocktails. It could be a bit jarring, especially when right next to each other in a vending machine or when mixing drinks as a bartender. This makes them all have the same style.

Reagent suffixes have been left lowercase, as that style is fitting and almost universally consitent already, for the UI contexts they appear in.

Adds a couple of missing bottles to random spawning.

Have been made aware of PR #5038 which this will try to keep to the spirit of.

Technical details

Primarily edits the name strings for the soda, drinks and alcohol en-US localisation files. Also edits some name strings for drinks_cans.yml and Drinks\Drinks_bottles.yml, and ID references for soda.yml. A smattering of edits elsewhere when strictly relevant to names and descriptions displayed in the UI.

Resolves #34162

(Soda dispenser probably needs a cleanup/rework, as some reagent inclusions/exclusions seem quite arbitrary, but that is more appropriate to a separate PR.)

Media

Before:
image

After:
image

Before:
image

After:
image

Before:
image

After:
image

A few examples of inconsistencies taken from the guidebook:
image
image
image
image
image
image
image

Screenshot from another PR that better showcases vendor inventory naming inconsistencies:
image

Requirements

Breaking changes

AFAIK, changing only the text strings for names in .ftl files shouldn't break anything. I'm hoping changing case of names in drinks_cans.yml entities is also safe, as long as IDs are left untouched. Same goes for other edits; basically no IDs were touched, so fingers crossed.

Changelog
Mostly changes to descriptive and flavour text, some exceptions:

🆑

  • tweak: The reagent "cola" has been renamed to "Space Cola".
  • tweak: The reagent "lemon-lime" has been renamed to "Smite".
  • tweak: The reagent "lemon-lime-cranberry" has been renamed to "Smite Cranberry".
  • tweak: The reagent "Space Mountain Wind" has been renamed to "Space Solar Wind".
  • tweak: The reagent "Energy Drink" has been renamed to "Red Bool".

@github-actions github-actions bot added Changes: No C# Changes: Requires no C# knowledge to review or fix this item. S: Untriaged Status: Indicates an item has not been triaged and doesn't have appropriate labels. size/M Denotes a PR that changes 100-999 lines. labels Jan 2, 2025
@Alpaccalypse
Copy link
Contributor Author

Alpaccalypse commented Jan 2, 2025

Ooops, I somehow massacred and auto-closed the last draft of this, so just putting this back here for safekeeping before I do something catastrophically wrong again.

@Alpaccalypse Alpaccalypse changed the title Drinks title case Drink titles and soda vendor consistency Jan 2, 2025
@Alpaccalypse
Copy link
Contributor Author

Alpaccalypse commented Jan 2, 2025

May as well keep expanding on this, as it should have little overhead or resource demands on the game:

Maybe:

  • Better organise file contents (alphabetical/function/logical consistency)
  • Add a couple of more drink varieties that fit with the current theme
  • Address some inconsistencies, such as moonshine/hooch and Red Bool/energy drink (Red Bool should now usualy be displayed in place of 'energy drink'.
  • Fix cocktails with mis-matching names/recipes, such as Atomic Bomb
  • Add other branded vending machines (Sol/Fourteen Loko)
  • Fix inconsistencies with reagent names and descriptions (e.g. cola vs Space Mountain Wind)
  • [-] Have an in depth look at bartending, with a view towards optimisation and ease of use. (Yeah, this needs some time on a dedicated PR)

@Tayrtahn
Copy link
Member

Tayrtahn commented Jan 2, 2025

These are good fixes, but I recommend splitting them up into separate PRs if possible! It's quicker and easier to review them separately.

I suggest doing the capitalization changes in one PR, the advertising self-own fix in another, the combined vending machine in another, etc.

@Alpaccalypse
Copy link
Contributor Author

I suggest doing the capitalization changes in one PR, the advertising self-own fix in another, the combined vending machine in another, etc.

Thanks for the suggestion, I was wondering about this as it started to drift. I think I'll use all your examples here.

@Alpaccalypse
Copy link
Contributor Author

Reverted commits that have been moved to their own branches.

@beck-thompson beck-thompson added P3: Standard Priority: Default priority for repository items. T: Cleanup Type: Code clean-up, without being a full refactor or feature D3: Low Difficulty: Some codebase knowledge required. S: Needs Review Status: Requires additional reviews before being fully accepted and removed S: Untriaged Status: Indicates an item has not been triaged and doesn't have appropriate labels. labels Jan 4, 2025
@Hrosts
Copy link
Contributor

Hrosts commented Jan 4, 2025

You probably should have a changelog, as other PRs which renamed drinks did (e.g. #34107)

You renamed:

  • lemon-lime -> Smite Soda
  • lemon-lime-cranberry -> Smite Cranberry
  • cola -> Space Cola
  • space mountain wind -> Space Solar Wind (btw maybe just make it "Solar Wind" at this point?)

With Blue Curacao - does the change to "Blue Curaçao" affect searchability? Because I'd assume it wasn't using the correct character for that reason. Most people can't or don't know how to type "ç".

@Hrosts
Copy link
Contributor

Hrosts commented Jan 4, 2025

Also regarding the upper/lower case, there's this issue, which confuses me personally, but probably means you shouldn't've made them upper case: #23708
I would wait for a maintainer or somebody more knowledgeable than a lurker like me.

@Alpaccalypse
Copy link
Contributor Author

Alpaccalypse commented Jan 4, 2025

You probably should have a changelog, as other PRs which renamed drinks did (e.g. #34107)

Good point, I will add it for names that will change searchability/recognition. To highlight one of the reasons for this PR, cola was the only generic reagent used in a branded drink, and a can of it was still called space cola by the game. Another example, energy drink, was called, or made reference to as Red Bool in practically every use, and only appeared as the base reagent name in the booze dispenser.

With Blue Curacao - does the change to "Blue Curaçao" affect searchability? Because I'd assume it wasn't using the correct character for that reason. Most people can't or don't know how to type "ç".

My reasoning is that other accents were already there for some drinks, but I will look into this. I'd prefer the correct name ideally. I seem to remember testing this, and it did search okay. Removing all accents might be better if they can't be searched easily. Will report back after testing.

-Turns out you are right. Oddly enough "Blue Cura" and "Patr" both turn up "Blue Curaçao" and "Patrón" as the only results, but the one that was already in the game "Piña Colada" gives about 4 pages of results if attempting "Pi" as a search. Searching "Colada" does resolve that issue, but doesn't really solve the issue you've raised.

Ideally the game would do a soft match for accents in English localisation, but as this isn't the case, and even though it pains me to do it (as a bit of a pedant for language), the best solution for now might be to remove any accents from the English localisation files. As my current changes don't actually make searchability any more difficult, I'd be in favor of leaving them in for now, as there were already accents in the game, and raising this as a separate, more general issue.

--Searching just a few common accent and letter combos, I've already found about 50 entries throughout different game files, I think this should definitely be raised as a separate issue, and given how common it is, I will keep the two I added in this PR, for now.

@Alpaccalypse
Copy link
Contributor Author

Alpaccalypse commented Jan 4, 2025

Also regarding the upper/lower case, there's this issue, which confuses me personally, but probably means you shouldn't've made them upper case: #23708 I would wait for a maintainer or somebody more knowledgeable than a lurker like me.

Thanks for the link, I've been looking for the exact place this was asked. I've floated the idea quite a bit on discord, and not had any explicitly unambiguous push back from maintainers, though at the same time I am quite prepared for this to be shelved for now.

If so, I will be making a new pull request to remove all title case, which ironically, at this point, due to consistent inconsistencies, will require about as many edits to the .yml code, as title case is used nearly 50% of the time in some places. I am being very conscious about keeping things lower case anywhere that it is purely internal to the developers. The focus of this PR is supposed to be only changing it for certain UI elements that the player sees.

-I accidentally closed the previous version of this PR, but a maintainer there did confirm that proper names should have title case, and looking at the PR linked, that seems to be confirmed there too, though it is a bit ambiguous still. There are quite a few examples in the game files where title case is consistently used for proper names, and I think it makes sense that proper names, like brand names should have title case. It also seems perfectly sensible that everything else should be lowercase.

At the end of the day, I think consistency with this is something worth maintaining, and if title case is not wanted with proper names in drinks, it probably needs to be made more apparent, or it will keep creeping back in, just through RL habits regarding this style use.

@Alpaccalypse
Copy link
Contributor Author

Alpaccalypse commented Jan 4, 2025

Recent commit: I decided to make descriptive names for cocktails title case, i.e. 'Banana Honk', but keep anything that is referencing a common noun or material lower case i.e. 'budget insuls', as this is the case for 'screwdriver' in RL and some other common cocktails, any exception to this is generally because sources seemed to contradict this rule ('Zombie').

I didn't mention before, but possessive names are all title case too (Devil's Kiss), but not if they just use a proper name (Beepsky smash) as this seemed correct in general.

@Alpaccalypse Alpaccalypse mentioned this pull request Jan 4, 2025
2 tasks
@Alpaccalypse
Copy link
Contributor Author

Star-kist vending machine name fix moved to #34215 to avoid conflict

@Alpaccalypse
Copy link
Contributor Author

Alpaccalypse commented Jan 5, 2025

Removed caffeine reference from Space Cola due to concepts for #34200 and #34215 and some planned future tweaks to sodas.

@slarticodefast
Copy link
Member

Also regarding the upper/lower case, there's this issue, which confuses me personally, but probably means you shouldn't've made them upper case: #23708
I would wait for a maintainer or somebody more knowledgeable than a lurker like me.

Explanation for this one: The issue means the prototype IDs, which are not player facing. They need to be PascalCase according to our naming conventions. The in-game name on the other hand should of course follow proper english grammar :)

@slarticodefast slarticodefast merged commit 36cbd07 into space-wizards:master Jan 9, 2025
11 checks passed
@Alpaccalypse
Copy link
Contributor Author

Not sure I snuck in the corrected changlog in time or not. [7be1f61] commit renamed Smite Soda to just Smite, I doubt the sky will fall on our heads if I didn't though.

@Hrosts
Copy link
Contributor

Hrosts commented Jan 10, 2025

Explanation for this one: The issue means the prototype IDs, which are not player facing. They need to be PascalCase according to our naming conventions. The in-game name on the other hand should of course follow proper english grammar :)

This doesn't seem to be the case, as both PRs which followed that issue changed the player facing names to be lowercase.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changes: No C# Changes: Requires no C# knowledge to review or fix this item. D3: Low Difficulty: Some codebase knowledge required. P3: Standard Priority: Default priority for repository items. S: Needs Review Status: Requires additional reviews before being fully accepted size/M Denotes a PR that changes 100-999 lines. T: Cleanup Type: Code clean-up, without being a full refactor or feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Case mis-match for drink names
6 participants