Yavook.de/fftcgtool
1
0
Fork 0
mirror of https://github.com/ldericher/fftcgtool synced 2025-01-15 06:53:00 +00:00
Code Issues Releases Wiki Activity
(mirror) Card import tool for "Final Fantasy TCG Complete" for "Tabletop Simulator"
92 commits 3 branches 0 tags 462 KiB
Python 95.3%
Dockerfile 4.7%
Find a file
LDericher 0f176f44ea type hints
2021-09-03 09:32:07 +02:00
.idea rename commands 2021-09-03 02:45:32 +02:00
fftcg type hints 2021-09-03 09:32:07 +02:00
.dockerignore Docker 2021-08-03 02:24:14 +02:00
.gitignore Add README, add docker option 2018-11-02 19:49:35 +01:00
Dockerfile rename commands 2021-09-03 02:45:32 +02:00
fftcgtool.py skip buffer usage 2021-09-03 06:28:34 +02:00
LICENSE Python3.9 (typos) 2021-08-09 05:47:25 +02:00
Pipfile use pickle instead of yaml serialization 2021-08-23 13:38:01 +02:00
Pipfile.lock use pickle instead of yaml serialization 2021-08-23 13:38:01 +02:00
README.md typo 2021-09-03 06:10:26 +02:00

README.md

fftcgtool

Card import tool for Final Fantasy TCG Complete mod for the Tabletop Simulator

Usage

usage: fftcgtool [-h] [-v] [-l LANG] [-s] {opuses,ffdecks} ...

Imports FFTCG cards for TT-Sim.

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         increase output verbosity
  -l LANG, --language LANG
                        language for imported objects
  -s, --stdout          print the deck files in a zip archive to stdout, skip creating JSONs on disk

subcommands:
  Import either an Opus to extend the mod, or import a deck to play right away.

  {opuses,ffdecks}      valid subcommands

Run using your system's python3

  1. Make sure you have at least python version 3.9 installed. To test, run python --version or similar. Also, pipenv should be installed for that python version. Refer to pipenv installation guide if needed.
  2. To install fftcgtool dependencies, run pipenv install --deploy from project root directory.
  3. Run pipenv run ./fftcgtool.py from project root directory.
  4. You can alias fftcgtool='PIPENV_PIPFILE="'$(pwd)'/Pipfile" pipenv run "'$(pwd)'/fftcgtool.py"' from project root directory to define fftcgtool shorthand for your running shell.

Run using a docker container

Caveat: This simplistic container runs fftcgtool as root user. All generated files will thus be owned by root:root by default.

  1. Make sure you have a working installation of docker software.
  2. Update your local image.
    • Either use docker pull ldericher/fftcgtool.
    • Or build it yourself: Clone this repository and run docker build --pull --tag ldericher/fftcgtool . inside.
  3. Run docker run --rm -it -v "$(pwd)/out:/app/out" ldericher/fftcgtool in any directory.
  4. You can alias fftcgtool='docker run --rm -it -v "$(pwd)/out:/app/out" ldericher/fftcgtool' to define fftcgtool shorthand for your running shell.

Output files will go to subdirectory ./out. CLI arguments are supported as docker run --rm -it -v "$(pwd)/out:/app/out" ldericher/fftcgtool -n 2 5 (imports Opus 5 using 2 threads)

Future work

  • Multiple opus import