Skip to content

Interface ServerOptions

This is the case you provide the server jar execution path.

🏷️ Properties

classPath optional

ts
classPath: string[]

Defined in: packages/core/launch.ts:455

extraExecOption optional

ts
extraExecOption: SpawnOptions

Inherited from: BaseServerOptions.extraExecOption

Defined in: packages/core/launch.ts:432

extraJVMArgs optional

ts
extraJVMArgs: string[]

Inherited from: BaseServerOptions.extraJVMArgs

Defined in: packages/core/launch.ts:430

extraMCArgs optional

ts
extraMCArgs: string[]

Inherited from: BaseServerOptions.extraMCArgs

Defined in: packages/core/launch.ts:431

javaPath

ts
javaPath: string

Java executable. Inherited from: BaseServerOptions.javaPath

Defined in: packages/core/launch.ts:423

mainClass optional

ts
mainClass: string

Defined in: packages/core/launch.ts:453

maxMemory optional

ts
maxMemory: number

Inherited from: BaseServerOptions.maxMemory

Defined in: packages/core/launch.ts:429

minMemory optional

ts
minMemory: number

Inherited from: BaseServerOptions.minMemory

Defined in: packages/core/launch.ts:428

nogui optional

ts
nogui: boolean

No gui for the server launch Inherited from: BaseServerOptions.nogui

Defined in: packages/core/launch.ts:427

prependCommand optional

ts
prependCommand: string | string[]

Inherited from: BaseServerOptions.prependCommand

Defined in: packages/core/launch.ts:434

serverExectuableJarPath optional

ts
serverExectuableJarPath: string

The minecraft server exectuable jar file.

This is the case like you are launching forge server.

Defined in: packages/core/launch.ts:451

spawn optional

ts
spawn: (command: string, args?: readonly string[], options?: SpawnOptions) => ChildProcess

The spawn process function. Used for spawn the java process at the end. By default, it will be the spawn function from "child_process" module. You can use this option to change the 3rd party spawn like cross-spawnInherited from: BaseServerOptions.spawn

Defined in: packages/core/launch.ts:439