Skip to content

Commit 50237c5

Browse files
authored
Add setup
1 parent e182a94 commit 50237c5

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,22 @@ Written in Python 3
2525
- Minimal run mode
2626
- Good for quick webhook messages
2727

28+
## Setup
29+
There are a few values that are stored in the py file to make things run a bit smoother.
30+
31+
- `grepDir`
32+
- Default: `"."`
33+
- Directory for grep to run in by default. Ignored if `-d` flag is used.
34+
- `incPrintFormat`
35+
- Default: `"04x"`
36+
- Format string passed to python's [format function](https://docs.python.org/3/library/string.html#format-string-syntax) for certain printed values.
37+
- `banks`
38+
- Default: `0x40`
39+
- Amount of banks in the game, used for incrom percentage. Ignored if gbdprog is told about a valid map file.
40+
- `unusedBanks`
41+
- Default: `0`
42+
- banks that have absolutely nothing in them, used for incrom percentage. Ignored if gbdprog is told about a valid map file.
43+
2844
## Usage
2945

3046
usage: gbdprog.py [-h] [-e MAP] [--auto_map] [-i] [-d DIRECTORY] [-a ADD] [-m]

0 commit comments

Comments
 (0)