1
0
Fork 0
mirror of https://github.com/ldericher/fftcgtool synced 2025-01-22 17:53:00 +00:00

Add README, add docker option

This commit is contained in:
Jörn-Michael Miehe 2018-11-02 19:49:35 +01:00
parent 806ee3bec8
commit 08bd5b60b4
5 changed files with 61 additions and 3 deletions

9
.dockerignore Normal file
View file

@ -0,0 +1,9 @@
out
__pycache__
.git
.gitignore
.dockerignore
Dockerfile
README.md

4
.gitignore vendored
View file

@ -1,2 +1,2 @@
/out/
/__pycache__/
out
__pycache__

21
Dockerfile Normal file
View file

@ -0,0 +1,21 @@
FROM python:3.7-alpine
ENV LIBRARY_PATH=/lib:/usr/lib
ENV PYTHONUNBUFFERED 1
RUN \
# install build prerequisites \
apk add --no-cache \
build-base \
jpeg-dev \
zlib-dev \
&& pip3 install pillow requests \
# remove build prerequisites \
&& apk del --no-cache \
build-base
WORKDIR "/app"
COPY . .
CMD ["./main.py"]

28
README.md Normal file
View file

@ -0,0 +1,28 @@
# fftcgtool
Card import tool for [Final Fantasy TCG Complete](https://steamcommunity.com/sharedfiles/filedetails/?id=889160751) mod for the [Tabletop Simulator](http://berserk-games.com/tabletop-simulator/)
## Quick Start
If needed, customize `main.py` variables:
- `opusid`: The Card opus you want to import
- `num_threads`: Lower this for really weak systems
- `opus_size`: 500 here means the script will correctly import anything containing *up to* 500 cards
### using your system's `python3`
1. Make sure `PIL` and `requests` python3 libraries (or equivalent) are installed.
1. Run `main.py` in project root directory.
### using a `docker` container
1. Build the container using `docker build -t ldericher/fftcgtool .` in project root directory.
1. Run `docker run --rm -it -v "$(pwd)/out:/app/out" ldericher/fftcgtool` in project root directory.
## Future work
- Add command line interface for `main.py` variables
- Multiple opus import

View file

@ -2,7 +2,7 @@
# base config
opusid = 7 # opus prefix
num_threads = 16 # maximum concurrent requests
num_threads = 8 # maximum concurrent requests
opus_size = 500 # maximum card count per opus
# constants