This is the project for the pathfinder card game site.
Developing
To get started developing with this project you will first need the following:
- Linux or WSL2 on Windows
- Node 10
- Yarn
- GCloud SDK You don't need to run gcloud init
- (Optional) Table Top Simulator
- Java
Once you have all that installed open a terminal in this project and run yarn. When that completes run yarn start to start the development server(s).
For TTS development you should now have a save file with no title or picture in TTS with the save ID 9999. When you load that save the development server will connect to TTS.
Note: For WSL you need to run the following command in an admin cmd netsh interface portproxy add v4tov4 listenport=39999 listenaddress=0.0.0.0 connectport=39999 connectaddress=127.0.0.1
For Web development you only need to open a browser and visit http://localhost:3000/
Both pieces will automatically update/reload when you save changes to the appropriate files
Project Structure
At the top level of this project there are a few important folders
- build: If this folder exists it will contain build artifacts
- functions: This contains the firebase functions project
- gameCore: This contains the LUA for the core of the game logic which is shared between TTS and the Website and other supporting files
- node_modules: Dependencies
- public: Public files which get included in the website build
- src: The react code for the website (written in typescript)
- tts: The files for TTS. Filenames at the root of this file should be named {Object Name}.{Object GUID}.lua and {Object Name}.{Object GUID}.xml. Additionally there is a save.json which is the base TTS save file without the scripts
- ttsBuild: Files used as part of the TTS build process
Note: Due to a limit of the way the lua is built you will need to require all files which are needed in the root script file