Index

• Introduction
• Setup
• Adjusting server properties on a user-by-user basis

Introduction

MSCS has the ability to store server and world data on a user-by-user basis, allowing multiple users to run their respective worlds while preserving the data of other user worlds.

Example: Two user accounts are available on a server: bob and jason.
bob should only be able to run and modify Bob's worlds.
jason should only be able to run and modify Jason's worlds.
Each user can have their own properties and world locations

Setup

To accomplish this, direct users to use msctl in place of mscs when running commands (see command reference). That's it!

For instance, to create a world named world:

msctl create world 25565

To start world:

msctl start world

For all commands, replace the mscs prefix with msctl.

By default, the location of each users' worlds will be saved to $HOME/mscs/worlds, where $HOME is the home directory of the user. So if bob is logged in, and Bob's home directory is /home/bob, Bob's worlds will be saved to /home/bob/mscs/worlds.

Please note: MSCS currently does not check if a server port is free for use when creating or running worlds. All users will need to coordinate which ports are being used so no conflicts occur.

Adjusting server properties on a user-by-user basis

Server properties can be adjusted on a user-by-user basis by creating a mscs.defaults file with valid properties listed in the README. To use this feature, users will need to create a file in one of the following places:

1. $HOME/mscs.defaults
2. $HOME/.config/mscs/mscs.defaults

Each location above is valid for per-user customization.

Please note: $HOME represents the home directory of the user that is running the script. In the example above, it would be /home/jason or /home/bob depending on which user ran the script. Once the file is created, custom properties can be specified. These individual user properties will take precedent over the default properties found in the script.