How It Works
Build knowledge files for the OpenAI Chat plugin on your Rust (Oxide or Carbon) server. Sign in and select a project to edit files, deploy to OpenAI, or download the .zip.
This site generates knowledge files that the OpenAI Chat plugin uses to answer player questions in chat. You fill out a form (server info, wipe schedule, rules, commands, FAQ, etc.), then either deploy those files to an OpenAI vector store from the site or download a .zip and sync from your server. You need to sign in and select or create a project before you can edit files or deploy.
Getting started
Sign in to create an account or use an existing one. After signing in, use the project switcher in the header to create a new project or switch between projects. All your form data and knowledge files are stored per project.
Home: Building your knowledge
On the home page you have three areas: the file list (left), the form (center), and the file preview (right). The form is split into sections that drive the generated .txt files: Server Basics, Wipe Schedule, Server Settings, Rules, Commands, VIP Features, Events, Map Info, Server Highlights, and FAQ. The corresponding files are server-info.txt, wipe-schedule.txt, server-settings.txt, rules.txt, commands.txt, vip-features.txt, events.txt, map-info.txt, server-highlights.txt, and faq.txt. Select a file in the list to preview its content. You can also add custom files from the file list and edit their content in the preview pane.
Use the AI Assistant to fill out the form by chat. Tell it your server name, wipe schedule, rules, plugins with commands, FAQ, etc., and it will update the form and add plugins/commands for you. The assistant uses its own OpenAI API key (separate from the one you enter on the Deploy page), so you can use it without deploying.
If your server is listed on BattleMetrics, use Quick Server Lookup and enter your server IP and port. The tool will fetch server name, region, players, map size, wipe info, and other details and prefill the form for you.
In the Commands form section you can search and add plugins (from the default catalog or your own), add chat commands, and contribute commands for plugins. These feed into commands.txt for the knowledge base.
Default Rust knowledge files
The site includes a set of pre-written general Rust knowledge files that you can add to your project. These cover items, crafting, guides, raiding, and electrical content. They supplement your server-specific files (server info, rules, commands, etc.) so the AI can answer both general Rust questions and questions about your server.
You'll see an Add Rust knowledge button in the file list on the home page. Click it to add the default files to your project. Files that conflict with your generated file names (e.g. server-info.txt, commands.txt) are skipped automatically.
- Crafting — No workbench, Workbench 1–3
- Electrical — Circuits, components
- Guides — Base building, farming, monuments, new player, PvP combat, scrap
- Items — Ammunition, attire, construction, electrical, food, medical, resources, tools, weapons, traps, and more
- Raiding — Twigs, wood, stone, metal, top tier
- General — Rust news links and search tips
Once added, these files become part of your knowledge library and can be edited or left as is—it's up to you. Use them when you deploy to OpenAI or download the .zip so players can ask about both your server and general Rust gameplay.
Deploy page
Click Deploy in the header. You must have a project selected and an OpenAI API key. On the Deploy page, the left sidebar lists your vector stores; you can create a new one or select an existing one. The main area shows the selected store's name, Vector Store ID (copy button), file list, and actions: Push, Pull, Refresh, and Clear. The right sidebar shows deployment history, support link, and Download .zip.
Push uploads the current project's knowledge files (form-generated plus custom files) to the selected vector store. Use it after editing the form or adding custom files. Pull downloads files from the vector store into your current project; after that, Deploy and Download use those pulled files until you click Regenerate from form to switch back to form-generated content. Copy the Vector Store ID into your plugin config and set Auto Create Vector Store to false when using a store you create here.
On the Deploy page sidebar (or mobile section), use Download .zip to generate all knowledge files and download them as a zip. Extract to your server at oxide/data/OpenAI/knowledge/ or carbon/data/OpenAI/knowledge/, then run openai.kb sync in the F1 console to upload them to your vector store.
Paths:
oxide/data/OpenAI/knowledge/carbon/data/OpenAI/knowledge/System overview
Server Admin
Fills out form
This Website
Generates knowledge files
OpenAI
Vector Store
Players
Ask questions in chat
Rust Server
OpenAI Chat Plugin
OpenAI API
Searches knowledge + AI response
Two ways to deploy
- 1Sign in and select or create a project, then fill out the form with your server info
- 2Go to Deploy and enter your OpenAI API key
- 3Create a new vector store or select an existing one, then click Push to upload files
- 4Copy the Vector Store ID into your plugin config
- 5Update anytime by clicking Push again after editing the form
Plugin config:
"Vector Store ID": "vs_xxx...""Auto Create Vector Store": false- 1Fill out the form with your server info
- 2Download the knowledge files (.zip) from the Deploy page
- 3Extract to your server's knowledge folder
- 4Run
openai.kb syncin console - 5Repeat steps 2-4 to update
File paths:
oxide/data/OpenAI/knowledge/carbon/data/OpenAI/knowledge/openai.kbShow all knowledge base commands
openai.kb statusCheck knowledge base configuration
openai.kb syncUpload local files to vector store
openai.kb pullDownload files from vector store
openai.kb filesList files in vector store
openai.kb clearRemove all files from vector store
Why do I need to sign in?
Signing in lets you create and switch between projects. Your form data and knowledge files are stored per project and synced across devices. Deploy and file editing require a project to be selected.
What is a Vector Store?
A vector store is a database hosted by OpenAI that stores your knowledge files and allows the AI to search through them semantically. When a player asks a question, the AI searches the vector store for relevant information before generating a response.
Do I need to pay for OpenAI?
Yes, the OpenAI Chat plugin requires an OpenAI API key with credits. Costs vary significantly based on player usage, the AI model selected, and your rate limit settings. We recommend testing the plugin and monitoring your costs on the OpenAI Usage page to determine your expected monthly spend.
How much does it cost in API fees?
This site does not charge you. You only pay OpenAI for API usage: vector store operations (creating stores, uploading files), the AI Assistant chat (if you use it), and on your Rust server when players ask questions (the plugin calls OpenAI). Costs depend on how much you use each feature, which models you use, and your rate limits. Check the OpenAI Usage and Pricing pages to estimate your costs.
Which method should I use?
Deploy from Website is recommended because updates are instant—just click Push. Manual file transfer requires FTP/SFTP access and running sync commands each time you update.
What is my API key used for?
On the Deploy page, your API key is used to talk to OpenAI's API: creating and listing vector stores, uploading (Push) and downloading (Pull) knowledge files, and refreshing or clearing store contents. All of that happens between your browser and OpenAI; we don't use your key on our servers unless you opt in to save it in a config backup. The AI Assistant uses a separate API key (that you enter in the assistant panel) for chat and form-filling; that key is also sent only to OpenAI from your browser.
What OpenAI model is used?
The AI Assistant on this site uses gpt-4o-mini. This is set by an admin in Default config; if none is set, gpt-4o-mini is used. The model that answers players in-game is configured in your Rust server's OpenAI Chat plugin config, not here.
Is my API key safe?
By default your API key is stored only in your browser's local storage and sent directly to OpenAI; it never touches our servers. For best security, use a dedicated API key with spending limits. As a convenience when copying and pasting entire OpenAI.json config files onto your server, you can opt in to store your API key on our servers so it is included in the saved config backup—this is optional and entirely your choice.
Troubleshooting
API key errors or "Invalid API key"
Make sure your OpenAI API key is correct and has not been revoked. Create or check your key at OpenAI API keys. If you use the AI Assistant, it uses a separate key—enter it in the assistant panel. For Deploy (Push/Pull), use the key field on the Deploy page.
Vector store not syncing or files not updating
After clicking Push, wait for the upload to finish. If you use manual file transfer, ensure files are in oxide/data/OpenAI/knowledge/ or carbon/data/OpenAI/knowledge/ and run openai.kb sync in the server console. Check that your plugin config uses the correct Vector Store ID and Auto Create Vector Store: false when using a store you created on this site.
Files or "Add Rust knowledge" not appearing
Sign in and select a project first. The file list and form only appear when a project is selected.
Save failed or form not updating
Check your connection and try again. If you see a save error at the top of the page, use Retry. Your data is stored per project; switching projects loads that project's data.