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

Multiple languages & Language adaptation #224

Open
wants to merge 2 commits into
base: development
Choose a base branch
from

Conversation

kasuganosoras
Copy link

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!

@TomGrobbe
Copy link
Owner

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.

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

Choose a reason for hiding this comment

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

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

#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}");
Copy link
Owner

Choose a reason for hiding this comment

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

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

}
#endregion

#region Get saved locations from the locations.json
Copy link
Owner

Choose a reason for hiding this comment

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

Why is there an additional indentation level here?

@@ -11,6 +11,9 @@
using static vMenuClient.CommonFunctions;
using static vMenuShared.ConfigManager;
using static vMenuShared.PermissionsManager;
using System.Collections;
using vMenuShared;
using CitizenFX.Core.Native;
Copy link
Owner

Choose a reason for hiding this comment

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

Please change this to:

using static CitizenFX.Core.Native.API;

using static CitizenFX.Core.Native.API;
using static vMenuClient.CommonFunctions;
using static vMenuShared.ConfigManager;
using static vMenuShared.PermissionsManager;
Copy link
Owner

Choose a reason for hiding this comment

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

Is all this really necessary?

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

Choose a reason for hiding this comment

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

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.

@@ -1800,15 +1801,15 @@ public void UpdateMods(int selectedIndex = 0)
index = 0;
}

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.");
Copy link
Owner

Choose a reason for hiding this comment

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

This description is missing a translation ;)

{
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."));
Copy link
Owner

Choose a reason for hiding this comment

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

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

@@ -20,6 +20,7 @@ public class NoClip : BaseScript
private static int Scale { get; set; } = -1;
private static bool FollowCamMode { get; set; } = false;

private static LanguageManager LM = new LanguageManager();
Copy link
Owner

Choose a reason for hiding this comment

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

This seems a bit useless? 🤔

Copy link
Author

Choose a reason for hiding this comment

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

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

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

Choose a reason for hiding this comment

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

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.

Copy link
Author

Choose a reason for hiding this comment

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

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

@TomGrobbe
Copy link
Owner

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
Copy link
Author

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
Copy link
Owner

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

@CipherGuardianSweden
Copy link

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

@MJRamon
Copy link

MJRamon commented Feb 2, 2022

Well, that deescalated. Still needed.

@TomGrobbe TomGrobbe added needs testing Needs more testing before anything can/will be done. needs review big change enhancement New feature or request labels Mar 4, 2023
@TomGrobbe TomGrobbe changed the base branch from master to development March 4, 2023 17:33
@TomGrobbe
Copy link
Owner

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.

@XdGoldenTigerOfficial XdGoldenTigerOfficial 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 labels Sep 29, 2024
Repository owner deleted a comment from outsider310 Sep 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
abandoned/waiting-for-user Waiting for user response/user did not reply after some time. big change enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants