help screen

This commit is contained in:
Downforce Agent 2024-08-10 04:08:00 -05:00
parent 189f6c6322
commit 968e04ba66
2 changed files with 61 additions and 6 deletions

View File

@ -1,10 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="AutoImportSettings">
<option name="autoReloadType" value="SELECTIVE" />
</component>
<component name="ChangeListManager">
<list default="true" id="cf74c012-cc69-4732-ac79-9ddfcbf803ee" name="Changes" comment="">
<change beforePath="$PROJECT_DIR$/June.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/June.java" afterDir="false" />
<change beforePath="$PROJECT_DIR$/Scotty.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/Scotty.java" afterDir="false" />
<change beforePath="$PROJECT_DIR$/standalone.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/standalone.java" afterDir="false" />
<list default="true" id="cf74c012-cc69-4732-ac79-9ddfcbf803ee" name="Changes" comment="eclipse compiler adjustments">
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/standalone.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/standalone.java" afterDir="false" />
</list>
<option name="SHOW_DIALOG" value="false" />
<option name="HIGHLIGHT_CONFLICTS" value="true" />
@ -25,7 +27,7 @@
</component>
<component name="PropertiesComponent"><![CDATA[{
"keyToString": {
"Application.Default CLI.executor": "Debug",
"Application.Default CLI.executor": "Run",
"RunOnceActivity.ShowReadmeOnStart": "true",
"kotlin-language-version-configured": "true",
"project.structure.last.edited": "Project",
@ -58,6 +60,19 @@
<option name="presentableId" value="Default" />
<updated>1723277726305</updated>
</task>
<task id="LOCAL-00001" summary="eclipse compiler adjustments">
<option name="closed" value="true" />
<created>1723278056512</created>
<option name="number" value="00001" />
<option name="presentableId" value="LOCAL-00001" />
<option name="project" value="LOCAL" />
<updated>1723278056512</updated>
</task>
<option name="localTasksCounter" value="2" />
<servers />
</component>
<component name="VcsManagerConfiguration">
<MESSAGE value="eclipse compiler adjustments" />
<option name="LAST_COMMIT_MESSAGE" value="eclipse compiler adjustments" />
</component>
</project>

View File

@ -1,10 +1,50 @@
public class standalone {
public static final int[] version = new int[]{0, 0, 0};
// This is used when Vitality4J is run from the terminal.
// Don't make calls to anything in the standalone class when using Vitality4j as a library.
//
// This is useful incase the user wants a standalone psarc.exe replacement
// and/or for debugging purposes without another Java project as the interface.
public static void main (String[] args) {
System.out.println("Command line unimplemented."); // todo
if (args.length == 0) {
System.out.println(
"usage: vita4j [options] <file>\n" +
"\n" +
"Options:\n" +
" -i Displays info about a PSARC archive.\n" +
" -I <path> Displays info about a file inside a PSARC archive.\n" +
" -t Lists the Table of Contents from a PSARC archive.\n" +
" -c <path> Creates a new PSARC archive with the specified parameters.\n" +
" -e Extracts a PSARC archive to the current working directory.\n" +
" -E <path> Extracts one file from a PSARC archive to the current working directory.\n" +
" -x <file> Extracts multiple files from a PSARC archive to the current working\n" +
" directory, from a TXT list of file paths. One file per line in the list.\n" +
" -y Overwrites conflicting files without asking.\n" +
" -q Quiet, avoid printing to stdout.\n" +
" -v Verbose. Prints additional information to stdout.\n" +
" -h Prints this help screen that you're reading right now.\n" +
" -a Displays version and licensing information about Vitality4j.\n" +
"\n" +
"Creating a new PSARC:\n" +
" -b <size> Sets the blocksize in bytes when creating a new archive. (default = 64 KB)\n" +
" -g <none|zlib|lzma> Sets the compression algorithm used\n" +
" -u Makes the PSARC uncompressed. Shorthand for \"-a none\".\n" +
" -z Compresses the PSARC with zlib. Shorthand for \"-a zlib\".\n" +
" -l Compresses the PSARC with LZMA. Shorthand for \"-a lzma\".\n" +
" -s <strength> Sets the intensity of the compression from 0 to 9. (default = 9)\n" +
"\n" +
"Examples:\n" +
" To extract an archive:\n" +
" vita4j -e data.psarc\n" +
"\n" +
" To create a new archive from a folder:\n" +
" vita4j -c ~/data/ data.psarc\n" +
"\n" +
" To create an archive with LZMA compression and a block size of 256 KB or 262144 B:\n" +
" vita4j -c ~/data/ -l -b 256 data.psarc\n" +
"\n" +
"If no options are specified, -i is presumed.\n"
);
}
}
}