Skip to content

Commit

Permalink
doc: Update advanced usage
Browse files Browse the repository at this point in the history
Change README help message accordingly and update package version
  • Loading branch information
simonkeyd committed Mar 5, 2024
1 parent f65221e commit 8a5e86e
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![license: GPLv3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![release](https://github.com/simonkeyd/bgcar/workflows/release/badge.svg)](https://github.com/simonkeyd/bgcar/releases)

__Baldur's Gate Computer Assisted Reroll__ helps one effortlessly reach high ability scores for one's CHARNAME by performing computer assisted reroll. This program performs live roll result analysis and only stores the highest value. This is done by capturing screen area containing the `total roll` score and by analyzing this value using OCR.
__Baldur's Gate Computer Assisted Reroll__ (BGCAR) helps one effortlessly reach high ability scores for one's CHARNAME by performing computer assisted reroll. This program performs live roll result analysis and only stores the highest value. This is done by capturing screen area containing the `total roll` score and analyzing its value with [OCR](https://en.wikipedia.org/wiki/Optical_character_recognition).

## Installation
Installing from PyPI:
Expand Down Expand Up @@ -31,18 +31,23 @@ note: Baldur's Gate game window has to be in the foreground so that `bgcar` can
![BGCAR demo](docs/assets/demo.gif)

## Advanced usage
see `bgcar -h`
```sh
usage: bgcar [-h] [-i] [-d DELAY] [-m MAX_ROLL_COUNT] [--gpu]
usage: bgcar [-h] [-d] [-i] [-t TIME] [-m MAX_ROLL_COUNT] [--gpu]

options:
-h, --help show this help message and exit
-i, --initialize initialize required settings like button location - mandatory before program use
-d DELAY, --delay DELAY
time in second to wait between each click (one can use decimal values); a delay too short for you setup might cause program to misbehave (eg. not
store roll correctly)
-d, --debug print debug level messages (each roll value, etc)
-i, --initialize initialize required settings like button location - mandatory before
program use
-t TIME, --time TIME time in second to wait between each click (one can use decimal
values); a delay too short for your setup might cause the program to
misbehave (eg. not store roll correctly) (default: 0.03)
-m MAX_ROLL_COUNT, --max-roll-count MAX_ROLL_COUNT
limit the maximum number of roll that you want the program to perform; by default bgcar will run in infinite mode
limit the maximum number of roll that you want the program to perform;
by default bgcar will run in infinite mode
--gpu enable GPU mode for OCR and accelerating program

```

## Known issues
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

setup(
name="bgcar",
version="1.0.1",
version="1.0.2",
author="simonkeyd",
author_email="simon.kheng1337@gmail.com",
license="GNU GPLv3",
Expand Down

0 comments on commit 8a5e86e

Please sign in to comment.