SpacetimeDB README

The project's README from github.com/clockworklabs/SpacetimeDB. As one markdown file: README.md.

SpacetimeDB Logo SpacetimeDB Logo

SpacetimeDB SpacetimeDB

Development at the speed of light.

         

   

     

Discord   Twitter   GitHub   Twitch   YouTube   LinkedIn   StackOverflow


What is SpacetimeDB?

SpacetimeDB is a relational database that is also a server. You upload your application logic directly into the database, and clients connect to it without any server in between.

Write your schema and business logic as a module in Rust, C#, TypeScript, or C++. SpacetimeDB compiles it, runs it inside the database, and automatically synchronizes state to connected clients in real-time.

Instead of deploying a web or game server that sits in between your clients and your database, your clients connect directly to the database and execute your application logic in your module. You can write all of your permission and authorization logic right inside your module just as you would in a normal server.

This means that you can write your entire application in a single language and deploy it as a single binary. No more separate webserver, no more containers, no more Kubernetes, no more VMs, no more DevOps, no more caching later. Zero infrastructure to manage.

SpacetimeDB Architecture

SpacetimeDB application architecture
(elements in white are provided by SpacetimeDB)

SpacetimeDB is optimized for maximum speed and minimum latency. SpacetimeDB provides all the ACID guarantees of a traditional RDBMS, with all the speed of an optimized web server. All application state is held in memory for fast access, while a commit log on disk provides durability and crash recovery. The entire backend of our MMORPG BitCraft Online runs as a single SpacetimeDB module: chat, items, terrain, player positions, everything, synchronized to thousands of players in real-time.

Quick Start

1. Install

# macOS / Linux
curl -sSf https://install.spacetimedb.com | sh

# Windows (PowerShell)
iwr https://windows.spacetimedb.com -useb | iex

2. Log in

spacetime login

This opens a browser to authenticate with GitHub. Your identity is linked to your account so you can publish databases.

3. Start developing

spacetime dev --template chat-react-ts

That is it. This creates a project from a template, publishes it to Maincloud, and watches for file changes, automatically rebuilding and republishing on save. See pricing for details.

How It Works

SpacetimeDB modules define tables (your data) and reducers (your logic). Clients connect, call reducers, and subscribe to tables. When data changes, SpacetimeDB pushes updates to subscribed clients automatically.

// Define a table
#[spacetimedb::table(accessor = messages, public)]
pub struct Message {
    #[primary_key]
    #[auto_inc]
    id: u64,
    sender: Identity,
    text: String,
}

// Define a reducer (your API endpoint)
#[spacetimedb::reducer]
pub fn send_message(ctx: &ReducerContext, text: String) {
    ctx.db.messages().insert(Message {
        id: 0,
        sender: ctx.sender,
        text,
    });
}

On the client side, subscribe and get live updates:

const [messages] = useTable(tables.message);
// messages updates automatically when the server state changes.
// No polling. No refetching.

Language Support

Server Modules

Write your database logic in any of these languages:

Language Quickstart
Rust Get started
C# Get started
TypeScript Get started
C++ Get started

Client SDKs

Connect from any of these platforms:

SDK Quickstart
TypeScript (React, Next.js, Vue, Svelte, Angular, Node.js, Bun, Deno) Get started
Rust Get started
C# (standalone and Unity) Get started
C++ (Unreal Engine) Get started

Running with Docker

docker run --rm --pull always -p 3000:3000 clockworklabs/spacetime start

Building from Source

If you need features from master that have not been released yet:

# Prerequisites: Rust toolchain with wasm32-unknown-unknown target
curl https://sh.rustup.rs -sSf | sh

git clone https://github.com/clockworklabs/SpacetimeDB
cd SpacetimeDB
cargo build --locked --release -p spacetimedb-standalone -p spacetimedb-update -p spacetimedb-cli

Then install the binaries:

macOS / Linux 
mkdir -p ~/.local/bin
STDB_VERSION="$(./target/release/spacetimedb-cli --version | sed -n 's/.*spacetimedb tool version \([0-9.]*\);.*/\1/p')"
mkdir -p ~/.local/share/spacetime/bin/$STDB_VERSION

cp target/release/spacetimedb-update ~/.local/bin/spacetime
cp target/release/spacetimedb-cli ~/.local/share/spacetime/bin/$STDB_VERSION
cp target/release/spacetimedb-standalone ~/.local/share/spacetime/bin/$STDB_VERSION

# Add to your shell config if not already present:
export PATH="$HOME/.local/bin:$PATH"

# Set the active version:
spacetime version use $STDB_VERSION
Windows (PowerShell) 
$stdbDir = "$HOME\AppData\Local\SpacetimeDB"
$stdbVersion = & ".\target\release\spacetimedb-cli" --version |
    Select-String -Pattern 'spacetimedb tool version ([0-9.]+);' |
    ForEach-Object { $_.Matches.Groups[1].Value }
New-Item -ItemType Directory -Path "$stdbDir\bin\$stdbVersion" -Force | Out-Null

Copy-Item "target\release\spacetimedb-update.exe" "$stdbDir\spacetime.exe"
Copy-Item "target\release\spacetimedb-cli.exe" "$stdbDir\bin\$stdbVersion\"
Copy-Item "target\release\spacetimedb-standalone.exe" "$stdbDir\bin\$stdbVersion\"

# Add to your system PATH: %USERPROFILE%\AppData\Local\SpacetimeDB
# Then in a new shell:
spacetime version use $stdbVersion

Verify with spacetime --version.

Documentation

To prepare your AI coding environment, follow the agent setup guide.

Full documentation is available at spacetimedb.com/docs, including:

License

SpacetimeDB is licensed under the Business Source License 1.1 (BSL). It converts to the AGPL v3.0 with a linking exception after a few years. The linking exception means you are not required to open-source your own code if you use SpacetimeDB. You only need to contribute back changes to SpacetimeDB itself.

Why did we choose this license? We chose to license SpacetimeDB under the MariaDB Business Source License for 4 years because we can't compete with AWS while also building our products for them.

We chose GPLv3 with linking exception as the open source license because we want contributions merged back into mainline (just like Linux), but we don't want to make anyone else open source their own code (i.e. linking exception).

SpacetimeDB (clockworklabs/SpacetimeDB)

Searching Database…

25.3K ·GitHub
SpacetimeDB
Что это такое?SpacetimeDB — это реляционная база данных, которая одновременно является и сервером: вы загружаете логику своего приложения в базу как модуль, а клиенты подключаются к ней напрямую, без веб- или игрового сервера посередине. Данные синхронизируются с подключёнными клиентами в реальном времени.
Так это база данных, сервер или и то и другое?И то и другое. Клиенты вызывают вашу логику прямо в базе — включая права доступа и авторизацию — вместо того чтобы обращаться к отдельному веб- или игровому серверу, а весь бэкенд написан на одном языке и разворачивается одним бинарником. Не нужно настраивать веб-серверы, Kubernetes или слой кеширования.
Как мне начать с этим работать?Установите SpacetimeDB CLI и войдите — откроется браузер для авторизации через GitHub, и ваша учётная запись привяжется, чтобы вы могли публиковать проекты. Новый проект создаётся из шаблона, публикуется в Maincloud и автоматически пересобирается и переопубликуется при каждом изменении файлов.
На каких языках я могу писать серверную логику?Модули пишутся на Rust, C#, TypeScript или C++ — SpacetimeDB компилирует вашу схему и бизнес-логику и выполняет их прямо внутри базы данных, так что весь бэкенд поставляется одним бинарником.
Это в основном для игр?Он подходит и для обычных бэкендов приложений, но флагманский сценарий — многопользовательские игры в реальном времени: весь бэкенд MMORPG BitCraft Online — чат, предметы, рельеф, позиции игроков — работает как один модуль SpacetimeDB и синхронизируется с тысячами игроков в реальном времени.
Могу ли я развернуть его у себя или придётся пользоваться их облаком?Можно развернуть у себя: есть настройка для Docker и устанавливаемые бинарники для macOS, Linux и Windows (PowerShell), проверяется командой 'spacetime --version'. В quickstart по умолчанию используется Maincloud — их хостинг.
Это вообще открытый код? Могу ли я делать на нём свой продукт?Это не классический open source: проект распространяется по лицензии Business Source License 1.1, которая через четыре года переходит в AGPL v3.0 со ссылкой-исключением (linking exception). Ваш собственный код остаётся закрытым — назад вы отдаёте только изменения в самом SpacetimeDB. Авторы выбрали эту лицензию, чтобы помешать AWS продавать их продукт как сервис.
Как устроена синхронизация в реальном времени внутри?Модуль определяет таблицы (ваши данные) и редьюсеры (вашу логику). Клиенты подключаются, вызывают редьюсеры и подписываются на таблицы — как только данные меняются, SpacetimeDB сам рассылает обновления подписанным клиентам.
Какие движки и фреймворки поддерживают клиентские SDK?TypeScript SDK работает с React, Next.js, Vue, Svelte, Angular, Node.js, Bun и Deno; C# — для отдельных приложений и Unity; C++ нацелен на Unreal Engine; кроме того, есть SDK для Rust.
Платный ли хостинг на Maincloud?В quickstart ваш проект публикуется в Maincloud, а README отсылает к странице с ценами за подробностями, не называя конкретных цифр.
Могу ли я настроить ИИ-агентов для написания кода, чтобы они работали с ним?Да — в документации есть руководство по настройке агентов для подготовки вашей ИИ-среды разработки, а также quickstart для каждого поддерживаемого языка, туториалы (чат-приложение, мультиплеер на Unity и Unreal) и справочники по CLI и SQL.
What are similar projects?nakama, lore, mysql-server, kafgres, libsql, server, electric, walshadow
Which topics is it in?in-memory, unreal-engine, relational-database, unity, multiplayer, web-framework, game-development, csharp, sql, real-time, cpp, docker-compose
Creator
clockworklabs
Size
119.1 MB
Stars
25.3K
Updated
CommitOct 16Releasev2.12.0Oct 13
Age
3y
Commits · 90 Days