blockexchange

• Index

Contents

• Download
• Upload
• Offline
• Online

Topics

• readme

Modules

• api.info
• api.schema
• api.token
• api.util
• commands.emerge
• commands.load
• commands.save
• jobcontext
• token
• util.check_api_compat
• util.deserialize
• util.get_mapblock
• util.ignored_content_ids
• util.sort_pos
• util.unpack_schemapart
• util.validate_name

Examples

• promise.lua

minetest blockexchange mod

Overview

The blockexchange mod allows you to share and use your builds across different worlds. It uses a central (configurable) server to exchange schemas (builds) of near infinite size.

The server part lives at https://github.com/blockexchange/blockexchange_server and can be self-hosted.

Schemas can be browsed and administered on the central server: https://blockexchange.minetest.ch

Basic usage

Download

• Start your minetest app
• Download the blockexchange mod in the "Content" tab from the ContentDB.
• Add the blockexchange mod to the secure HTTP-Mods settings (search for "http" in the "settings" tab)
• Create a new world and activate the mod
• Grant yourself the needed privs with /grantme blockexchange
• Search for an empty place and mark it with /bx_pos1
• Browse online for a schema at https://blockexchange.minetest.ch
• Load the schema with the /bx_load <username> <schemaname> command (WARNING: this may place the schema over existing builds!)
• Have fun!

Upload

• Start your minetest app
• Download the blockexchange mod in the "Content" tab from the ContentDB.
• Add the blockexchange mod to the secure HTTP-Mods settings (search for "http" in the "settings" tab)
• Create a new world and activate the mod
• Grant yourself the needed privs with /grantme blockexchange
• Build a thing
• Set positions on the opposite corners with /bx_pos1 and /bx_pos2
• Login with an access token generated from https://blockexchange.minetest.ch: /bx_login [username] [access_token]
• Save the schematic with /bx_save <name>

Chat commands

Offline

Local commands, they don't need the http-api and make no calls "home"

• /bx_hud [on|off] enables or disables the blockexchange hud
• /bx_pos1 mark position 1
• /bx_pos2 mark position 2
• /bxarearemove [area_id?] removes the area information (not the build)
• /bxareamark [area_id?] marks the area
• /bx_emerge emerge the selected area
• /bxsavelocal [schemaname] saves a local schema to <worldmods>/bxschems
• /bxloadlocal [schemaname] loads a local schema from <worldmods>/bxschems
• /bxallocatelocal [schemaname] allocates a local schema

Online

Online commands, they call the remote-server with the http api

Read-only

• /bx_info shows infos about the connected blockexchange server
• /bx_license sets or displays the license of your uploaded schematics (defaults to CC0)
• /bx_load [username] [schemaname] load a schema by name onto pos1
• /bxloadupdate [area_id?] loads the changes of a loaded area
• /bx_allocate [username] [schemaname] allocates a schema by name
• /bxlogin [username] [accesstoken] logs in with the username and token
• /bx_cancel Cancels an active job

Write (needs a login)

• /bx_save [schemaname] saves/uploads the selected area as a new schema
• /bxsaveupdate [area_id?] saves the changes of a loaded area (use it with the position markers)
• /bx_logout logs out
• /bx_login shows the login status

Privileges

• blockexchange can use the blockexchange commands (admin)
• blockexchangeprotectedupload can upload self-protected areas (survival-compatible)

Settings

• blockexchange.url URL to the central server

The mod also needs the http api:

 secure.http_mods = blockexchange

Api docs

See: https://blockexchange.github.io/blockexchange/

License

• Code: MIT
• Textures: CC-BY-SA 3.0 (http://www.small-icons.com/packs/16x16-free-application-icons.htm)