From f84ffebf8ce39c7d319c236821ae2cf94341de4a Mon Sep 17 00:00:00 2001 From: TheBrokenRail Date: Fri, 18 Jun 2021 08:48:55 -0400 Subject: [PATCH] Document Command Line Arguments --- docs/COMMAND_LINE.md | 11 +++++++++++ docs/DEDICATED_SERVER.md | 5 ----- docs/README.md | 1 + scripts/package.sh | 2 +- 4 files changed, 13 insertions(+), 6 deletions(-) create mode 100644 docs/COMMAND_LINE.md diff --git a/docs/COMMAND_LINE.md b/docs/COMMAND_LINE.md new file mode 100644 index 00000000..358c065d --- /dev/null +++ b/docs/COMMAND_LINE.md @@ -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. diff --git a/docs/DEDICATED_SERVER.md b/docs/DEDICATED_SERVER.md index 1545e4dc..fdd3d8ec 100644 --- a/docs/DEDICATED_SERVER.md +++ b/docs/DEDICATED_SERVER.md @@ -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 * An easy workaround is to place your inventory in a chest before logging off * 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. diff --git a/docs/README.md b/docs/README.md index ab42f505..f433da54 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,3 +6,4 @@ * [View Terminology](TERMINOLOGY.md) * [View Building](BUILDING.md) * [View Architecture](ARCHITECTURE.md) +* [View Command Line Arguments](COMMAND_LINE.md) diff --git a/scripts/package.sh b/scripts/package.sh index 10ac509c..556e2d25 100755 --- a/scripts/package.sh +++ b/scripts/package.sh @@ -17,7 +17,7 @@ package() { # Format 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}" # Package