https://github.com/mattidragon/demobox

A tool for creating interactive demo environments for mods
https://github.com/mattidragon/demobox

Last synced: 19 days ago
JSON representation

A tool for creating interactive demo environments for mods

• Host: GitHub
• URL: https://github.com/mattidragon/demobox
• Owner: MattiDragon
• License: mit
• Created: 2023-07-14T15:06:02.000Z (over 1 year ago)
• Default Branch: 1.20.4
• Last Pushed: 2023-12-16T09:45:22.000Z (11 months ago)
• Last Synced: 2023-12-16T10:50:13.541Z (11 months ago)
• Language: Java
• Size: 82 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog/1.0.0-beta.1+1.20.1.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DemoBox

DemoBox is a tool for creating interactive demos for mods, originally created for blanketcon 23.

It uses plasmid, the library behind nuceleoid games, to manage virtual worlds safely,

allowing users to experience mods in survival mode without risking them breaking things in the overworld.

## Usage

To create a demo using demobox, first build a structure and store it with a structure block. 

This structure will spawn in your demo worlds centered at 0, 0.

Then you can run the `/demobox open ` command to visit a demo world. 

You can leave using the `/demobox leave` command or by using the `/game` command from plasmid.

The open command requires a permission level of 2 or the `demobox.open` permission node

because it can be used to create dimensions with arbitrary structures and that could cause problems. 

The recommended way to give players access to demos is by using signs with click events.

The open command also accepts a position for where players spawn and a function to run during setup if you need to do something more advanced.