minecraft-pi-docker/docs/COMMAND_LINE.md

# Command Line Usage

## Command Line Arguments

### `--version` (Or `-v`)
If you run MCPI-Reborn with `--version` it will print its version to `stdout`.

### `--debug`
This sets `MCPI_DEBUG`.

### `--copy-sdk`
This extracts the modding SDK and immediately exits. (This allows the SDK to be extracted without starting the game.)

### Client Mode Only

#### `--print-available-feature-flags`
This print the available feature flags (and their default values) to `stdout` and then immediately exit.

The feature flags are printed in the following format:
```
TRUE This Flag Is On By Default
FALSE This Flag Is Off By Default
```

#### `--default`
This will skip the startup configuration dialogs and just use the default values. This will use the cached configuration unless `--no-cache` is used.

#### `--benchmark`
This will make MCPI-Reborn enter a simple benchmark mode. This means automatically loading a newly generated world, then rotating the camera for a period of time. When it has finished, it will then exit and print the average FPS while the world was loaded. In this mode, all user input is blocked. However you can still modify rendering settings by changing feature flags.

The world used will always be re-created on start and uses a hard-coded seed.

#### `--no-cache`
This will skip loading and saving the cached launcher configuration.

#### `--wipe-cache`
This will wipe the cached launcher configuration.

### Server Mode Only

#### `--only-generate`
This will make MCPI-Reborn immediately exit once world generation has completed. This is mainly used for automatically testing MCPI-Reborn.

## Environmental Variables

### `MCPI_DEBUG`
This enables debug logging if it is set.

### `MCPI_API_PORT`
This configures the API to use a different port (the default is 4711).

### Client Mode Only
If any of the following variables aren't set, one configuration dialog will open on startup for each unset variable.

#### `MCPI_FEATURE_FLAGS`
This corresponds to `--print-available-feature-flags`. This is just a list of all enabled feature flags separated by `|`.

For instance, the string `Feature A|Feature B` would enable both `Feature A` and `Feature B` and *disable every other available feature flag*.

#### `MCPI_RENDER_DISTANCE`
This is the render distance. The possible values are: `Far`, `Normal`, `Short`, and `Tiny`.

#### `MCPI_USERNAME`
This is the username.
Add MCPI_DEBUG & Improve Documentation 2022-03-10 03:37:37 +00:00			`# Command Line Usage`
Document Command Line Arguments 2021-06-18 12:48:55 +00:00
Add MCPI_DEBUG & Improve Documentation 2022-03-10 03:37:37 +00:00			`## Command Line Arguments`

Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			### `--version` (Or `-v`)
			If you run MCPI-Reborn with `--version` it will print its version to `stdout`.
Sweeping Media Layer Changes (GL ES 2.0 Support) 2022-05-29 22:44:27 +00:00
Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			### `--debug`
			This sets `MCPI_DEBUG`.
Logging Improvements 2022-10-02 04:47:11 +00:00
Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			### `--copy-sdk`
Simplify Some Code 2024-01-24 02:57:57 +00:00			`This extracts the modding SDK and immediately exits. (This allows the SDK to be extracted without starting the game.)`

Add --wipe-cache 2022-09-23 04:31:42 +00:00			`### Client Mode Only`

Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			#### `--print-available-feature-flags`
			This print the available feature flags (and their default values) to `stdout` and then immediately exit.
Add MCPI_DEBUG & Improve Documentation 2022-03-10 03:37:37 +00:00
			`The feature flags are printed in the following format:`
Document Command Line Arguments 2021-06-18 12:48:55 +00:00			```
			`TRUE This Flag Is On By Default`
			`FALSE This Flag Is Off By Default`
			```

Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			#### `--default`
			This will skip the startup configuration dialogs and just use the default values. This will use the cached configuration unless `--no-cache` is used.
2.2.8 2021-11-14 04:29:48 +00:00
Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			#### `--benchmark`
Add --wipe-cache 2022-09-23 04:31:42 +00:00			`This will make MCPI-Reborn enter a simple benchmark mode. This means automatically loading a newly generated world, then rotating the camera for a period of time. When it has finished, it will then exit and print the average FPS while the world was loaded. In this mode, all user input is blocked. However you can still modify rendering settings by changing feature flags.`
2.2.8 2021-11-14 04:29:48 +00:00
			`The world used will always be re-created on start and uses a hard-coded seed.`
Add MCPI_DEBUG & Improve Documentation 2022-03-10 03:37:37 +00:00
Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			#### `--no-cache`
Add --wipe-cache 2022-09-23 04:31:42 +00:00			`This will skip loading and saving the cached launcher configuration.`

Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			#### `--wipe-cache`
Add --wipe-cache 2022-09-23 04:31:42 +00:00			`This will wipe the cached launcher configuration.`

			`### Server Mode Only`

Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			#### `--only-generate`
Add --wipe-cache 2022-09-23 04:31:42 +00:00			`This will make MCPI-Reborn immediately exit once world generation has completed. This is mainly used for automatically testing MCPI-Reborn.`
Cache Launcher Configuration 2022-09-22 21:43:21 +00:00
Add MCPI_DEBUG & Improve Documentation 2022-03-10 03:37:37 +00:00			`## Environmental Variables`

Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			### `MCPI_DEBUG`
Run Benchmark During CI Test 2022-07-08 17:57:48 +00:00			`This enables debug logging if it is set.`
Add MCPI_DEBUG & Improve Documentation 2022-03-10 03:37:37 +00:00
Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			### `MCPI_API_PORT`
Add MCPI_API_PORT 2022-09-21 21:54:40 +00:00			`This configures the API to use a different port (the default is 4711).`

Add MCPI_DEBUG & Improve Documentation 2022-03-10 03:37:37 +00:00			`### Client Mode Only`
Run Benchmark During CI Test 2022-07-08 17:57:48 +00:00			`If any of the following variables aren't set, one configuration dialog will open on startup for each unset variable.`
Add MCPI_DEBUG & Improve Documentation 2022-03-10 03:37:37 +00:00
Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			#### `MCPI_FEATURE_FLAGS`
			This corresponds to `--print-available-feature-flags`. This is just a list of all enabled feature flags separated by `\|`.
Add MCPI_DEBUG & Improve Documentation 2022-03-10 03:37:37 +00:00
Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			For instance, the string `Feature A\|Feature B` would enable both `Feature A` and `Feature B` and disable every other available feature flag.
Add MCPI_DEBUG & Improve Documentation 2022-03-10 03:37:37 +00:00
Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			#### `MCPI_RENDER_DISTANCE`
			This is the render distance. The possible values are: `Far`, `Normal`, `Short`, and `Tiny`.
Add MCPI_DEBUG & Improve Documentation 2022-03-10 03:37:37 +00:00
Improve Markdown Formatting 2024-02-01 08:18:47 +00:00			#### `MCPI_USERNAME`
Add MCPI_DEBUG & Improve Documentation 2022-03-10 03:37:37 +00:00			`This is the username.`