FAQ

Hannah Gamiel edited this page Oct 6, 2016 · 17 revisions
Clone this wiki locally

I want to localize files from Obduction into a new language. How do I go about doing this?

  1. In your game's Obduction/Content/Localization directory, add a new directory for your language named as two letters that are generally used as describing your language name (e.g. "fr" would be two characters that in general use, symbolize "French").
  2. Copy and paste all of the files from the en directory into your new language.
  3. Add a new language entry in your Languages.json file (in the Localization directory) with a LanguageID that is the same as the name of the directory you just created (that is how the localization manager in the game finds your files), a LanguageName that is the English translation of your language name, and a DisplayName that is the name of your language in your language.
  4. Open Obduction and verify that your language appears in the languages list in the menu. If it is not listed in the languages list, double check that you entered everything in the Languages.json file correctly.
  5. Start translating files in your new language's directory and be sure to check that they work in-game. Please note that all files must be saved with an encoding of UTF-16 LE with BOM.
  6. Once all of your files are translated and have been verified as displaying correctly in the game, you can make a pull request into this repository with that folder you created.

I'm unfamiliar with GitHub, but I would like to contribute a language I've localized for Obduction by making this so-called "Pull request". How can I share my work with you?

  1. Create a GitHub account.
  2. Visit our repository's Localization directory.
  3. Click on the "Upload Files" button that is sitting just above the "latest commit" message, near the top right of the screen.
  4. Drag the folder on your disk that contains your new language's localized files into the area that says "Drag files here".
  5. Once you have done that, scroll down and enter in a title and commit message for your commit.
  6. When you have added your title and commit message in accordance to our README, click on "Create Pull Request".
  7. On the page you are brought to when creating a pull request, ensure that the base fork (the fork on the left) is the Obduction Fan Localization repo and the branch next to it is master.
  8. Ensure that your title and commit message are good enough to submit, and then press "Create a Pull Request" again.
  9. For more information on using GitHub and creating pull requests, see GitHub's start-up guide..

What information or data do I need to include in my pull request?

Information included in your commit message:

  • Your email address that we may use to contact you directly
  • Your name or identifier (can be a username you go by), and -- if applicable -- the name or identifier of person(s) whom you are contributing on behalf of (and please include a link to their specific written permission for you to do so)
  • The language ID (two character identifier) of the language you are adding localization support for (like in the Languages.json file)
  • The display name (and dialect, if applicable) of the language you are adding localization support for (like in the Languages.json file)
  • The language name (and dialect, if applicable) of the language you are adding localization support for (like in the Languages.json file)
  • Which version of Obduction you used to test your translations
  • A short summary (1-2 sentences) about your translation approach

Data included in your pull request:

  • New language's localization folder that has all files translated to the language desired
  • Optional: If desired, a .txt file of a longer summary of your localization approach and notes (placed within your language's new directory)

Do I need to test my new language support in my local copy of the game before making a pull request?

Yes.

I'm adding support for language X and want to share what I have so far. Can I make a pull request with the files I modified so far?

Please only create a pull request when you have translated the entirety of the files that need translation for your language. If you would like to discuss the work you've done so far, you're welcome to share it with our community on the Obduction localization forums.

Can I submit changes to the de, en, es, fr, it, pl, ru, and zh directories in the game's localization directory?

Small changes for our base supported languages in Obduction should be submitted through our helpdesk site. In our GitHub repo, please only submit additions for new localization support for Obduction.

I know of someone who already localized files in Obduction to work with a language that isn't already supported. Can I submit their contribution?

If you have explicit written permission from them for you to submit their files, then yes, you may share their contribution and provide us with their email address for us to contact them if we decide to use their work in the game. Stealing other people's work isn't cool, and if we find out that you have been giving yourself credit for something someone else did without their explicit written permission to do so, we will not let you contribute to our repository anymore.

We recommend that those who did the translations are the ones who contribute their work, so please encourage your friend or acquaintance to make their own pull request into this repository.

I saw that someone made a pull request with files they translated in a language, but I see some things wrong with it. What can I do?

If the pull request is still open and not yet accepted by our team, you can comment on the pull request or discuss this issue in our Obduction's localization subforums. If the pull request was accepted by us, feel free to write up an issue mentioning exactly where you see problems.

I want a language I speak to be supported in the game, but I don't have time to translate all of the files. What can I do?

You are more than welcome to express your interest in our subforums for Obduction's localization here.

I see that someone has contributed a language that I would like to use in my local copy of Obduction. How can I get their translated files?

On the front page of our repository, there is a button that says "Clone or Download" on the middle-right of the page, and is green. Click on that button and press "Download ZIP". This will grab all approved localization changes made to the repository's master branch.

My pull request was rejected. What happened?

If your pull request was rejected, you may not have followed all of the instructions required in the README on the front page of this repository. We will try and be specific with you in a comment on the pull request.

How will I know if what I contribute will be used in an update to the game?

We will contact you directly, which is why we require that you include an email address we can reach you at in your commit message.