Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
n0lavar committed Jun 8, 2024
1 parent 0476e59 commit 4c1d1b9
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Cyberpunk Red NPC generator

[![Donate](https://img.shields.io/badge/Donate-8A2BE2)](https://revolut.me/n0lavar)

[![License: GPLv3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
![Python](https://img.shields.io/badge/python-3.12-blue.svg)
[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/)

<a href="https://buymeacoffee.com/n0lavar" target="_blank" title="buymeacoffee">
<img src="https://iili.io/JIYMmUN.gif" alt="buymeacoffee-animated-badge" style="width: 160px;">
</a>

## Info

A generator that generates NPCs based on json configs using the specified rank and role.
Expand Down Expand Up @@ -78,11 +80,11 @@ Generated:
## Usage

```
usage: main.py [-h] --rank
{private,corporal,lieutenant,captain,lieutenant_colonel,lieutenant_general,general}
[--role {rockerboy,solo,netrunner,tech,medtech,media,exec,lawman,fixer,nomad,civilian,booster}]
[--seed SEED]
[--log_level {CRITICAL,FATAL,ERROR,WARN,WARNING,INFO,DEBUG,NOTSET}]
usage: cp_red_npc_generator.exe [-h] --rank
{private,corporal,lieutenant,captain,lieutenant_colonel,lieutenant_general,general}
[--role {rockerboy,solo,netrunner,tech,medtech,media,exec,lawman,fixer,nomad,civilian,booster}]
[--seed SEED]
[--log_level {CRITICAL,FATAL,ERROR,WARN,WARNING,INFO,DEBUG,NOTSET}]
options:
-h, --help show this help message and exit
Expand Down Expand Up @@ -114,7 +116,7 @@ options:
Input:

```
python cp_red_npc_generator/src/main.py --rank=private --role=solo
cp_red_npc_generator.exe --rank=private --role=solo
```

Output:
Expand Down Expand Up @@ -175,7 +177,7 @@ Output:
Input:

```
python cp_red_npc_generator/src/main.py --rank=captain --role=solo
cp_red_npc_generator.exe --rank=captain --role=solo
```

Output:
Expand Down Expand Up @@ -241,7 +243,7 @@ Output:
Input:

```
python cp_red_npc_generator/src/main.py --rank=general --role=solo
cp_red_npc_generator.exe --rank=general --role=solo
```

Output:
Expand Down

0 comments on commit 4c1d1b9

Please sign in to comment.