minecraft-bedrock-server

minecraft bedrock server wrapper

Usage no npm install needed!

<script type="module">
  import minecraftBedrockServer from 'https://cdn.skypack.dev/minecraft-bedrock-server';
</script>

README

minecraft-bedrock-server

NPM version Build Status Discord Try it on gitpod

Simple command line/software interface for starting a Minecraft bedrock server

Running & Installation

Start a server through the command line: npx minecraft-bedrock-server -v 1.18.0

Or with npm to use programmatically:1 npm install minecraft-bedrock-server

Usage

via command line

npx minecraft-bedrock-server --help

npx minecraft-bedrock-server --version 1.18.0 --online --path ./my1.18server

any extraneous -- options will be placed inside the server.properties file, e.g. --level-name coolWorld.

via code

see index.d.ts

const bedrockServer = require('minecraft-bedrock-server')

const onStart = () => console.log('Server started!')

bedrockServer.startServer('1.18.0', onStart, { 'server-port': opt.port, 'online-mode': Boolean(opt.online), path: opt.path ? opt.path : undefined })

Help screen

minecraft-bedrock-server - v1.0.0
Minecraft Bedrock Server runner

Options:
  --version, -v Version to connect as
  --port        Port to listen on  (default: 19132)
  --online      Whether to run in online mode
  --path        Custom path to the server directory

Testing

npm test

History

See history