Translation Guide
The New Economy supports translations, as well as, multi-language support. In order to provide the end-user with the best experience, we try to provide community translated translation files. This guide is to explain what should be translated, and what should not.
TNE utilizes Crowdin for managing translation contributions. You may join the crowdin project here.
The following are considered special codes, and should not be translated.
- <aqua>
- <black>
- <blue>
- <dark_aqua>
- <dark_blue>
- <dark_gray>
- <dark_grey>
- <dark_green>
- <dark_purple>
- <dark_red>
- <gold>
- <gray>
- <grey>
- <green>
- <purple>
- <red>
- <white>
- <yellow>
- <magic>
- <bold>
- <strike>
- <underline>
- <italic>
- <reset>
- <newline>
In the following image, the special codes are outlined in red.
Some words are surrounded by < >, and [ ] but are not classified as special codes. It is important to translate anything within < > and [ ] that is not listed above.
We use variables in our message file to allow for adding certain things into strings such as balances, usernames, etc. These are notated by a dollar sign("$") in front of the word. These should not be translated.
In the following image, the variables are outlined in red.
Configuration nodes allow our YAML file to work as intended, and should not be translated. The following image shows an example of configuration nodes, outlined in red.
Commands are denoted by a backwards slash("/"), and should not be translated. They may be one word or multiple. The following image has all words outlined in red that should not be translated, which are classified as a command.
Any text that is not a Special Code, Variable, Command, or Configuration Node. Please see the sections above for what is classified as such.
| YAML Node | Valid Variables |
|---|---|
| Messages.General.Version | $version, $build |
| Messages.General.NoPerm | None |
| Messages.General.Saved | None |
| Messages.General.NoPlayer | $player |
| Messages.General.Disabled | None |
| Messages.General.IsConsole | None |
| Messages.Item.Invalid | None |
| Messages.Item.InvalidAmount | None |
| Messages.Admin.NoHoldings | $player, $world |
| Messages.Admin.Reloaded | $type |
| Messages.Admin.Holdings | $player, $amount, $world |
| Messages.Admin.NoTransactions | $player |
| Messages.Admin.Configuration | $node, $value |
| Messages.Admin.SetConfiguration | $node, $value |
| Messages.Admin.ID | $player, $id |
| Messages.Admin.Exists | None |
| Messages.Admin.Created | $name |
| Messages.Admin.CreationFailed | $name |
| Messages.Admin.Deleted | $name |
| Messages.Admin.DeletionFailed | $name |
| Messages.Admin.NoAccount | $name |
| Messages.Admin.PurgeWorld | $world |
| Messages.Admin.StatusChange | $name, $status |
| Messages.Admin.Status | $name, $status |
| Messages.Admin.Reset | $world, $currency, $player |
| Messages.Admin.Extraction | None |
| Messages.Admin.Restoration | None |
| Messages.Account.NoSuch | None |
| Messages.Account.NoHoldings | $currency |
| Messages.Account.PinSetAlready | None |
| Messages.Account.PinSet | $pin |
| Messages.Account.PinReset | $player |
| Messages.Account.PinMax | None |
| Messages.Account.PinIncorrect | None |
| Messages.Account.PinInvalid | None |
| Messages.Account.Locked | $player |
| Messages.Account.NoTransactions | None |
| Messages.Account.StatusChange | $status |
| Messages.Account.BlockedAction | $action, $currency |
| Messages.Data.Backup | None |
| Messages.Data.BackupFailed | None |
| Messages.Data.Debug | $level |
| Messages.Data.Save | None |
| Messages.Module.AvailableHeader | $url |
| Messages.Module.AvailableEntry | $module, $version |
| Messages.Module.Downloaded | $module |
| Messages.Module.FailedDownload | $module |
| Messages.Module.Info | $module, $author, $version |
| Messages.Module.Invalid | $module |
| Messages.Module.List | $modules |
| Messages.Module.Loaded | $module, $version, $author |
| Messages.Module.Reloaded | $module |
| Messages.Module.Unloaded | $module |
| Messages.Money.NotMixed | None |
| Messages.Money.TypeOffline | None |
| Messages.Money.NoConversion | $converted |
| Messages.Money.Failed | None |
| Messages.Money.Given | $amount |
| Messages.Money.Received | $amount, $player |
| Messages.Money.Taken | $amount, $player |
| Messages.Money.Insufficient | $amount |
| Messages.Money.HoldingsMulti | $world |
| Messages.Money.HoldingsMultiSingle | $currency, $amount, $inventory, $ender, $virtual |
| Messages.Money.Holdings | $amount |
| Messages.Money.Gave | $player, $amount |
| Messages.Money.RecipientSet | $amount, $player |
| Messages.Money.Set | $amount, $player |
| Messages.Money.SetAll | $amount, $world |
| Messages.Money.Paid | $amount, $player |
| Messages.Money.Took | $amount, $player |
| Messages.Money.Deposit | $amount |
| Messages.Money.Withdrawn | $amount |
| Messages.Money.Negative | None |
| Messages.Money.NoCurrency | $currency |
| Messages.Money.SelfPay | None |
| Messages.Money.PayFailedOnline | None |
| Messages.Money.PayFailedDistance | $distance |
| Messages.Money.Converted | $from_amount, $amount |
| Messages.Money.ConvertSame | None |
| Messages.Money.Top | $page, $page_top |
| Messages.Money.TopEntry | $player, $amount |
| Messages.Money.InvalidFormat | None |
| Messages.Money.ExceedsCurrencyMaximum | None |
| Messages.Money.ExceedsPlayerMaximum | None |
| Messages.Money.ExceedsOtherPlayerMaximum | $player |
| Messages.Money.RequestSender | $player, $amount |
| Messages.Money.Request | $player, $amount |
| Messages.Currency.Sure | $currency |
| Messages.Currency.Only | None |
| Messages.Currency.Deleted | $currency |
| Messages.Note.Given | $amount, $currency |
| Messages.Note.Claimed | $currency, $amount |
| Messages.Note.Failed | None |
| Messages.Note.Minimum | $amount |
| Messages.Note.Name | None |
| Messages.Note.Currency | $currency |
| Messages.Note.Region | $region |
| Messages.Note.Amount | $amount |
| Messages.Note.Action | None |
| Messages.Setup.General.Failed | $step |
| Messages.Setup.General.Successful | None |
| Messages.Setup.General.StepComplete | $step |
| Messages.Setup.Conversion.Identifier | None |
| Messages.Transaction.Already | $transaction |
| Messages.Transaction.Away | $page, $page_top |
| Messages.Transaction.AwayEntry | $id, $type |
| Messages.Transaction.AwayNone | None |
| Messages.Transaction.AwayJoin | None |
| Messages.Transaction.History | $page, $world, $player |
| Messages.Transaction.HistoryEntry | $id, $type, $initiator, $recipient |
| Messages.Transaction.Info | $id, $type |
| Messages.Transaction.Invalid | $transaction |
| Messages.Transaction.Unable | None |
| Messages.Transaction.Voided | $transaction |
| Messages.Commands.Help.Title | $command, $page |
| Messages.Commands.Help.Entry | $command, $arguments, $description |
| Messages.Commands.Help.Arguments | None |
| Messages.Commands.Help.Description | None |
| Messages.Commands.Admin.Backup | None |
| Messages.Commands.Admin.Create | $name, $balance |
| Messages.Commands.Admin.Debug | None |
| Messages.Commands.Admin.Delete |