> For the complete documentation index, see [llms.txt](https://beyond-sandbox.gitbook.io/realitysdk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://beyond-sandbox.gitbook.io/realitysdk/readme.md).

# Welcome

Welcome to the official documentation for the RealitySDK, the official modding SDK for *Beyond Sandbox*, a multiplayer VR sandbox platform powered by Unreal Engine 5.

It provides creators with the tools to build fully interactive, physics-driven, and multiplayer-ready experiences. From custom weapons to complete game modes, RealitySDK enables you to create and share your own content inside Beyond Sandbox.

Beyond Sandbox is designed as a **modding-first platform**, combining advanced physics, VR interactions, and user-generated content to create an ever-expanding ecosystem of experiences.

***

## 🧩 RealitySDK – What You Can Do

Here’s what you can build with RealitySDK.

***

### 🎮 Gameplay Creation

#### Interactables

Create interactive objects and gameplay elements:

* Firearms
* Melee weapons
* Props

**Features:**

* Built-in tools to easily create and configure hand poses for interactions
* Melee weapons include a **Sharp Area component** for stabbing and slashing mechanics

***

#### Game Modes

* Create fully custom game modes
* Configure rules, flow, and logic

**Systems available:**

* GameMode API
* Game Data system
* Spawn system
* Teams system

***

#### Gameplay Systems

* Use the Reality Gameplay System to drive mechanics
* Build reusable gameplay logic

***

### 🧠 Systems & Logic

#### Reality Function System

* Create reusable logic blocks
* Drive gameplay behaviors and interactions

#### Game Feature System

* Modular feature architecture
* Enable or disable gameplay features dynamically

**Extend the base game using:**

* Native Game Features

***

### 🌍 World Building

#### Levels

* Create custom maps
* Support multiple game modes per level

**Tools & Optimization:**

* Light scenarios & variants per level (eg Day/Night/Rain)
* Level tools
* Requirements & guidelines

***

### ⚙️ Data & Runtime Systems

#### Reality Asset Data

* Create structured data assets
* Define gameplay properties
* Implement runtime-editable properties

#### Runtime Systems

* Spawn actors dynamically
* Access game context

***

### 🧱 Core Framework

#### Classes & Core Systems

* Extend base classes
* Customize core gameplay behavior

#### Session System

* Use session widgets
* Manage game sessions and flow

***

### 🖥️ UI Systems

* Create custom UI using:
  * Native widgets
  * Virtual screens
  * Tablet gamemode dedicated widget
  * Wrist widget

***

### 🧪 Sandbox Systems

* Spawn and manipulate objects at runtime
* Build dynamic sandbox-style experiences
* Access shared game context

***

### ⚡ Tools & Platform Support

**Target platforms:**

* Standalone VR (Quest 2, Quest 3)
* PCVR

**Tools:**

* Device scalability settings
* Performance guidelines
* Sideloadable Debug Builds for Rapid Iteration
* Integrated mod.io Support
* In-Editor Play Testing (PIE)  (Work in Progress)

***

### 🌍 Vision

RealitySDK exists to empower creators to:

> Build anything from small gameplay mods to full VR experiences inside a shared multiplayer platform.

### Jump right in

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4><i class="fa-arrow-down-to-bracket">:arrow-down-to-bracket:</i></h4></td><td><strong>Get Modkit</strong></td><td>Install &#x26; Setup The RealitySDK</td><td></td><td></td><td><a href="/pages/7a1562904fd536adf0dcc367e7c94af5fde4ab6e">/pages/7a1562904fd536adf0dcc367e7c94af5fde4ab6e</a></td></tr><tr><td><h4><i class="fa-toolbox">:toolbox:</i></h4></td><td><strong>Make your First Mod</strong></td><td>Learn the basics</td><td></td><td></td><td><a href="/spaces/YleV5RbOUz0IHfYLEfwM/pages/a515baea84e4d9149ad1db3db4ddeafe00791f36">/spaces/YleV5RbOUz0IHfYLEfwM/pages/a515baea84e4d9149ad1db3db4ddeafe00791f36</a></td></tr><tr><td><h4><i class="fa-discord">:discord:</i></h4></td><td><strong>Join The Community</strong></td><td>Join us on Discord</td><td></td><td></td><td><a href="https://discord.gg/beyond-sandbox">https://discord.gg/beyond-sandbox</a></td></tr></tbody></table>
