Skip to content

Mchprs

services.mchprs.dataDir

Directory to store MCHPRS database and other state/data files.

Type: path

Default

"/var/lib/mchprs"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.declarativeSettings

Whether to use a declarative configuration for MCHPRS.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.declarativeWhitelist

Whether to use a declarative whitelist. The options {option}services.mchprs.whitelist.list will be applied if and only if set to true.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.enable

Whether to enable MCHPRS, a Minecraft server. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.maxRuntime

Automatically restart the server after {option}services.mchprs.maxRuntime. The time span format is described here: https://www.freedesktop.org/software/systemd/man/systemd.time.html#Parsing%20Time%20Spans. If null, then the server is not restarted automatically.

Type: string

Default

"infinity"

Example

"7d"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.openFirewall

Whether to open ports in the firewall for the server. Only has effect when {option}services.mchprs.declarativeSettings is true.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.package

The mchprs package to use. Type: package

Default

pkgs.mchprs

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.settings

Configuration for MCHPRS via Config.toml. See https://github.com/MCHPR/MCHPRS/blob/master/README.md for documentation.

Type: TOML value

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.settings.address

Address for the server. Please use enclosing square brackets when using ipv6. Only has effect when {option}services.mchprs.declarativeSettings is true.

Type: string

Default

"0.0.0.0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.settings.auto_redpiler

Use redpiler automatically. Only has effect when {option}services.mchprs.declarativeSettings is true.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.settings.block_in_hitbox

Allow placing blocks inside of players (hitbox logic is simplified). Only has effect when {option}services.mchprs.declarativeSettings is true.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.settings.bungeecord

Enable compatibility with BungeeCord. Only has effect when {option}services.mchprs.declarativeSettings is true.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.settings.chat_format

How to format chat message interpolating username and message with curly braces. Only has effect when {option}services.mchprs.declarativeSettings is true.

Type: string

Default

"<{username}> {message}"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.settings.max_players

Maximum number of simultaneous players. Only has effect when {option}services.mchprs.declarativeSettings is true.

Type: positive integer, meaning >0

Default

99999

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.settings.motd

Message of the day. Only has effect when {option}services.mchprs.declarativeSettings is true.

Type: string

Default

"Minecraft High Performance Redstone Server"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.settings.port

Port for the server. Only has effect when {option}services.mchprs.declarativeSettings is true.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

25565

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.settings.schemati

Mimic the verification and directory layout used by the Open Redstone Engineers Schemati plugin. Only has effect when {option}services.mchprs.declarativeSettings is true.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.settings.view_distance

Maximal distance (in chunks) between players and loaded chunks. Only has effect when {option}services.mchprs.declarativeSettings is true.

Type: positive integer, meaning >0

Default

8

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.whitelist.enable

Whether or not the whitelist (in whitelist.json) shoud be enabled. Only has effect when {option}services.mchprs.declarativeSettings is true.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix

services.mchprs.whitelist.list

Whitelisted players, only has an effect when {option}services.mchprs.declarativeWhitelist is true and the whitelist is enabled via {option}services.mchprs.whitelist.enable. This is a mapping from Minecraft usernames to UUIDs. You can use https://mcuuid.net/ to get a Minecraft UUID for a username.

Type: attribute set of Minecraft UUID

Default

{ }

Example

{username1 = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";username2 = "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy";};

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/mchprs.nix