Languages #43

FoxxoTrystan · 2024-03-24T14:13:19Z

Resolves #37

Description

This PR adds languages. Every entity who can speak now speaks a specific language (or Universal, for entities that are not supposed to speak, which is understood by everyone). Other entities who do not understand this language will see gibberish (it's possible to learn how certain induvidual words are spelled. But the spelling changes between rounds). This means that certain creatures, like xenos, cats, vulps, can communicate within their species in their own languages. Similarly, it means that xenos, cats and other things cannot understand GalacticCommon speakers without a translator or cognization.

An entity may be able to speak multiple languages, or understand a language but be unable to speak it.

Thi PR was orignally made for Frontier but is now being ported and will be maintain here.
Orignal PR: new-frontiers-14/frontier-station-14#671

This PR was made orignally by Mnemotechnician and FoxxoTrystan.

TODO

Language System. (Check Frontier PR for all the compleated todo list)
Port PR from Frontier.
QOL Changes.
Missing Default Languages. (Missing default langauges for some roundstart species)
Animals Languages.

Media

Changelog

🆑 FoxxoTrystan / Mnemotechnician

add: All species can now bring their own cultures and languages

This reverts commit da76123.

github-actions · 2024-03-24T17:43:15Z

RSI Diff Bot; head commit 7581981 merging into 310e3ae
This PR makes changes to 1 or more RSIs. Here is a summary of all changes:

Resources/Textures/Objects/Devices/translator.rsi

State	Old	New	Status
icon			Added
translator			Added

Edit: diff updated after 7581981

Pspritechologist

Whoooo boy, that's a big one. Lots of thoughts after the fact...

First off, I think it would be suitable to move the collection of language information (spoken, understood, required, requiresall, the stuff you were defining more than once) and move it into a serializable struct or class object that can be plonked into any instance that requires defining languages in YAML. This allows for the definitions to be reused, and means you can easily extend the functionality. You don't end up with the awkward situation where implementation X supports one feature, but implementation Y doesn't.

Finally, this whole thing needs to be cvar'd out the butt. I'd recommend a few cvars by default, one for the if languages are enabled at all, one for if animals can understand each other (personal preference, you'd probably want an 'animalistic' tag in the animals language), one for if animals can be translated at at all, and perhaps one for the fallback language ID? These all need to react to the cvars being updated mid game.
I know this seems like a huge amount to implement, but really it's just amazing practice for encapsulating your code and ensuring that vital functionality isn't strewn about multiple functions and systems. You shouldn't need to check the values of these cvars more than a couple times, everything should kinda 'funnel down' into your main functions.

Pspritechologist · 2024-03-25T13:00:46Z

Resources/keybinds.yml

@@ -183,6 +183,9 @@ binds:
 - function: OpenCharacterMenu
  type: State
  key: C
+- function: OpenLanguageMenu
+  type: State
+  key: M


'M' personally feels like an odd choice to me. I'd align that more with maps, or other such stuff. As a random offer, I'd probably go with 'L'.

Suggested change

key: M

key: L

Pspritechologist · 2024-03-25T13:02:42Z

Resources/Textures/Objects/Devices/translator.rsi/meta.json

+        {
+            "name": "icon"
+        },
+        {
+            "name": "translator"
+        }


These should probably have better names than 'icon' and 'translator,' especially considering 'icon' isn't wholly accurate as it appears to be the base sprite and translator appears to only be the unshaded portion.

Resources/Prototypes/Recipes/Lathes/language.yml

Pspritechologist · 2024-03-25T13:06:24Z

Resources/Prototypes/Language/languages.yml

These should probably be changed to inline lists, just to make the file a little more digestible.

Also this is super cool, I was hoping replacements would be per-language! :P

Resources/Prototypes/Entities/Objects/Devices/translators.yml

Pspritechologist · 2024-03-25T14:56:39Z

Content.Server/Language/TranslatorSystem.cs

+        if (Transform(args.Target).ParentUid is { Valid: true } holder && EntityManager.HasComponent<LanguageSpeakerComponent>(holder))
+        {
+            // This translator is held by a language speaker and thus has an intrinsic counterpart bound to it. Make sure it's up-to-date.
+            var intrinsic = EntityManager.EnsureComponent<HoldsTranslatorComponent>(holder);


EnsureComp

Pspritechologist · 2024-03-25T14:57:15Z

Content.Server/Language/TranslatorSystem.cs

+        UpdatedLanguages(holder);
+    }
+
+    private void OnTranslatorToggle(EntityUid translator, HandheldTranslatorComponent component, ActivateInWorldEvent args)


Make this function call a generic, public ToggleTranslator function to allow for interoperability

Suggested change

private void OnTranslatorToggle(EntityUid translator, HandheldTranslatorComponent component, ActivateInWorldEvent args)

private void OnTranslatorToggle(EntityUid translator, HandheldTranslatorComponent component,

ActivateInWorldEvent args)

Pspritechologist · 2024-03-25T14:58:22Z

Content.Server/Language/TranslatorSystem.cs

+        intrinsic.Issuer = comp;
+    }
+
+    private static void AddIfNotExists(List<string> list, string item)


I'm not in an IDE right now, but if this is not used more than I'd say remove it :P

Sadly no, it's used above in two places and I hate it

Pspritechologist · 2024-03-25T14:59:03Z

Content.Server/Chat/Systems/ChatSystem.cs

@@ -45,6 +48,7 @@ namespace Content.Server.Chat.Systems;
 /// </summary>
 public sealed partial class ChatSystem : SharedChatSystem
 {
+    public const float DefaultObfuscationFactor = 0.2f;


This should absolutely not live where it is right now

Pspritechologist · 2024-03-25T15:01:49Z

Content.Server/Chat/Systems/ChatSystem.cs

+            {
+                //If listener is too far and has no line of sight, they can't identify the whisperer's identity
+                var result = ObfuscateMessageReadability(finalMessage);
+                var wrappedResult = Loc.GetString("chat-manager-entity-whisper-unknown-wrap-message",


Please try not to include 'magic strings' in your code like this. Any strings being accessed in code should generally be defined as consts at the top of the script to make debugging for others not a nightmare.

It's not even our code, just a part of reorganized upstream code- 😭

How would you recommend to do it?

Eh, honestly leave it in that case. Refactors can happen later. The only point here then would be to try and reorganize less upstream code without refactoring it.

For reference, the correct way to hardcode a value is to not hardcode a value, but to leave it as a DataField in a Component somewhere. The second best way to hardcode a value is to do it as a 'private const string = ;` at the very top of the file, to make these values clear and collected.

Resources/Locale/en-US/language/languages.ftl

Pspritechologist · 2024-03-25T15:16:10Z

By the way, totally forgot to mention in the review-
Although I must say I really like the chosen language names, I would personally like to see the IDs for the languages made generic, with the in-world names only used in the locales. It makes it quite hard to understand what some of them are intended for by reading code, and will also make searching for them as keywords very difficult. I'd recommend boiling them down to their use, such as 'LanguageSlime' rather than 'Bubblish' or some such thing similar. This should be quite trivial to do with a good find-and-replace, but if you find it troublesome I'm more than happy to help (don't want to assume your experience with find-and-replace :P)

FoxxoTrystan · 2024-03-26T12:15:04Z

Resources/Prototypes/Research/civilianservices.yml

+  - CanilunztTranslatorImplanter
+  - SolCommonTranslatorImplanter
+  - RootSpeakTranslatorImplanter
+  #- AnimalTranslator


uncomment this

Pspritechologist · 2024-03-27T08:21:39Z

Content.Server/Language/LanguageSystem.cs

+        var builder = new StringBuilder();
+        if (language.ObfuscateSyllables)
+        {
+            ObfuscateSyllables(builder, message, language);
+        }
+        else
+        {
+            ObfuscatePhrases(builder, message, language);
+        }


I had a terrific idea. This should take a generic 'LanguageObfuscator' Class with children for each method of obfuscation. Instead of a binary boolean here, it would simply take the Obfuscator from the Language Prototype and execute the 'Obfuscate' function on it, using whatever is returned. This allows languages to implement custom obfuscation logic, for instance binary could be obfuscated based on actually being converted to binary (a stupid but funny suggestion), or Shadowkin could use whatever absurd system Death made.

The replacement portion of the YAML would be moved to the default obfuscator, since not every one would them.

This is a good idea!
But that could be made in the future and not planned for the base code.

DangerRevolution

Would nice to have things localised when this is finished as a QOL thing.

Resources/Prototypes/Entities/Objects/Devices/translators.yml

Co-authored-by: Pspritechologist <[email protected]>

Mnemotechnician · 2024-03-30T12:13:11Z

I went through most of the requested changes and implemented them.

But the more time I spend on this, the more I feel my sanity depleting, so I could not handle all, ask @FoxxoTrystan for the rest (mainly yml in the end of the list of changes) or something-

Some comments on some things in the reviews above:

Translators are split into 3 components exactly because of interoperability issues. I cannot think of a system that would allow to SAFELY handle multiple language knowledge sources without simply using different components for each (otherwise we would have situations where an entity could hold an active translator, deactivate it, and forget the language it used to know due to some other effect, e.g. translator implant)
I hate bloat, which is why all 4 translator comps (base + 3 impls) are in a simple file... It makes no sense to have 3 files each 5 lines long.
Chat and headset systems are a mess, and so are their modified versions... I don't believe much can be done without upstream rewriting them (there was a pr for it, but... this is a hard fork...)

Pspritechologist · 2024-04-02T13:36:28Z

I went through most of the requested changes and implemented them.

But the more time I spend on this, the more I feel my sanity depleting, so I could not handle all, ask @FoxxoTrystan for the rest (mainly yml in the end of the list of changes) or something-

Some comments on some things in the reviews above:

Translators are split into 3 components exactly because of interoperability issues. I cannot think of a system that would allow to SAFELY handle multiple language knowledge sources without simply using different components for each (otherwise we would have situations where an entity could hold an active translator, deactivate it, and forget the language it used to know due to some other effect, e.g. translator implant)

I hate bloat, which is why all 4 translator comps (base + 3 impls) are in a simple file... It makes no sense to have 3 files each 5 lines long.

Chat and headset systems are a mess, and so are their modified versions... I don't believe much can be done without upstream rewriting them (there was a pr for it, but... this is a hard fork...)

This is a fundamental issue with the Component system at the moment, which the StatusEffect system was meant to aid with. Perhaps the temporary understanding of a language could be done in that way? Otherwise, keeping a log of the sources of different languages and removing them only when you're out of sources is a way to handle it. Another option, perhaps the best one, is to simply make languages event-based, where a 'GetLanguagesEvent' is raised and Components can all respond to it individually. This way, you don't need to modify the data in a Component at all. This is the primary way information is gathered and relayed in SpaceStation and allows for the most expansion down the line.
Components are per-file by convention, breaking it is not permissible. Each file refers to one Component, and each Component has its own file. This makes finding anything in the repo a breeze, at the cost of having a large number of files. At the end of the day, any solution is a compromise and the only correct one is the one that is already established.
This is understandable. Not changing the file at all would be nice pending a rework, but I know that isn't doable not just with the pr here, but lots of other planned features. Let's just try to keep the changes compacted to certain areas, and to annotate then where you can.

VMSolidus

I've discovered through testing that this apparently breaks Telepathy, which lives in the same code as Server Chatsystem. Players can HEAR telepathy when spoken by the Oracle, but cannot SAY telepathy. Telepathy works as a 4th method of chat, like Say, and Whisper, but wasn't updated like those two. Telepathy needs to be updated to use languages, and such that it must work again.

Mnemotechnician · 2024-06-04T01:03:03Z

List of currently known issues:

Telepatic speech does not work (explained above)-
~~Reconnecting causes the language menu to glitch out (fixed by changing the list of languages your entity speaks, e.g. using a translator)~~
Some animalistic languages look ugly due to mixing of lower and upper case (might wanna introduce properties to control min/max syllables per word per language)
~~Ghosting does not update the language menu~~ (Currently nivellated by re-opening the language window, but we may need to think of a proper solution later)
~~Taking on a ghost role sometimes does not update the language menu~~ (see above)
Implant code is trash and is pending a total rewrite (using the real implant/implanter system)

Will require testing now Co-authored-by: DEATHB4DEFEAT <[email protected]> Signed-off-by: Mnemotechnican <[email protected]>

…100+ suggestions in one PR

FoxxoTrystan · 2024-06-04T17:10:52Z

List of currently known issues:

Telepatic speech does not work (explained above)-

~~Reconnecting causes the language menu to glitch out (fixed by changing the list of languages your entity speaks, e.g. using a translator)~~

Some animalistic languages look ugly due to mixing of lower and upper case (might wanna introduce properties to control min/max syllables per word per language)

~~Ghosting does not update the language menu~~ (Currently nivellated by re-opening the language window, but we may need to think of a proper solution later)

~~Taking on a ghost role sometimes does not update the language menu~~ (see above)

Implant code is trash and is pending a total rewrite (using the real implant/implanter system)

Nice to aee the assistance tho i think the "Animals Langauges/Implant code" should not be done on this list and later when the "Base" of languages are done so its avoid keeping this on limbo.

For animals im gona gives langauges a bunch of new properties like how many spaces, ect...

DEATHB4DEFEAT · 2024-06-07T03:52:00Z

Mark review comments as resolved when you resolve them please.

Mnemotechnician · 2024-06-08T12:48:48Z

Mark review comments as resolved when you resolve them please.

sadly I cannot do that, because this PR is owned by trystan

DEATHB4DEFEAT · 2024-06-08T18:18:04Z

Mark review comments as resolved when you resolve them please.

sadly I cannot do that, because this PR is owned by trystan

Steal their account 🙂

FoxxoTrystan · 2024-06-08T18:59:15Z

Mark review comments as resolved when you resolve them please.

sadly I cannot do that, because this PR is owned by trystan

Steal their account 🙂

How dare you!

Co-authored-by: DEATHB4DEFEAT <[email protected]> Signed-off-by: FoxxoTrystan <[email protected]>

FoxxoTrystan · 2024-06-08T19:16:16Z

Outated/Updated Suggestions has been commented.

DangerRevolution · 2024-06-08T21:21:24Z

Not sure if an issue on latest version but... closing the language menu with the M button stops the M button glowing green. But closing it with Escape keeps it green.

FoxxoTrystan · 2024-06-08T22:36:54Z

Not sure if an issue on latest version but... closing the language menu with the M button stops the M button glowing green. But closing it with Escape keeps it green.

This is not a huge issue and some tiny changes regarding the button has already been done.

VMSolidus

As far as I'm concerned this is sufficiently "Feature Complete" and free of major bugs that we can justify merging it in this exact state, and have any future updates to it be a separate PR.

DangerRevolution · 2024-06-09T12:10:19Z

ready to merge, just need a brave soul to dismiss reviews

Stale

stale

Update edge.yml

Fixes for universal speakers (no more walls speaking GC)

da76123

github-actions bot added the Changes: C# Changes any cs files label Mar 24, 2024

Mnemotechnician and others added 4 commits March 24, 2024 15:17

Fixes for universal speakers (no more walls speaking GC)

a95f105

Fixes for universal speakers (no more walls speaking GC)

728e9b1

Revert "Fixes for universal speakers (no more walls speaking GC)"

113826b

This reverts commit da76123.

Fixes for universal speakers (no more walls speaking GC)

6bdc514

github-actions bot removed the Changes: C# Changes any cs files label Mar 24, 2024

Port

3d86f02

github-actions bot added Changes: C# Changes any cs files Changes: Localization Changes any ftl files Changes: Sprite Changes any png or json in an RSI Changes: UI Changes any XAML files Changes: YML Changes any yml files labels Mar 24, 2024

FoxxoTrystan mentioned this pull request Mar 24, 2024

Languages from Frontier #37

Closed

FoxxoTrystan added 2 commits March 25, 2024 13:05

Missing Default Langauges (Only Harpies duh)

bf80a15

Animals SPEAKS!

c65c1d3

FoxxoTrystan marked this pull request as ready for review March 25, 2024 14:10

Pspritechologist requested changes Mar 25, 2024

View reviewed changes

Pspritechologist previously requested changes Mar 25, 2024

View reviewed changes

Resources/Locale/en-US/language/languages.ftl Outdated Show resolved Hide resolved

FoxxoTrystan commented Mar 26, 2024

View reviewed changes

Pspritechologist reviewed Mar 27, 2024

View reviewed changes

DangerRevolution reviewed Mar 27, 2024

View reviewed changes

Resources/Prototypes/Entities/Objects/Devices/translators.yml Show resolved Hide resolved

Mnemotechnician and others added 2 commits March 30, 2024 14:31

Apply suggestions from code review

c61e061

Co-authored-by: Pspritechologist <[email protected]>

Did what the review suggested

0b7dd07

FoxxoTrystan added 2 commits March 31, 2024 18:40

Merge remote-tracking branch 'upstream/master' into Languages

54b15c1

abstract + yml changes

f3b2daa

Merge branch 'master' into Languages

b9850d8

VMSolidus requested changes Jun 2, 2024

View reviewed changes

Merge branch 'master' into Languages

19697bb

Mnemotechnician and others added 4 commits June 4, 2024 15:16

Apply (some) suggestions from code review

789cf4e

Will require testing now Co-authored-by: DEATHB4DEFEAT <[email protected]> Signed-off-by: Mnemotechnican <[email protected]>

Please, for the sake of god and all that's holy, never ever creature …

1d7d5d2

…100+ suggestions in one PR

More refactoring & linter fixes

f6f6679

Lots of refactoring; partially fixed language menu desync

c4cec66

FoxxoTrystan requested review from VMSolidus, DEATHB4DEFEAT and DangerRevolution June 6, 2024 19:26

Update Content.Server/Chat/Systems/ChatSystem.cs

7581981

Co-authored-by: DEATHB4DEFEAT <[email protected]> Signed-off-by: FoxxoTrystan <[email protected]>

VMSolidus approved these changes Jun 9, 2024

View reviewed changes

DangerRevolution approved these changes Jun 9, 2024

View reviewed changes

DangerRevolution enabled auto-merge (squash) June 9, 2024 12:10

DangerRevolution merged commit 82edb60 into Simple-Station:master Jun 10, 2024
12 checks passed

SimpleStation14 added a commit that referenced this pull request Jun 10, 2024

Automatic Changelog Update (#43)

9a79f00

FoxxoTrystan mentioned this pull request Jun 10, 2024

Sign Language! #439

Closed

dasprino007 pushed a commit to dasprino007/Einstein-Engines that referenced this pull request Jul 20, 2024

Merge pull request Simple-Station#43 from VMSolidus/Map-fixes

805fb94

Update edge.yml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Languages #43

Languages #43

FoxxoTrystan commented Mar 24, 2024 •

edited by DEATHB4DEFEAT

Loading

github-actions bot commented Mar 24, 2024 •

edited

Loading

Pspritechologist left a comment

Pspritechologist Mar 25, 2024

DEATHB4DEFEAT May 27, 2024

Pspritechologist Mar 25, 2024

Pspritechologist Mar 25, 2024

Pspritechologist Mar 25, 2024

Pspritechologist Mar 25, 2024

DEATHB4DEFEAT May 27, 2024

Pspritechologist Mar 25, 2024

Mnemotechnician Mar 30, 2024

Pspritechologist Mar 25, 2024

Pspritechologist Mar 25, 2024

Mnemotechnician Mar 30, 2024

Pspritechologist Apr 2, 2024

Pspritechologist commented Mar 25, 2024

FoxxoTrystan Mar 26, 2024

Pspritechologist Mar 27, 2024

FoxxoTrystan May 7, 2024

DangerRevolution left a comment

Mnemotechnician commented Mar 30, 2024

Pspritechologist commented Apr 2, 2024 •

edited

Loading

VMSolidus left a comment

Mnemotechnician commented Jun 4, 2024 •

edited

Loading

FoxxoTrystan commented Jun 4, 2024 •

edited

Loading

DEATHB4DEFEAT commented Jun 7, 2024

Mnemotechnician commented Jun 8, 2024

DEATHB4DEFEAT commented Jun 8, 2024

FoxxoTrystan commented Jun 8, 2024

FoxxoTrystan commented Jun 8, 2024

DangerRevolution commented Jun 8, 2024

FoxxoTrystan commented Jun 8, 2024

VMSolidus left a comment

DangerRevolution commented Jun 9, 2024

	private void OnTranslatorToggle(EntityUid translator, HandheldTranslatorComponent component, ActivateInWorldEvent args)
	private void OnTranslatorToggle(EntityUid translator, HandheldTranslatorComponent component,
	ActivateInWorldEvent args)

Languages #43

Languages #43

Conversation

FoxxoTrystan commented Mar 24, 2024 • edited by DEATHB4DEFEAT Loading

Description

TODO

Media

Changelog

github-actions bot commented Mar 24, 2024 • edited Loading

Pspritechologist left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Pspritechologist commented Mar 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DangerRevolution left a comment

Choose a reason for hiding this comment

Mnemotechnician commented Mar 30, 2024

Pspritechologist commented Apr 2, 2024 • edited Loading

VMSolidus left a comment

Choose a reason for hiding this comment

Mnemotechnician commented Jun 4, 2024 • edited Loading

FoxxoTrystan commented Jun 4, 2024 • edited Loading

DEATHB4DEFEAT commented Jun 7, 2024

Mnemotechnician commented Jun 8, 2024

DEATHB4DEFEAT commented Jun 8, 2024

FoxxoTrystan commented Jun 8, 2024

FoxxoTrystan commented Jun 8, 2024

DangerRevolution commented Jun 8, 2024

FoxxoTrystan commented Jun 8, 2024

VMSolidus left a comment

Choose a reason for hiding this comment

DangerRevolution commented Jun 9, 2024

FoxxoTrystan commented Mar 24, 2024 •

edited by DEATHB4DEFEAT

Loading

github-actions bot commented Mar 24, 2024 •

edited

Loading

Pspritechologist commented Apr 2, 2024 •

edited

Loading

Mnemotechnician commented Jun 4, 2024 •

edited

Loading

FoxxoTrystan commented Jun 4, 2024 •

edited

Loading