Document Command Line Arguments
All checks were successful
minecraft-pi-reborn/pipeline/head This commit looks good

This commit is contained in:
TheBrokenRail 2021-06-18 08:48:55 -04:00
parent e73596fd57
commit f84ffebf8c
4 changed files with 13 additions and 6 deletions

11
docs/COMMAND_LINE.md Normal file
View File

@ -0,0 +1,11 @@
# Command Line Arguments
## ``--print-available-feature-flags`` (Client Mode Only)
If you run MCPI-Reborn with ``--print-available-feature-flags``, it will print the available feature flags 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
```
## ``--only-generate`` (Server Mode Only)
If you run MCPI-Reborn with ``--only-generate``, it will immediately exit once world generation has completed. This is mainly used for automatically testing MCPI-Reborn.

View File

@ -12,8 +12,3 @@ To use, install and run ``minecraft-pi-reborn-server``. It will generate the wor
* Player data is not saved because of limitations with MCPE LAN worlds * Player data is not saved because of limitations with MCPE LAN worlds
* An easy workaround is to place your inventory in a chest before logging off * An easy workaround is to place your inventory in a chest before logging off
* Survival Mode servers are incompatible with unmodded MCPI * Survival Mode servers are incompatible with unmodded MCPI
## Arguments
### ``--only-generate``
If you run the server with ``--only-generate``, it will immediately exit once world generation has completed. This is mainly used for automatically testing MCPI-Reborn.

View File

@ -6,3 +6,4 @@
* [View Terminology](TERMINOLOGY.md) * [View Terminology](TERMINOLOGY.md)
* [View Building](BUILDING.md) * [View Building](BUILDING.md)
* [View Architecture](ARCHITECTURE.md) * [View Architecture](ARCHITECTURE.md)
* [View Command Line Arguments](COMMAND_LINE.md)

View File

@ -17,7 +17,7 @@ package() {
# Format DEBIAN/control # Format DEBIAN/control
sed -i "s/\${VERSION}/${VERSION}~$(lsb_release -cs)/g" "${dir}/DEBIAN/control" sed -i "s/\${VERSION}/${VERSION}~$(lsb_release -cs)/g" "${dir}/DEBIAN/control"
# Fix Permissions # Fix Permissions On Jenkins
chmod -R g-s "${dir}" chmod -R g-s "${dir}"
# Package # Package