Metadata-Version: 2.1
Name: larzuk
Version: 0.1.2
Summary: A command-line tool to help modding-as-code for game Diablo II: Resurrected.
License: GPL-3.0
Author: HE Yaowen
Author-email: he.yaowen@hotmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: d2txt (>=0.5.1,<0.6.0)
Description-Content-Type: text/markdown

# larzuk

A command-line tool to help modding-as-code for game Diablo II: Resurrected.

## How to Use

1. Install this command-line tool via `pip`:

    ```shell
    $ pip install larzuk
    ```
2. Write migration scripts in a directory (e.g. `migrations`):

    ```python
    # Relative path of .txt file you want to modify.
    filename = 'global/excel/armor.txt'

    # Entry function of migration
    def migrate(txt_file):
        for row in txt_file:
            row['minac'] = row['maxac']
    ```

3. Run `larzuk` command to do migrations:

    ```shell
    $ larzuk up --data-dir /path/to/d2r/data
    ```

4. Check file `armor.txt` in directory `output`, values in column `minac` equal to `maxac`.

## License

Copyright (C) 2023 HE Yaowen <he.yaowen@hotmail.com>

The GNU General Public License (GPL) version 3, see [LICENSE](./LICENSE).

