minecraft-bedrock-server


Command line program (CLI) and API for starting and working with Minecraft Bedrock Edition servers.

Running & Installation

Start a server through the command line:

npx minecraft-bedrock-server -v 1.18.0

Or with npm to use programmatically:

npm install minecraft-bedrock-server

Usage

$3

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.

$3

see index.d.ts

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

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

bedrockServer.startServer('1.18.0', onStart, { 'server-port': 19132, 'online-mode': true, path: './bds' })
`

#### Get latest server data
From minecraft.net downloads
`js
bedrockServer.getLatestVersions().then(console.log)
`
to get
`coffee
Versions {
linux: {
version4: '1.20.72.01',
version3: '1.20.72',
url: 'https://minecraft.azureedge.net/bin-linux/bedrock-server-1.20.72.01.zip'
},
windows: {
version4: '1.20.72.01',
version3: '1.20.72',
url: 'https://minecraft.azureedge.net/bin-win/bedrock-server-1.20.72.01.zip'
},
macos: null,
preview: {
...
macos: null
}
}
`

$3

`
minecraft-bedrock-server - v1.2.0
Minecraft Bedrock Server runner
Options:
--version, -v Version to download (use "latest" for latest)
--port Port to listen on for IPv4 (default: 19132)
--port6 Port to listen on for IPv6 (default: 19133)
--online Whether to run in online mode
--path Custom path to the server directory
--versions Passing --versions will list all versions
--download Download (but not run) the server binary for this platfrom (default: linux)
Usage:
minecraft-bedrock-server --version latest Start a server on the latest version
minecraft-bedrock-server --versions List all avaliable versions
minecraft-bedrock-server -v 1.20.0 --download Download (but not run) v1.20
`

API

See the exported TypeScript defs for method docs.

Testing


npm test`

History

See history