Skip to content
← All documentation

/// PIMPMYRUST PLUGIN

AI Translation Free

Settings guide for this version of AI Translation Free. Check the plugin page before using it on your server.

Prepare your file

  1. Check the installed version

    This guide describes AI Translation Free 0.1.2. Use the same version in the configurator.

  2. Import your configuration

    Open the configurator and import your current JSON. For a new installation, you can start from the provided example.

  3. Edit and download

    Adjust the settings, fix reported errors, and download the JSON. Keep a copy of your old file before replacing it.

Your configuration is not saved on the site. Keep the exported file; you can import it again later.

Settings for this version

General 1
OpenAIToken
Text · required
JSON pathOpenAIToken
LangFilesConfiguration 1
Enabled
On / off · required
JSON pathLangFilesConfiguration → Enabled
Limits 8
MaxQueued
Whole number · required
JSON pathLimits → MaxQueued

Minimum : 1 · Maximum : 128

MaxConcurrent
Whole number · required
JSON pathLimits → MaxConcurrent

Minimum : 1 · Maximum : 8

MaxRequestsPerMinute
Whole number · required
JSON pathLimits → MaxRequestsPerMinute

Minimum : 1 · Maximum : 300

MaxRequestsPerDay
Whole number · required
JSON pathLimits → MaxRequestsPerDay

Minimum : 1 · Maximum : 10000

DailyTokenBudget
Whole number · required
JSON pathLimits → DailyTokenBudget

Minimum : 1000 · Maximum : 100000000

MaxRetries
Whole number · required
JSON pathLimits → MaxRetries

Minimum : 0 · Maximum : 3

MaxLanguageFileCharacters
Whole number · required
JSON pathLimits → MaxLanguageFileCharacters

Minimum : 1024 · Maximum : 500000

MaxProviderResponseCharacters
Whole number · required
JSON pathLimits → MaxProviderResponseCharacters

Minimum : 1024 · Maximum : 1000000

Model 4
Model
Text · required
JSON pathLangFilesConfiguration → Model → Model
Temperature
Number · required
JSON pathLangFilesConfiguration → Model → Temperature
MaxTokens
Whole number · required
JSON pathLangFilesConfiguration → Model → MaxTokens

Minimum : 64 · Maximum : 16384

Prompt
Text · required
JSON pathLangFilesConfiguration → Model → Prompt

Plugin instructions

AITranslation Free user guide

AITranslation Free translates one installed plugin's English language file into one target locale per authorized command. It is intended for occasional administrator-driven file translation. It does not translate player chat and does not include Pro's bulk command.

Requirements

  • Rust server running Oxide or Carbon.
  • The AITranslation Free 0.1.2 plugin file from the matching product archive.
  • Your own OpenAI API token with available provider credit.
  • A source file at oxide/lang/en/<PluginName>.json.

The server owner supplies the token and pays any OpenAI charges. Free and Pro are separate, mutually exclusive products; do not install or run both together. Pro has priority if both files are present, and Free unloads.

Installation

  1. Stop the server or unload an older AITranslation Free version.
  2. Place AITranslation.cs in the server's plugin directory.
  3. Start or reload the plugin once so its configuration is created.
  4. Add your OpenAI token to OpenAIToken in the protected server configuration.
  5. Review the local request limits before translating a file.

Keep the configuration readable only by trusted server operators. The token is not written to plugin logs.

First translation

From server console or RCON:

aitfree.translateplugin MyPlugin fr

The command reads oxide/lang/en/MyPlugin.json, validates the plugin name, locale, source JSON and configured limits, then queues one request. It sends only the selected English language values, the target language and the provider instructions to OpenAI. No request is made until an authorized command is executed.

When the response is complete and valid, the plugin checks the exact key set, string values, placeholders and size before staging the result. It retains the previous target as <PluginName>.json.aitranslation.bak and uses additional recovery material during replacement.

Commands and permission

CommandPurpose
aitfree.translateplugin <plugin name> <locale>Translate one installed plugin language file into one target locale.
ait.translateplugin <plugin name> <locale>Historical alias available while Free is the active edition.

Server console, RCON and Rust administrators may run the command. Grant aitranslation.admin only to another trusted connection that must initiate paid translation work.

Configuration reference

The tracked 0.1.2 configuration uses gpt-5.6-luna as its default Model. The model is configurable; verify current OpenAI availability and pricing before enabling requests.

Important local limits include:

SettingDefaultEffect
Limits.MaxQueued16Maximum waiting requests.
Limits.MaxConcurrent2Maximum in-flight requests.
Limits.MaxRequestsPerMinute20Local per-minute request ceiling.
Limits.MaxRequestsPerDay500Local daily request ceiling.
Limits.DailyTokenBudget250000Daily local token reservation ceiling.
Limits.MaxRetries2Retries for eligible temporary provider errors.
Limits.MaxLanguageFileCharacters60000Source and validated output character ceiling.

Temperature and Prompt remain readable for older configurations but are not sent by the current provider request.

Privacy and diagnostics

AITranslation Free never processes player chat. Logs may contain the operation, plugin name, locale, counts and bounded error codes. They do not contain the API token, prompts, translated values or provider response body.

Malformed, incomplete, refused, oversized, extra-key, missing-key, non-string or placeholder-changing responses are rejected. A response without usable provider accounting is also rejected.

Recovery

Before retrying a failed replacement:

  1. Unload AITranslation Free.
  2. Inspect the target language file, its .aitranslation.bak copy and any .aitranslation.rollback recovery file.
  3. Restore the known-good copy manually if required.
  4. Remove unresolved recovery material only after confirming the target is correct.
  5. Reload the plugin and run one small translation.

The plugin blocks another replacement while unresolved recovery material is present.

Known limitations

  • Translation quality and provider availability are outside the plugin's control.
  • The operator must monitor OpenAI usage and costs as well as the local limits.
  • One command translates one plugin into one locale; bulk translation and player chat are Pro features.
  • A real OpenAI request was not executed during the recorded final validation.

Support

Use the Codefling support section. Include AITranslation Free version, Oxide or Carbon version, the command shape, target locale and redacted error code. Never post the OpenAI token or language-file contents publicly.

Install the file

After keeping a copy of the previous file, place the exported JSON at this location on your server:

oxide/config/AITranslation.json

Follow the plugin instructions above for dependencies and reloading. Exporting does not connect the site to your server.