addonscript-spec/docs/schema/launch.md

47 lines
1.5 KiB
Markdown
Raw Normal View History

2023-02-03 16:20:43 +01:00
# Launch Config Object
```json
{
"main_file": "somefilequalifier",
"main_class": "com.example.SomeClass",
2023-02-06 16:26:09 +01:00
"arguments": ["--someArgument"],
2023-04-21 19:56:33 +02:00
"jvm_arguments": ["-Djvmargument"],
"java_version": 8
2023-02-03 16:20:43 +01:00
}
```
## Optional properties
### main_file
This is the [qualifier](./file.md#qualifier) of the main jar file for
this side. It will override any inherited main file for this side.
2023-04-21 19:56:33 +02:00
That file MUST be specified in the [manifest](./manifest.md) of this
addon. Setting this to an empty string will indicate, that
2023-02-03 16:20:43 +01:00
there is no main file for this instance, in which case the
2023-04-21 19:57:56 +02:00
[main_class](#main_class) MUST be explicitly configured.
2023-02-03 16:20:43 +01:00
### main_class
This is the main class for this instance, which will be used to launch
the game. It will override any inherited main class for this side.
Setting this to an empty string will indicate, that the main class
2023-04-21 19:57:56 +02:00
specified in of manifest of the [main jar file](#main_file) should be used.
2023-02-03 16:20:43 +01:00
### arguments
2023-04-21 19:56:33 +02:00
This is an array of game arguments, which will be used to launch the instance
2023-02-06 16:26:09 +01:00
in addition to inherited arguments. They will be appended after inherited
arguments.
### jvm_arguments
This is an array of JVM arguments, which will be used to launch the instance
in addition to inherited JVM arguments. They will be appended after inherited
2023-04-21 19:56:33 +02:00
JVM arguments.
### java_version
This is the recommended major Java version for this instance. It MAY work on other
Java versions, but there is no guarantee for that. This overrides inherited `java_version`
settings.