Skip to content

Commit 3d27dd2

Browse files
authored
Create README.md
1 parent 9717d8a commit 3d27dd2

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Use
2+
The executable can either be called from the command line, have a file or directory dragged onto it, or run in a folder containing .bytes of .json files from Sunless Skies. Command line arguments are enumerated below.
3+
If dragging files onto the executable, either an individual file or a directory can be passed. When a single file is passed, the program will encrypt or decrypt it based on its file extension. Otherwise, it will encrypt or decrypt files in the passed directory according to the file extension of whichever file it sees first.
4+
If run inside a directory containing .bytes or.json files, it will encrypt or decrypt files in the directory according to the file extension of whichever file it sees first. Resulting files will be created inside a new directory next to the executable.
5+
6+
# Arguments
7+
`--decrypt=<path_to_file>`
8+
Accepts as input either a single .bytes file or a directory containing .bytes files. If a single file is passed, converts it to the corresponding .json file and creates said file next to the executable. If a directory is passed, the resulting .json files will be created in a new directory next to the executable.
9+
10+
`--encrypt=<path_to_file>`
11+
Accepts as input either a single .json file or a directory containing .json files. If a single file is passed, converts it to the corresponding .bytes file and creates said file next to the executable. If a directory is passed, the resulting .bytes files will be created in a new directory next to the executable.

0 commit comments

Comments
 (0)