Skip to content

From Tiny Foxes to StepMania OutFox

moruzerinho6 edited this page Mar 10, 2021 · 2 revisions

Repository

OutFox translation repositories adhere to a standard style. Repository title should be:

"OutFox-[languageFileName[-COUNTRY]]"

"-COUNTRY" should only be added in special cases (example: there's Portuguese from Portugal and Brazilian Portuguese, so the Portuguese-Brazilian language file is "pt-BR.ini").

The description of the repository should be:

"[Language Name] ([languageFileName]) Translation for Project OutFox""

Here's an example:

Repository Format

The repository should have 2 folders: "_fallback" and "default". Inside the _fallback will be the _fallback translation and default translation inside the default folder.

Only the translation file is required to be inside the folders/repository.

Keep track

It's recommended that you include the version that the translation is targeting inside the files. Here are some examples:

This file was translated/updated for StepMania Outfox 5.3 Alpha 4.8.3 so it included that version at the start of the file. You can also use releases for each version:

License

It's recommended to use MIT or Apache License 2.0. Repositories using MIT License might be required to change to Apache License 2.0 in the future so credits are maintained.

If you're using Apache License 2.0 you can include this notice at the end of the file

Copyright 2021 Tiny-Foxes

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Submitting to OutFox

So you finished the translation for this alpha before the release? You can then commit directly to master OR make a Pull Request with your files to OutFox-Translations so Jose_Varela includes them in the next alpha release.