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

Better documentation on integration for Custom Sheet #4

Closed
henriqueranj opened this issue Jan 24, 2018 · 2 comments
Closed

Better documentation on integration for Custom Sheet #4

henriqueranj opened this issue Jan 24, 2018 · 2 comments

Comments

@henriqueranj
Copy link

Hello, I am really enjoying this plugin for localisation! Thank you very much for it!

However, I struggled to get it up and running with a custom localisation file. It would be great to have better documentation about it, as I had to debug the code to understand how the formats and requirements for the localisation file are.

As I wish for new developers to have an easier time when integrating this tool, I would suggest to:

  1. Explain the required format for the localisation spreadsheet: localisation strings are only parsed after a row that start with "Polyglot"/"PolyMaster"/"BEGIN".
  2. Explain the the parsing ends when it meets a row that starts with "END".
  3. Explain that the custom spreadsheet needs to follow the same number and order of localised languages columns as the master sheet (plugin code relies on Languages enum's int numbers to fetch the language).
  4. Provide a template of a localisation spreadsheet that new developers can start from.
  5. Explain that the custom sheet needs to be a publicly available Google Spreadsheet so it can be downloaded via the Editor tool.
@skjalgsm
Copy link
Collaborator

This is really great feedback. Thank you.

I will make this happen very soon. We just had some troubles with this ourselves internally just yesterday someone on the team noticed that half of our localization strings were missing from the game because an END keyword had been inserted in the middle with translations, so its an undocumented feature for sure :)

@skjalgsm
Copy link
Collaborator

Closed as I address this in the recent release

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants