Freven DevKit

Freven DevKit is the developer distribution of Freven:

• freven_boot launcher (resolves experiences/mods, creates load plans)
• freven_client and freven_server binaries
• core_experiences/ (includes the Vanilla reference experience)
• templates for clean client/server instances

This repository contains documentation and issue tracking only. Binaries are distributed via GitHub Releases.

Download

Go to Releases and download the archive for your OS:

• Linux: freven-devkit-vX.Y.Z-x86_64-unknown-linux-gnu.tar.gz
• Windows: freven-devkit-vX.Y.Z-x86_64-pc-windows-msvc.zip
• macOS: freven-devkit-vX.Y.Z-*-apple-darwin.(tar.gz|zip) (when available)

After extracting, you will get a folder like: freven-devkit-vX.Y.Z-<target>/

Quickstart (Dedicated server + client)

Linux / macOS

cd freven-devkit-vX.Y.Z-<target>

mkdir -p instances
./freven_boot init --instance instances/server server
./freven_boot init --instance instances/player client

# Terminal 1:
./freven_boot serve --instance instances/server

# Terminal 2:
./freven_boot play --instance instances/player -- --username dev --devtools --connect 127.0.0.1:12806

Windows (PowerShell)

cd freven-devkit-vX.Y.Z-<target>

mkdir instances
.\freven_boot.exe init --instance instances\server server
.\freven_boot.exe init --instance instances\player client

# Terminal 1:
.\freven_boot.exe serve --instance instances\server

# Terminal 2:
.\freven_boot.exe play --instance instances\player -- --username dev --devtools --connect 127.0.0.1:12806

Quickstart (Singleplayer / inproc)

Linux / macOS

cd freven-devkit-vX.Y.Z-<target>
mkdir -p instances
./freven_boot init --instance instances/sp client
./freven_boot play --instance instances/sp -- --username dev --devtools

Windows (PowerShell)

cd freven-devkit-vX.Y.Z-<target>
mkdir instances
.\freven_boot.exe init --instance instances\sp client
.\freven_boot.exe play --instance instances\sp -- --username dev --devtools

Where things live

An instance is your mutable user data folder. It will contain:

• logs/ (runtime logs)
• run/ (generated load plans)
• worlds/ (world storage)
• net/ (QUIC trust/certs/TOFU pins)
• mods/ (your mods)
• experiences/ (your custom experiences)

Important:

• The DevKit archive is read-only. You can delete and re-extract it anytime.
• Your instances are safe to keep between updates.
• Dedicated server server.toml keeps world-stack runtime inputs under [world_bootstrap] and [world_streaming]. On first boot, the server opens or creates <instance>/worlds/<world_id>/, writes world.toml, and binds that save to the resolved experience.

Writing mods / creating experiences

• Neutral platform-shaped authoring uses freven_mod_api, freven_guest_sdk, and freven_sdk_types from freven-sdk.
• Current gameplay/world-stack authoring uses the explicit freven_world_api, freven_world_guest_sdk, and freven_world_sdk_types surfaces from freven-sdk for block/content registration, world queries/mutations, terrain-write worldgen, and world runtime services.
• A from-scratch runtime-loaded Wasm mod walkthrough is documented in docs/FIRST_WASM_MOD.md.
• Simulation-style runtime block mutation authoring is documented in docs/BLOCK_MUTATION_AUTHORING.md.
• Vanilla is the first-party reference experience above that world stack. It owns first-party gameplay policy such as flat worldgen, humanoid controls, break/place ids, and nameplate presentation.

See:

• docs/GETTING_STARTED.md
• freven-sdk docs (WASM ABI / External IPC / Native ABI).

Bug reports

Before opening an issue, please read:

• docs/REPORTING_BUGS.md

Include:

• output of freven_boot --version
• manifest/devkit_manifest.toml
• relevant logs from your instance (logs/)

License

• This repository (docs/templates) is under MIT (see LICENSE).
• DevKit binaries/content are covered by LICENSE-DEVKIT.txt (distributed with the release).

Authoring references

• Getting started
• First Wasm mod
• Data/content asset workflow
• Modular content authoring
• Content authoring profiles
• Vanilla blocktype modding
• Asset pipeline diagnostics
• Asset authoring templates
• Content family authoring
• Asset inspector / devtools
• Asset/content hot reload
• Mod DevTools v1
• Friendly authoring diagnostics
• Project templates
• Engine vs Vanilla ownership
• Provider selection authoring
• Block mutation authoring
• Troubleshooting