Interface GameSettings

Hierarchy

  • GameSettings

Properties

cli? disabledCoreScripts? hostKey ip? local map? mapDirectory? modules? port postServer? recursiveLoading? scripts?

Properties

Optional cli

cli?: boolean

Optional disabledCoreScripts

disabledCoreScripts?: string[]

An array containing the names of core scripts you do not want to run.
For ex: ["admin.js"]

You can use ["*"] to disable ALL core scripts.

Default

true

hostKey

hostKey: string

The host key of the Brick Hill set.

Optional ip

ip?: string

IP to bind the server to (Default 127.0.0.1 on local, 0.0.0.0 otherwise)

local

local: boolean

A boolean indicating if the server is locally hosted or not. Uses port 42480 by default.
Port forwarding is not required

Default

false

Optional map

map?: string

The name of the brk file to be hosted. (ex: hello.brk)

Optional mapDirectory

mapDirectory?: string

The file path to server's map folder.

Optional modules

modules?: string[]

An array containing the names of npm modules / core node.js modules you want to compile from host, and use inside the VM context.

You can require them with getModule

port

port: number

The port the server will be running on. (Default is 42480).

Optional postServer

postServer?: boolean

Whether or not the server will be posted to the games page.

Optional recursiveLoading

recursiveLoading?: boolean

If enabled, all files (even inside of folders) in user_scripts will be loaded recursively

Optional scripts

scripts?: string

A link to your scripts directory. ex: (/myfolder/user_scripts)

Settings

Member Visibility

Theme