Multiple languages & Language adaptation by kasuganosoras · Pull Request #224 · TomGrobbe/vMenu

kasuganosoras · 2020-05-28T11:22:01Z

Added new feature

Multiple languages support
Language adaptation (Auto detect client language)
Language texts dump

Added Languages

English (Default)
Simplified Chinese
Traditional Chinese

Added Command

/vmenuclient dumplang (Dump all language texts to server and save to dumped_text.json, request permission vMenu.DumpLanguages.Dump)

Added Class

vMenuClient/LanguageManager.cs

Added Files

vMenuServer/languages.json

Locale file format

{
    "Language Name": {
        "Original Text": "Translated Text"
    }
}

Example:

{
    "chinesetraditional": {
        "Toggle NoClip on or off.": "開啟或關閉無碰撞飛行"
    }
}

Locale use in code example

LanguageManager LM = new LanguageManager();
Notify.Success(LM.Get("Original text here"));

Thank you for creating this awesome menu!

update

TomGrobbe · 2020-05-28T17:00:11Z

It's almost as if you read my mind, I was about to add this myself. I'll review all the changes (already spotted a few things I'd like changed) in a bit.

TomGrobbe · 2020-05-28T17:01:46Z

SharedClasses/ConfigManager.cs

+                }
+                else
+                {
+                    data = JsonConvert.DeserializeObject<Dictionary<string, Hashtable>>(jsonFile);


Please only try/catch the necessary code. Only the JSON conversion could crash here, so that's what needs to be caught.

TomGrobbe · 2020-05-28T17:02:54Z

SharedClasses/ConfigManager.cs

+#if CLIENT
+                vMenuClient.Notify.Error("An error occurred while processing the languages.json file. Language will set to English. Please correct any errors in the languages.json file.");
+#endif
+                Debug.WriteLine($"[vMenu] json exception details: {e.Message}\nStackTrace:\n{e.StackTrace}");


Notify.Error() already prints an error in the console, so you only need to log this to the console on the server side here.

TomGrobbe · 2020-05-28T17:03:34Z

SharedClasses/ConfigManager.cs

+        }
+		#endregion
+
+		#region Get saved locations from the locations.json


Why is there an additional indentation level here?

TomGrobbe · 2020-05-28T17:04:53Z

vMenu/MainMenu.cs

 using static vMenuShared.PermissionsManager;
+using System.Collections;
+using vMenuShared;
+using CitizenFX.Core.Native;


Please change this to:

using static CitizenFX.Core.Native.API;

TomGrobbe · 2020-05-28T17:06:46Z

vMenu/LanguageManager.cs

+using static CitizenFX.Core.Native.API;
+using static vMenuClient.CommonFunctions;
+using static vMenuShared.ConfigManager;
+using static vMenuShared.PermissionsManager;


Is all this really necessary?

TomGrobbe · 2020-05-28T17:23:14Z

vMenuServer/MainServer.cs

+        /// <param name="text"></param>
+        private void DumpLanguages([FromSource] Player source, string text)
+        {
+            if (IsPlayerAceAllowed(source.Handle, "vMenu.DumpLanguages.Dump") || IsPlayerAceAllowed(source.Handle, "vMenu.Everything") ||


This does not need to be cheater checked if you make this a server command. It's also not a destructive action so there should be no need to have this be cheater proof.

TomGrobbe · 2020-05-28T17:26:17Z

vMenu/menus/VehicleOptions.cs

                }

-                MenuListItem tireSmoke = new MenuListItem("Tire Smoke Color", tireSmokes, index, $"Choose a ~y~tire smoke color~s~ for your vehicle.");
+                MenuListItem tireSmoke = new MenuListItem(LM.Get("Tire Smoke Color"), tireSmokes, index, $"Choose a ~y~tire smoke color~s~ for your vehicle.");


This description is missing a translation ;)

TomGrobbe · 2020-05-28T17:33:32Z

vMenu/menus/About.cs

                Label = $"~h~{MainMenu.Version}~h~"
            };
-            MenuItem credits = new MenuItem("About vMenu / Credits", "vMenu is made by ~b~Vespura~s~. For more info, checkout ~b~www.vespura.com/vmenu~s~. Thank you to: Deltanic, Brigliar, IllusiveTea, Shayan Doust and zr0iq for your contributions.");
+            MenuItem credits = new MenuItem(LM.Get("About vMenu / Credits"), LM.Get("vMenu is made by ~b~Vespura~s~. For more info, checkout ~b~www.vespura.com/vmenu~s~. Thank you to: Deltanic, Brigliar, IllusiveTea, Shayan Doust and zr0iq for your contributions."));


Credits shouldn't need to be translated or possibly removed.

TomGrobbe · 2020-05-28T17:34:07Z

vMenu/Noclip.cs

        private static int Scale { get; set; } = -1;
        private static bool FollowCamMode { get; set; } = false;

+        private static LanguageManager LM = new LanguageManager();


This seems a bit useless? 🤔

I tried to add a translation for the NoClip button, but it crashed, seemingly because it was loaded earlier than the main menu.

TomGrobbe · 2020-05-28T17:35:41Z

vMenuServer/config/languages.json

@@ -0,0 +1,1631 @@
+{
+	"american": {},


Also please split these languages up in different files, that way maintaining custom language versions is much easier for people when a new language is added or updated.

I agree. When I first tried to support multiple languages, it was split into multiple files.

TomGrobbe · 2020-05-28T17:43:07Z

Additionally, please make an option to allow other languages than just the game languages to be added. So the user can select a language they want regardless of game language. Make this option default to the game's language.

kasuganosoras · 2020-05-28T18:27:23Z

Thank you so much! 😆 Umm...In actually I am not good at C#, so I use the Google to learn how to write the code xD

TomGrobbe · 2020-05-28T20:01:19Z

@kasuganosoras For just googling bits this isn’t half bad lol

CipherGuardianSweden · 2022-01-08T20:35:55Z

Any news about this? Has this been implemented in the new version yet?

MJRamon · 2022-02-02T10:28:10Z

Well, that deescalated. Still needed.

TomGrobbe · 2023-03-04T17:37:58Z

Currently none of the requested changes have been made yet. There is another PR that also implements multiple languages. Whichever one gets updated first and has the best implementation will be used, the other will unfortunately be closed.

SkylarPlayz348 · 2025-09-09T18:55:20Z

I'll take this over but will do a new pr. I will address all changes @TomGrobbe wanted as part of the pr.

kasuganosoras added 2 commits May 28, 2020 01:54

Merge pull request #1 from TomGrobbe/master

b1ac6c0

update

Add Multiple languages support

7a8ce51

TomGrobbe requested changes May 28, 2020

View reviewed changes

TomGrobbe added needs testing Needs more testing before anything can/will be done. needs review Needs to be reviewed/investigated/checked. big change enhancement New feature or request labels Mar 4, 2023

TomGrobbe changed the base branch from master to development March 4, 2023 17:33

christopher-nzcs added abandoned/waiting-for-user Waiting for user response/user did not reply after some time. and removed needs testing Needs more testing before anything can/will be done. needs review Needs to be reviewed/investigated/checked. labels Sep 29, 2024

Repository owner deleted a comment from outsider310 Sep 29, 2024

Uh oh!

Conversation

kasuganosoras commented May 28, 2020

Added new feature

Added Languages

Added Command

Added Class

Added Files

Locale file format

Locale use in code example

Uh oh!

TomGrobbe commented May 28, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TomGrobbe commented May 28, 2020

Uh oh!

kasuganosoras commented May 28, 2020

Uh oh!

TomGrobbe commented May 28, 2020

Uh oh!

CipherGuardianSweden commented Jan 8, 2022

Uh oh!

MJRamon commented Feb 2, 2022

Uh oh!

TomGrobbe commented Mar 4, 2023

Uh oh!

SkylarPlayz348 commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

SkylarPlayz348 commented Sep 9, 2025 •

edited

Loading