Back to mods
Manifold Sample project artwork

Vintage Story Mod DB · Vintage Story mod

Manifold Sample

Manifold Sample is a small demo mod that shows how to build custom dimensions with the Manifold library. It is a working example and smoke test - not a content mod. Vintage Story 1.21+ Universal Copy-paste friendly MIT Requires Manifold. Install the library

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which Manifold Sample release should I use?

Updated 3 months ago
Latest stable file 0.4.1
Game version 0.0.0
Loader Built-in Vintage Story mod system

Manifold Sample 0.4.1 targets 0.0.0. It must be installed on the client. Installation on the dedicated server is optional. 1 required mod needs a matching file.

Where it goes

Is Manifold Sample required on the client, server, or both?

It must be installed on the client. Installation on the dedicated server is optional.

Client Required
Dedicated server Optional
Loader for this release Built-in Vintage Story mod system
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

This release supports both sides, but the source does not require it on the server.

What else does Manifold Sample 0.4.1 need?

0.4.1. Change the file and its required mods may change too.

1 required mod needs a matching file

Install Manifold first, but 1 required mod has no matching file for this setup. Do not mix loader builds to force a match.

Manifold Needed by Manifold Sample 0.4.1
required
No matching file Version asked for: 0.4.0

We only count dependency files that match this setup. A file for another loader does not fill the gap.

Before you install it

Add Manifold Sample without breaking your instance.

Built for Manifold Sample 0.4.1. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 0.4.1. It targets 0.0.0; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    Install Manifold first, but 1 required mod has no matching file for this setup. Do not mix loader builds to force a match.

  3. 03

    Put it on the correct side

    It must be installed on the client. Installation on the dedicated server is optional.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside 0.4.1. It opens that exact file at the source.

About this project

What does Manifold Sample add?

Manifold Sample is a small demo mod that shows how to build custom dimensions with the Manifold library. It is a working example and smoke test - not a content mod.

Vintage Story 1.21+ Universal Copy-paste friendly MIT

Manifold logo

Requires Manifold.
Install the library alongside this demo.

What it adds

  • A void dimension (empty air) - /voiddim. Always lands you at a fixed spawn point.
  • A flat dimension (granite floor) - /flatdim. Returns you to your last position there.
  • A streaming dimension - /streamdim. Demonstrates opt-in streaming worldgen: chunks generate on demand as you walk, with no fixed region edge.
  • A vault dimension (0.3.0) - /vaultdim. Demonstrates the per-dimension separate inventory: your overworld items wait safely while you are inside, and the vault inventory is returned on re-entry.
  • /overworlddim - travels back to the overworld, to your last position.
  • /sendtestitem (0.3.0) - spawns a test item entity at your position and teleports it to the flat dimension, demonstrating the non-player entity transit API.
  • /sendtestblock (0.4.0) - teleports the block you are looking at (with its BlockEntity contents) to the flat dimension. Place a chest, put items in it, look at it, run the command, then check it under /flatdim at the announced coordinates.
  • /createtempdim and /destroytempdim (0.4.1) - create and destroy an ephemeral dimension at runtime, demonstrating the ephemeral lifecycle and the Destroyed signal that companions (like Chart) react to.
  • The sample also subscribes to the 0.4.0 PlayerArriving and EntityChangedDimension events and logs them to the server console, so the new transit lifecycle is observable in-game.
  • A simple portal block built on Manifold's PortalBlockBase.

For developers

Read the source as a copy-paste starting point for your own dimension mod: samples/ManifoldSample. It covers registering dimensions, picking a spawn behavior, opting into streaming worldgen, opting into a separate per-dimension inventory, registering chat commands via DimensionCommandBuilder, calling TeleportEntity and TeleportBlock, and subscribing to the transit events.

Compatibility

Vintage Story 1.21+. Universal. MIT licensed. Requires Manifold 0.4.0 or later.

Project description from Vintage Story Mod DB.

Pick your setup

Manifold Sample releases for each Vintage Story version.

Choose the version and loader you play, then open the matching release.

1 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

Manifold Sample versions and loaders

6 of 6 releases match

Looking for an older file? The official Vintage Story Mod DB project page is in Resources.