Playing Cards (plc) is a Deno (ECMASCRIPT 6.0 - a.k.a JavaScript), OOP library that helps people create and play online card games.
Note: Although it is possible to use playing cards to make real time card games it is discouraged
Playing Cards was made as a project for our IT class. It was made with deno and using Git to allow us to practice.
We wanted to achive the following milestones in the following order:
- Abstract Cards and Decks
☑️ - Create a place with movable cards and decks
🟨 - Allow mutliple people to connect to that space
☑️ - Allow code to easily check the current state of the game to endorce rules
🟧 - Create an electron version
❌
☑️(Done) 🟨(Might Be Done, very likely) 🟧(Might Be Done, Unlikely) ❌(Won't be done)
The plc module is divided in three parts or submodules:
- the
game: All of the cards abstraction - the
server: The webSocket and http server and the main constructor - the
UI: All the client sided files
And it also uses tools, generic functions (specially random related ones) that are used by different parts of the code.
Everything is wrapped at mod.js for easy importantion but it is possible to import invidivual parts of the code.
Although we have tried to use the most intuitive names to avoid confusion this list explains the main terms.
user: Whoever is using this library to create a game, host a server, etc.game: An instance of theGameclass that contains event listeners to endorce the rules of a card game and that listens and answers the player requestsmatch: A room of players playing the game that has an admin and an entry codeserver: A computer that is running the library, listening to a port and that will allow clients to play the gameclient: The computer/browser that a player is using, by connecting to the server, to play the gameplayer: A client that has an auth token and that comunicates with the server to play the game in a matchadmin: The player that has created the match and that is in charge of moderating the match (kicking bad players, inviting new players, etc)