ezloj / TQModdingAdvanced

TQAE mod sources with a way to combine mods
GNU General Public License v3.0
1 stars 0 forks source link

TQModdingAdvanced

TQAE mod sources with a way to combine mods

Development

Requirements

You will need GNU make and docker to develop
To install make on Windows use chocolatey: https://chocolatey.org/install#individual

Using docker and make

To run the docker container with python and all dependencies do: make followed by make tinker
The former will install all dependencies
The latter will drop you off in a shell with current directory (this repository) mounted there
From there on, to get a python shell - run wine python3
After that, to import settings module: import src.config.settings

If you don't want docker

Use your own python and install venv. requirements.txt is in the project root
I strongly recommend learning to use docker. In this setup everything is automated (see above section for using docker and make)
Docker is a powerful tool for development that allows to seamlessly switch project components
and dependencies or even the operating system in minutes and go back instantly
With Makefile and docker-compose like in this project you don't have to switch between venvs (or anything else for that matter)

Notes

Issues with volume mount path conversion

To avoid those do export MSYS_NO_PATHCONV=1 before doing anything
See https://stackoverflow.com/a/62513969
This was added to docker-compose call in Makefile

TODO: