Welcome to the PTCG-sim codebase! We're currently in the process of documenting — stay tuned for detailed information about our open-source journey and how you can contribute.
PTCG-sim is primarily built with JavaScript, using Node.js, Express, and Socket.io as the key frameworks. Socket.io is utilized for two-player functionality.
Follow these steps to run PTCG-sim on your local machine:
-
Install Dependencies: Execute
npm installto install all the required dependencies. -
Create Sqlite Database: In the "data" directory, add a file named "db.sqlite". This is needed for storing game states, which is needed for exporting/importing game states as a URL. Note that you need to add this database even if you don't intend working with the export/imports as the server expects the file to exist.
-
Configure WebSocket Connection: Navigate to the
global-variables.jsfile and replace the WebSocket connection with your own. For instance:const socket = io('http://localhost:4000/');
Ensure that the URL is consistent with the one in the server.js file.
-
Start Local Server: Use Node.js to start running
server.jslocally. This will load the repository, starting withfront-end.js. This file initializes various global variables, sets up the DOM, and registers socket event listeners.
Feel free to explore the codebase and play around with the sim! I'm happy to answer any questions and I'm always open to suggestions :)
If you're interested in contributing, we'll soon be releasing detailed information about the contribution process. Stay tuned!
PTCG-sim is an open-source project. We encourage the community to get involved and stay updated with the latest releases and changes in the codebase.
Feel free to reach out on:
Happy testing!
-XXL
