From 5cc790a796f0a4aff7cf338c8d5a641bc93f9796 Mon Sep 17 00:00:00 2001 From: Ahrimdon Date: Sun, 3 Mar 2024 05:24:56 -0500 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7e095b7..ef1695b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,18 @@ #### A Python3 script designed to export your IW4MAdmin database, parsing it into an easily accessible format. While the native `IW4MAdmin\Database\Database.db` is already accessible, navigating its complex relationships, keys, and constraints can be frustrating. This tool simplifies and streamlines the data, offering a more user-friendly view. -* Usage: `python parse_db.py` +## Arguments +```usage: parse_db.py [-h] [-s {ASC,DESC}] [-p PATH] [-o OUTPUT] [-t] [-c] + +optional arguments: + -h, --help show this help message and exit + -s {ASC,DESC}, --sort {ASC,DESC} + Sort order for the query results (ASC or DESC). + -p PATH, --path PATH Path to the IW4MAdmin database file. + -o OUTPUT, --output OUTPUT + Output directory for the parsed database file. + -t, --time Time the script's execution. + -c, --config Use default config.json for configuration.``` ## Instructions 1. Copy the database to a folder and make sure it's named 'Database.db' @@ -14,4 +25,21 @@ ## Building 1. Ensure Python3 is installed on your system and added to PATH -2. Run `build.py` \ No newline at end of file +2. Run `build.py` + +## Examples + +- Parse and save the IW4MAdmin Database in its native directory. + - `python parse_db.py -p "IW4MAdmin\Database\Database.db" -o "IW4MAdmin\Database"` + +- Parse the database on the desktop, output to documents, use a config file, time the operation, and sort entries in descending order. + - `python parse_db.py -c -t -p "C:\Users\User\Desktop\Database.db" -o "C:\Users\User\Documents" -s DESC` + +- Use config file and output to a specific folder. + - `python parse_db.py -p "Database.db" -o "FilteredOutput" -s DESC -c` + +- Parse the database with timing + - `python parse_db.py -t -p "Database.db" -o "TimedOutput"` + +- Extract using the config file for the newest/oldest database entries + - `python parse_db.py -c -p "Database.db" -o "SelectiveOutput" -s DESC -t` \ No newline at end of file