olaren15/ffxiv-easy-translate

Quickly search the translation for ffxiv content

Easy Translate

Easy Translate is a Dalamud plugin that allows you to search the translations for almost anything in Final Fantasy XIV! It's really useful when you are playing with people who have the game in another language.

You can open a search window by entering /et in the chat window. You will now be able to search translations for many in-game elements!

You can also right-click an item in your inventory to open a search window with the item's name pre-populated!

How To Install

EasyTranslate is available in the official dalamud repo. You can simply search for it in the Plugin Installer window.

For developers

Prerequisites

EasyTranslate assumes all the following prerequisites are met:

• XIVLauncher, FINAL FANTASY XIV, and Dalamud have all been installed and the game has been run with Dalamud at least once.
• XIVLauncher is installed to its default directories and configurations.
  • If a custom path is required for Dalamud's dev directory, it must be set with the DALAMUD_HOME environment variable.
• A .NET Core 8 SDK has been installed and configured, or is otherwise available. (In most cases, the IDE will take care of this.)

Building

1. Open up EasyTranslate.sln in your C# editor of choice (likely Visual Studio 2022 or JetBrains Rider).
2. Build the solution. By default, this will build a Debug build, but you can switch to Release in your IDE.
3. The resulting plugin can be found at EasyTranslate/bin/x64/Debug/SamplePlugin.dll (or Release if appropriate.)

Activating in-game

1. Launch the game and use /xlsettings in chat or xlsettings in the Dalamud Console to open up the Dalamud settings.
   • In here, go to Experimental, and add the full path to the EasyTranslate.DalamudPlugin.dll to the list of Dev Plugin Locations.
2. Next, use /xlplugins (chat) or xlplugins (console) to open up the Plugin Installer.
   • In here, go to Dev Tools > Installed Dev Plugins, and the Easy Translate should be visible. Enable it.
3. You should now be able to use /et (chat) or et (console)!

Note that you only need to add it to the Dev Plugin Locations once (Step 1); it is preserved afterward. You can disable, enable, or load your plugin on startup through the Plugin Installer.

ffxiv-easy-translate's Issues

Add UI translations

The UI should be displayed in the user's preferred game language.
If a UI text element is not available in the user's language, it should default to English.

Options for implementing i18n:

• https://github.com/goaaats/CheapLoc
• Roll your own with resx files:
  • https://stackoverflow.com/questions/1142802/how-to-use-localization-in-c-sharp
  • https://github.com/MidoriKami/NoTankYou/blob/master/NoTankYou/System/Localization/Strings.resx
  • https://github.com/MidoriKami/KamiLib/blob/master/Systems/LocalizationManager.cs

We will probably have to get the current language and get notified of language changes from DalamudPluginInterface: https://dalamud.dev/api/Dalamud.Plugin/Classes/DalamudPluginInterface

Add plugin to Dalamud official repo

Clean up hooks when unloaded

Leads: Dispose methods not properly implemented?

Executing search with no text searches everything

Searching from the ui with nothing should not execute a search query

Use Lumina to search for game content

This is probably a big task.

I would have to search through all relevant sheets to find the info i need.
Can I access all the name in all languages from these sheets?
How would this affect performance?

This would allow to search for more things and maybe more up to date info than what xivapi can currently offer (ex: class names, new patch content?)

Add context menu to search mob names

Duplicates should be removed

Ex: searching for「サベネア島」(thavnair) returns two results with the same info:

Add field in search results to display "type" of item

To help differentiate between items, achievements, fates, quests, etc,... that might have the same or a similar name

Improve readme

• Add screenshots
• Remove mentions about being under development
• Add instructions to install from the main dalamud repo

Exact matches are not at the top of the search results

The plugin should display results in order of closest match to the search query (in the search language)

Upgrade to .NET 8

primary constructors yayyyy

Allow searching for quest phrases

Allow searching for the translations of the text you have to type to complete certain quests
ex: "snae ling" in the pixie beast tribe quests

Allow searching for job names

Reconcile code in a single csproj

If I'm doing #25 I'll have to say goodbye to dreams of sharing code and offering a web UI

Most of the code is already in the DalamudPlugin project anyway

Search from item tooltips

Add an entry to the context menu when right-clicking an item to search for this item's translations

• Easy way: get the item name from it's id and reuse the existing code for searching by name

  • References:
    • https://github.com/Caraxi/SimpleTweaksPlugin/blob/27514beaa9c1e712f9a05a88112d06a627c3632b/Tweaks/Tooltips/ItemHotkeys.cs#L258C24-L258C31
    • https://dalamud.dev/api/Dalamud.Plugin.Services/Interfaces/IDataManager/#excel

• Harder way (only if absolutely necessary): Implement a function to search item names by their id

Use dalamud's context menu api

The nuget package that is currently used will be deprecated in favor of the new built-in dalamud api

Add button to search for quest names

Since you can't bring up a context menu for quests, adding a button in the quest log would be an option

[Feature Request] Implement copy button

Hello! Thank you for creating such a great plugin.
I thought it would be much easier to use if you could add a "Copy" button next to the words in the search results, so that you could copy the words to the clipboard.

Add context menu to search for teleport locations

Add context menu to search item links in chat

Add context menu to search for quest names