Skip to content

Required Flags

Joseph (Drew) Killinger edited this page Mar 28, 2024 · 10 revisions

Read File Flag

-r or --read-file

One essential flag you need to use to get line_brkr.py to run is the -r or --read-file which specifies which file line_brkr.py will read from. To use this flag properly, the argument provided must be a valid file/path, the file must have read access, and the file must be a .rpy file.

For example, writing this command:

python line_brkr.py -r script.rpy

Tells line_brkr.py that there should be a script.rpy file within the same directory as line_brkr.py that line-brkr.py can read from.

Furthermore, writing this command:

python line_brkr.py -r somedirectory\script.rpy

Tells line_brkr.py that there should be a script.rpy file within the directory somedirectory that line-brkr.py can read from.

To learn more about file paths, read this article here.


Write File Flags

The second essential flag you need to use to get line_brkr.py to run is one of the possible write flags. There are two to chose from, the -w/--write-file or the -o/--overwrite-file.

-w or --write-file

To use the -w or --write-file flag properly, the argument provided must be a valid file/path, the file must have write access (if it already exists), and the file must be a .rpy file.

For example, writing this command:

python line_brkr.py -r script.rpy -w new_script.rpy

Tells line_brkr.py to write to the file new_script.rpy within the same directory as line_brkr.py.

Furthermore, writing this command:

python line_brkr.py -r script.rpy -w somedirectory\new_script.rpy

Tells line_brkr.py to write to the file new_script.rpy file within the directory somedirectory (if it already exists. If not, it will create the directory somedirectory).

-o or --overwrite-file

To use the -o or --overwrite-file flag properly, whatever argument provided to the -r or --read-file flag must be a valid file/path, the file must have write access, and the file must be a .rpy file.

For example, writing this command:

python line_brkr.py -r script.rpy -o

Is effectively the same as writing the command:

python line_brkr.py -r script.rpy -w script.rpy

To learn more about file paths, read this article here.

Clone this wiki locally