Skip to content

Service details homepage

Jump to bottom
Tad Tarrant edited this page Jan 15, 2022 · 2 revisions

This page contains information specific to the service and it's configuration.

Service controls

This service uses TopShelf to install, run and manage the service. It is highly recommended that you have performed the steps in the quick-start before running this software as a service!

To install as a service, simply open a command prompt (or powershell) as Administrator, browse to the service directory, and run:

BedrockService.Service install

You will see a message for a few moments stating that the service has been installed before the window closes. Now with the service installed, you can run:

BedrockService.Service start

You will get a message in less than a minute stating that the service was started successfully. Additionally,

BedrockService.Service stop

will stop the service and all of its contained servers.

Service configuration files and directory layout

The following files relate to the service and the servers run on it:

  • Server folder:
    • bedrock_ver.ini - keeps track of last downloaded version.
    • stock_packs.json; stock_props.conf - these two files contain current version bedrock server defaults.
    • Configs folder:
      • KnownPlayers folder:
        • This folder contains files with a name format of "ServerName.playerdb". See "Player Manager" section for more details.
      • RegisteredPlayers folder:
        • This folder contains files with a name format of "ServerName.preg". See "Player Manager" section for more details.
      • Backups folder for configuration file backups.
      • Individual server configuration files (Name format:{ServerName}.conf)
    • MCSFiles folder:
      • Update_x.xx.xx.xx.zip - Archive files downloaded from minecraft.net, x.xx.xx.xx is version of server.
    • Logs folder - Contains logs of only server outputs.
  • Service folder contains:
    • Globals.conf - Global service configuration file.
  • BedrockService.Service.exe - core service executable.

All service configuration files use a key=value layout. (Ex. ServersPath=C:\MCBedrockService). The parser will ignore any lines beginning with a "#" sign for comments as well as empty lines.

Globals.conf:

#Globals
ServersPath=C:\MCBedrockService // This is the path you wish to house your actual dedicated server files. Servers will deploy in a folder named after the chosen server’s name.
AcceptedMojangLic=false // Currently disabled! Will replace with disclaimer here in readme and remove this soon.
ClientPort=19134 // This is the port that will be used to listen for clients.
#Backups
BackupEnabled=false // Enable automatic backup system. Can still do manual one-click backups from GUI when disabled.
BackupPath=Default // Specify a path you wish to store server backups in. Leaving as Default will send your backups to "PathToService"\Servers\Backups\ServerName
BackupCron=0 1 * * * // Backup time interval. This is a Cron string, search "Cron time format" in your favorite search engine to find more details.
MaxBackupCount=25 // This number determines the maximum number of backups to maintain. Does not affect manual backups via GUI.
EntireBackups=false // Enabling this option will backup the entire server directory. Default "false" will backup only the "worlds" folder.
#Updates
CheckUpdates=true // Enabling this option turns on automatic updates.
UpdateCron=38 19 * * * // Update time interval. This is a Cron string, search "Cron time format" in your favorite search engine to find more details.
#Logging
LogServerOutput=false // Enabling this option will cause the service to write server logs to file.
LogApplicationOutput=false // Enabling this option will cause the service to write the service log to file.

Server config file

Note: Filename layout - if your server's name is “DefaultServer”, your config should be “DefaultServer.conf”.

# Server  
server-name=Default // These entries are pulled directly from “server.properties”. Modify values to your liking, but do not modify anything left of the equals sign!
gamemode=creative
difficulty=easy
allow-cheats=false
max-players=10
online-mode=true
white-list=false
server-port=19132
server-portv6=19133
view-distance=32
tick-distance=4
player-idle-timeout=30
max-threads=8
level-name=Bedrock level
level-seed=
default-player-permission-level=member
texturepack-required=false
content-log-file-enabled=false
compression-threshold=1
server-authoritative-movement=server-auth
player-movement-score-threshold=20
player-movement-distance-threshold=0.3
player-movement-duration-threshold-in-ms=500
correct-player-movement=false

# StartCmds
AddStartCmd=help 1 // Any of these optional fields will send following command to server after startup.

Backups and the backup manager

BMS contains a small but functional way to manage backups. Backups can be set to a schedule, or performed manually at anytime via the GUI. Backups are generated using Bedrock's built-in save function, allowing downtime free backups. The process also backs up any packs known to the world at the time. The backup manager in the GUI can be used to delete backups, or rollback the server to the selected timestamp.

Rolling back a server will: * Stop the server. * Remove old world files. * Replace with the backup files. * Replace any installed packs. * Start the server.

Players and the player manager

Currently, BMS keeps track of connection times for all known players for each server. This applies to all players regardless of permissions or status. The Player manager within the GUI will display a list of known players, with an included filtering tool for easy searching. Player permissions and whitelist status can be altered, as well as adding players to the registry for preset player permissions/whitelist. Players do NOT have to be known before adding. Changing the status of a player (or players) will save the player information to the correct files, and force refresh of them. Players with changed permissions should be granted them within moments of pushing the updated player.

Clone this wiki locally