Skip to content
← All documentation

/// PIMPMYRUST PLUGIN

AI Translation Pro

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

Prepare your file

  1. Check the installed version

    This guide describes AI Translation Pro 2.1.0. Use the same version in the configurator.

  2. Get the settings

    Click Import, then From my server. Select the files and confirm loading them. Selecting a server does not replace the open document. You can also import files from this device or a configuration from My projects.

  3. Edit and send

    Adjust settings, fix errors, then use Send to transfer files to the selected server. A conflict blocks sending until you choose how to resolve it. You can still export only the files you need.

Server transfers have private backups. Save keeps your work in My projects; it does not send anything to the server. A download also lets you resume without a server connection.

Settings for this version

General 1
Fallback OpenAI key
Text · required

Legacy key retained for existing configurations. The OpenAI profile uses it only when its own key is blank.

JSON pathOpenAIToken
Chat translation 1
Enable chat translation
On / off · required

Allows translation in selected chat channels, subject to player permissions and choices.

JSON pathChatConfiguration → Enabled
Features 21
Providers
JSON value
JSON pathFeatures → Providers
Chat profile
Text

Name of the provider profile in Providers used for eligible chat translation.

JSON pathFeatures → ChatProfile
File profile
Text

Name of the provider profile in Providers used for language files.

JSON pathFeatures → FileProfile
Server context
Text

Shared server context added to translation instructions; changing it makes tracked translations eligible for refresh.

JSON pathFeatures → Context
Source language for files
Text

Language of source files at lang/<code>/<plugin>.json for native maintenance; defaults to en.

JSON pathFeatures → SourceLocale
Translated channels
List
JSON pathFeatures → ChatChannels
Player language choices
List

Language offered in the player panel, in this order; at most 24 valid codes are retained.

JSON pathFeatures → PlayerLanguages
Chat cache lifetime (seconds)
Whole number

How long a chat translation may be reused; 0 disables this cache.

JSON pathFeatures → ChatCacheSeconds

Minimum : 0 · Maximum : 86400

File memory lifetime (seconds)
Whole number

How long per-key file translations stay reusable; 0 disables this memory.

JSON pathFeatures → FileMemorySeconds

Minimum : 0 · Maximum : 31536000

Cache entries
Whole number

Maximum number of cached translation entries; 0 disables caching.

JSON pathFeatures → MaxCacheEntries

Minimum : 0 · Maximum : 20000

Keys per request
Whole number

Maximum language-file keys grouped into one native file request.

JSON pathFeatures → KeysPerRequest

Minimum : 1 · Maximum : 50

Characters per batch
Whole number

Maximum character count of a key batch sent to the provider.

JSON pathFeatures → BatchCharacters

Minimum : 256 · Maximum : 20000

Preview lifetime (hours)
Whole number

How long a private preview remains available before expiry; applying it remains explicit.

JSON pathFeatures → PreviewHours

Minimum : 1 · Maximum : 72

Estimated daily budget
Number

Estimated daily budget in the chosen currency; 0 disables this local limit.

JSON pathFeatures → DailyCostBudget

Minimum : 0 · Maximum : 1000000000

Estimated monthly budget
Number

Estimated monthly budget in the chosen currency; 0 disables this local limit.

JSON pathFeatures → MonthlyCostBudget

Minimum : 0 · Maximum : 1000000000

Pricing currency
Text

Shared currency for displayed prices and budgets; no automatic conversion is made.

JSON pathFeatures → Currency
Enable IQChat bridge
On / off

Allows requests delegated to Pro by the optional TranslationAPI bridge; IQChat keeps its own permissions and preferences.

JSON pathFeatures → IQChatBridgeEnabled
Detect message language
On / off

Requests translation even between players using the same client language; this can increase provider calls.

JSON pathFeatures → AutoDetectSourceLanguage
Report outdated files
On / off

Watches previously tracked loaded plugins and reports language files that need updating.

JSON pathFeatures → WatchLoadedPlugins
Prepare updates automatically (billable requests)
On / off

Automatically prepares detected updates, potentially incurring provider charges; application remains manual.

JSON pathFeatures → AutoPrepareUpdates
Capture BetterChat output
On / off

On: translates BetterChat output after its filters. Off: uses the legacy OnBetterChat handler. Reload Pro after changing this setting. Later network filters and the Rust+ relay have limitations explained in the guide.

JSON pathFeatures → BetterChatNetworkInterception
Language files 2
Enable file translation
On / off · required

Allow authorized single-plugin and bounded bulk file translation. Turning it off disables this file route, not chat translation.

JSON pathLangFilesConfiguration → Enabled
Legacy request delay (unused)
Number · required

Legacy import field; Pro 2.0 uses its shared queue and limits instead of this delay.

JSON pathLangFilesConfiguration → TimeBetweenRequestsInSeconds

Minimum : 0.1 · Maximum : 60

Local request limits 12
Maximum waiting requests
Whole number · required

Bound the number of waiting file and chat requests. New work is rejected when the shared queue is full.

JSON pathLimits → MaxQueued

Minimum : 1 · Maximum : 256

Maximum simultaneous requests
Whole number · required

Bound the number of provider requests in flight for shared file and chat work.

JSON pathLimits → MaxConcurrent

Minimum : 1 · Maximum : 8

Requests per minute
Whole number · required

Limit locally admitted provider requests per minute across file and chat translation.

JSON pathLimits → MaxRequestsPerMinute

Minimum : 1 · Maximum : 300

Requests per day
Whole number · required

Limit locally admitted provider requests per day across file and chat translation. Monitor provider usage separately.

JSON pathLimits → MaxRequestsPerDay

Minimum : 1 · Maximum : 20000

Daily local token budget
Whole number · required

Limit daily local token reservations for file and chat requests. This estimate is not a currency billing cap or a provider account limit.

JSON pathLimits → DailyTokenBudget

Minimum : 1000 · Maximum : 100000000

Temporary-error retries
Whole number · required

Allow this many retries after eligible temporary provider errors. Use 0 to disable retries.

JSON pathLimits → MaxRetries

Minimum : 0 · Maximum : 3

Language-file character limit
Whole number · required

Bounds the source file in Features.SourceLocale and its translated result; oversized content is not applied.

JSON pathLimits → MaxLanguageFileCharacters

Minimum : 1024 · Maximum : 500000

Provider response character limit
Whole number · required

Reject provider responses larger than this character limit instead of parsing or applying them.

JSON pathLimits → MaxProviderResponseCharacters

Minimum : 1024 · Maximum : 1000000

Chat input character limit
Whole number · required

Keep oversized chat messages out of paid translation; affected recipients receive the original message.

JSON pathLimits → MaxChatCharacters

Minimum : 32 · Maximum : 2000

Target locales per chat message
Whole number · required

Bounds billable target locales from one eligible message, regardless of enabled channel.

JSON pathLimits → MaxChatLocalesPerMessage

Minimum : 1 · Maximum : 16

Sender cooldown in seconds
Whole number · required

Require this minimum delay between paid chat translation triggers from the same sender.

JSON pathLimits → ChatSenderCooldownSeconds

Minimum : 1 · Maximum : 60

Plugins considered per bulk command
Whole number · required

Bound the loaded-plugin set considered by ait.translateallplugins. This is not a per-minute request limit.

JSON pathLimits → MaxBulkPlugins

Minimum : 1 · Maximum : 500

Privacy and player consent 2
Require explicit consent
On / off · required

Requires /ait on before chat translation. Turning it off allows automatic opt-in for permitted players; /ait off still takes precedence.

JSON pathPrivacy → RequireExplicitConsent
Player privacy notice
Text · required

Player notice about external processing and /ait; this text does not grant consent.

JSON pathPrivacy → PlayerNotice
UIConfiguration 5
Enable /ait panel
On / off

Shows the /ait panel; text commands remain available when it is hidden.

JSON pathUIConfiguration → Enabled
Active template
Text

Selects an existing key in this configuration’s templates; each template keeps its own customization.

JSON pathUIConfiguration → Template
IQChat notice
Text

Notice shown by the panel when IQChat manages chat and translation settings.

JSON pathUIConfiguration → IQChatNotice
Templates
JSON value
JSON pathUIConfiguration → Templates
Panel presentation
Choice

Provided template (native) or customized copy (pimpmycui). Beta 2.1.0 uses PimpMyCUI and its JSON pages in both cases. Edit the template under Player panel; this setting does not change the window used.

JSON pathUIConfiguration → PresentationMode

Allowed values: native, pimpmycui

Chat model settings 4
OpenAI model
Text · required

Legacy model used as the OpenAI profile fallback for this route; a model set in the profile takes precedence.

JSON pathChatConfiguration → Model → Model
Legacy temperature (unused)
Number · required

Legacy import field; Pro 2.0 requests do not read this value.

JSON pathChatConfiguration → Model → Temperature
Response token limit
Whole number · required

Cap the requested completion-token allowance for this route. Too low a limit can produce incomplete responses that the plugin rejects.

JSON pathChatConfiguration → Model → MaxTokens

Minimum : 64 · Maximum : 16384

Legacy prompt (unused)
Text · required

Retained for compatibility; current requests use fixed provider instructions, so editing this prompt has no effect.

JSON pathChatConfiguration → Model → Prompt
Glossary 2
Preserved terms
List

Term to preserve unchanged in translations; case and word boundaries are respected.

JSON pathFeatures → Glossary → Preserve
Preferred
JSON value
JSON pathFeatures → Glossary → Preferred
File model settings 4
OpenAI model
Text · required

Legacy model used as the OpenAI profile fallback for this route; a model set in the profile takes precedence.

JSON pathLangFilesConfiguration → Model → Model
Legacy temperature (unused)
Number · required

Legacy import field; Pro 2.0 requests do not read this value.

JSON pathLangFilesConfiguration → Model → Temperature
Response token limit
Whole number · required

Cap the requested completion-token allowance for this route. Too low a limit can produce incomplete responses that the plugin rejects.

JSON pathLangFilesConfiguration → Model → MaxTokens

Minimum : 64 · Maximum : 16384

Legacy prompt (unused)
Text · required

Retained for compatibility; current requests use fixed provider instructions, so editing this prompt has no effect.

JSON pathLangFilesConfiguration → Model → Prompt

Plugin instructions

AI Translation Pro 2.1.0

Sign in with an account that has access to download the plugin.

Translate plugin language files and let players read chat in their language. Pro includes an /ait player panel, three layouts, and separate provider profiles for chat and files.

Installation

  1. Install AITranslationPro.cs on Rust running Oxide or Carbon. Do not run Free and Pro together.
  2. Under Translation, choose your provider, then enter its key and a model available to your account. Advanced options let you use separate profiles for chat and files.
  3. Export AITranslationPro.json, or send it from PimpMyRust using a connected SFTP/RCON server. Reload the plugin after changing its configuration.

The plugin accepts 1.1.4 configurations. The configurator can explicitly add new settings while keeping your existing values and extra properties. Select LTS 1.1.4 when editing a server still running that version.

Providers

OpenAI, DeepL, Gemini, OpenRouter, Anthropic and a custom Chat Completions endpoint are supported. Each profile has its own key, model, HTTP timeout and optional fallback profile. DeepL does not require a model. Availability and pricing depend on your provider account.

OpenAIToken remains a fallback: the OpenAI profile uses it when its own key is blank. Legacy Prompt, Temperature and TimeBetweenRequestsInSeconds remain readable for migration; new translations use the context and glossary in Features.

The server owner pays provider charges. Enter your profile’s prices before using estimated monetary budgets. Local limits do not replace a billing cap at your provider.

Players and chat

Grant aitranslationpro.chat.use to eligible players and aitranslationpro.admin to administrators. Players must opt in by default. An explicit refusal remains effective if you disable the consent requirement. The provider receives the text being translated; the key stays on the server.

Player commandEffect
/aitOpen the language and translation panel
/ait on / /ait offEnable or refuse translation
/ait lang fr / /ait autoChoose a language or follow the client language
/ait originalShow or hide the original text
/ait statusCheck personal settings and access
/ait test [text]Test for yourself; administrators only

/ait.chat on|off|status still works. Only Global is enabled by default; Team, Clan, Local and Cards can also be selected. Permissions, consent and recipients are checked before translation and delivery. After five seconds without a result, the original is used. Automatic language detection can increase provider requests.

BetterChat and IQChat

BetterChat is optional and stays unmodified. Features.BetterChatNetworkInterception selects its integration mode:

  • On, by default: translates BetterChat output after its filters. Rust+ keeps the original. A one-shot network filter running after capture may not keep its decision during translated delivery; test other plugins that exclude recipients.
  • Off: translates through OnBetterChat and delivers the message. A later hook replacing the dictionary or ending the chain may not be respected. Handled Team messages do not reach the Rust+ relay.

Reload Pro after changing this option. ait.status reports the active mode. The IQChat bridge is optional. Avoid translating the same message through multiple plugins. With IQChat, /ait directs players to IQChat settings.

Language files

Sources are oxide/lang/<source language>/<Plugin>.json, or the Carbon equivalent. The default source language is en. Files must be UTF-8 JSON objects containing strings. Placeholders and protected terms are checked before replacement; manual corrections are not silently overwritten.

Console commandEffect
ait.files scan MyPlugin frFind missing or outdated translations
ait.files prepare MyPlugin frCreate a private preview; provider charges apply
ait.files listList previews and their state
ait.files preview <id>Read a prepared preview
ait.files apply <id>Apply the selected preview
ait.files restore <id>Restore the saved file
ait.files discard <id>Discard a preview

ait.files lock MyPlugin fr protects existing values; adopt adopts a file after checking its correspondence with source texts. aitpro.translateplugin MyPlugin fr and ait.translateallplugins fr apply their results directly. Use prepare to review before applying. Plugin watching reports files needing updates without provider calls by default.

Translation from the Hub

Connect your server using SFTP/RCON, then choose Translate with AI from its language files. Select plugins and target languages, check the files, then confirm translation. The plugin uses your provider, source language, context, glossary and budgets. Preparation may incur provider charges; the Hub does not display an estimate when it cannot calculate them.

Review the preview before applying it. Manual corrections are preserved. After applying, Restore remains available until the displayed deadline, set by PreviewHours — 24 hours by default. If the file has changed since, restoration is refused to preserve those edits. An uncertain result can be checked without restarting translation. The chat cost simulator shows no price for profiles it cannot estimate reliably.

Player panel and preview

Version 2.1.0 opens /ait through PimpMyCUI 1.4.0 and separately published pages. Install AITranslationPro.cs, PimpMyCUI.cs and the ZIP files at their declared paths, including oxide/data/PimpMyCUI/plugin-pages/aitranslationpro/manifest.json and its referenced packages. Keep the manifest and packages together. Reload the plugins after installation. An unavailable dependency or page blocks this route; /ait on, off, lang, auto, original and status remain available. No former native panel is opened in its place.

Under Player panel, choose Glass Cards, Field Radio or Compact Console. The configurator prepares the page and its common frame; without a custom destination the plugin uses its default publication. A Translation page in In-game interfaces can also join your own window. The runtime links the page to AITranslationPro while the plugin retains control of permissions, consent and settings.

Edit in the CUI editor opens the page’s editable copy. Apply to bring the change back into the configuration; closing without applying preserves the previous copy. ZIP export includes publications and sources needed for later editing. Installing an editable project alone does not publish its in-game interface.

Page text is editable; plugin command messages remain English and this edition creates no Lang file of its own. Flags use declared PNG images; native icons keep their identity. Preview controls issue no server commands. Check rendering, fonts and interactions in Rust.

Cache and diagnostics

Chat cache and file memory avoid translating identical text again. ait.cache.clear clears them without deleting player preferences. ait.status reports profiles, plugin state and counters. Request, queue and token limits remain active when monetary budgets are disabled.

Install the files

With a connected server, click Send in the configurator. The result shows whether the files were sent and the plugin reloaded. Without RCON, reload the plugin from your server panel after sending.

Without a connected server: Keep a copy of the current files. Place each export in the folder shown before export, or follow the paths in the ZIP. Do not put data or translation files in the config folder.

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

Configuration and transfer guide →