Skip to content

PTCG-sim is an open-source desktop tool to simulate card games. It supports single player and online multiplayer.

Notifications You must be signed in to change notification settings

ariellelok/ptcg-sim

 
 

Repository files navigation

PTCG-sim

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.

Running PTCG-sim Locally

Follow these steps to run PTCG-sim on your local machine:

  1. Install Dependencies: Execute npm install to install all the required dependencies.

  2. Configure WebSocket Connection: Navigate to the global-variables.js file and replace the WebSocket connection with your own. For instance:

    const socket = io('https://localhost:4000/');

    Ensure that the URL is consistent with the one in the server.js file.

  3. Start Local Server: Use Node.js to start running server.js locally. This will load the repository, starting with front-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 :)

Contributing

If you're interested in contributing, we'll soon be releasing detailed information about the contribution process. Stay tuned!

Open Source

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.

Contact

Feel free to reach out on:

Happy testing!

-XXL

About

PTCG-sim is an open-source desktop tool to simulate card games. It supports single player and online multiplayer.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 83.7%
  • HTML 9.2%
  • CSS 7.1%