Getting Started

A step-by-step guide to installing Oxyde, initializing your first agent, and running it inside Unity, Unreal, or a standalone Rust runtime. Perfect for developers ready to build intelligent NPCs.

🚀 Quickstart

Want to try Oxyde without wiring it into an engine? Run a live agent from the CLI.

🔧 Requirements:

• Rust (v1.72+)

• An OpenAI/Groq API key (or local GGUF model setup)

▶️ Run demo agent:

git clone https://github.com/Oxyde-Labs/Oxyde.git
cd oxyde
cargo run --example rpg_demo

You'll enter a terminal chat with a preconfigured Oxyde agent using live inference and memory.

---

🛠️ Project Setup

Want to build your own agent or integrate into a game?

---

1. Clone the repo

git clone https://github.com/Oxyde-Labs/Oxyde.git
cd oxyde

---

2. Set your API key

Oxyde supports multiple providers:

export OPENAI_API_KEY=your-key
export GROQ_API_KEY=your-key

You can also edit config.json to route inference locally or to another model.

---

3. Build & Run

cargo build
cargo run --example rpg_demo

You should now be talking to a memoryful NPC in your terminal.

---

🎮 Unity or Unreal?

Oxyde offers drop-in SDKs and bindings:

Engine	Language	Instructions
Unity	C#	Unity Integration
Unreal	C++	Unreal Integration
WASM	Rust	WASM Setup