Rust Server Knowledge Generator

How It Works

A visual guide to understanding how the knowledge generator, OpenAI, and your Rust server work together.

System Overview

Server Admin

Fills out form

This Website

Generates knowledge files

OpenAI

OpenAI

Vector Store

Setup Complete

Players

Ask questions in chat

Rust

Rust Server

OpenAI Chat Plugin

OpenAI API

Searches knowledge + AI response

Two Ways to Deploy

Option A: Deploy from WebsiteRecommended
  1. 1Fill out the form with your server info
  2. 2Enter your OpenAI API key in "Deploy to OpenAI"
  3. 3Click "Deploy to OpenAI" to create your vector store
  4. 4Copy the Vector Store ID to your plugin config
  5. 5Update anytime by clicking "Update Files"

Plugin config:

"Vector Store ID": "vs_xxx..."
"Auto Create Vector Store": false
Option B: Manual File Transfer
  1. 1Fill out the form with your server info
  2. 2Download the knowledge files (.zip)
  3. 3Extract to your server's knowledge folder
  4. 4Run openai.kb sync in console
  5. 5Repeat steps 2-4 to update

File paths:

oxide/data/OpenAI/knowledge/
carbon/data/OpenAI/knowledge/
Plugin Console Commands
openai.kb

Show all knowledge base commands

openai.kb status

Check knowledge base configuration

openai.kb sync

Upload local files to vector store

openai.kb pull

Download files from vector store

openai.kb files

List files in vector store

openai.kb clear

Remove all files from vector store

Frequently Asked Questions

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.

Which method should I use?

Deploy from Website is recommended because updates are instant - just click a button. Manual file transfer requires FTP/SFTP access and running sync commands each time you update.

Is my API key safe?

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.

Can I edit files locally and push them?

Yes! Use openai.kb pull to download files to your server, edit them with a text editor, then openai.kb sync to upload changes.

Back to Generator
Get the OpenAI Chat Plugin on Codefling