zurichat / zc_plugin_chessboard Goto Github PK

License: BSD 3-Clause "New" or "Revised" License

HTML 0.30% CSS 18.76% JavaScript 78.14% EJS 2.51% Shell 0.29%

zc_plugin_chessboard's Introduction

Chess Board Room Plugin

Zuri chesss plugin is a web based recreational and competitive board game played between two players with an option for AI, that can easily be installed and used as part of the Zuri chat main application.

Design:

Figma link to the design implemented:
coming soon!

Hosted URL:

https://chess.zuri.chat/

Tech Stack:

React js
Nodejs
Ajax
WebSockets

Project Setup & Contribution Guide:

Fork this REPO
Clone the repo from your account

git clone https://github.com/<username>/zc_plugin_chessboard.git

For BACKEND

switch to the backend directory and install all dependencies

cd backend
npm install   or   yarn install

For FRONTEND

switch to the frontend directory and install all dependencies

cd frontend
npm install   or   yarn install

Add the main repo remote to your project upstream

git remote add upstream https://github.com/zurichat/zc_plugin_chessboard.git

Pull from upstream

git pull upstream dev

Switch to a new branch with your {feature-name}

git checkout -b <feature-name>

Add your work/code
When done making your changes, run

  git add .
  git commit -m 'your commit message'
  git push origin <feature-name>

Create a Pull Request to dev branch

For Local Testing:

Run backend server

cd server
npm run dev   or   yarn run dev

Open http://127.0.0.1:22664/ping
Open another terminal in vscode and run

cd client
npm start   or   yarn start

Open http://127.0.0.1:3000/

zc_plugin_chessboard's People

Contributors

Stargazers

Watchers

Forkers

airondev juniorbuba emekarr tobybrave ndubuisijr eni4sure udosinachi calebareeveso ese-monday ebukaar otinomz odizee kenogit78 ndidiesther sowlomon funabab davien21 preciousjohn dread557 haybeecoder amuabigail michael-2509 yemi-dev chenemiken augustbemsen aarond2018 drsimple1 chysomm62 fabianuzukwu timmy-id lil-dovee greybeing nkem-wey-sabi caesarsage vermilion4 webmekanic preciousakams watermelon-sugar arabog lekandev obintus alao-abiodun babsmutini falence kenny0619 trust-ay anita9771 generalsoi joblyn thebigbillz chiomaubaezuonu krendus joshuamonyei d0bbl e-nicholas987 jaytru1997 otutukingsley kenziematch zakariyahrobiat uchechukwu10 petsamuel masud-ndatsu linaadamson ridowayne emmanueluko3 dannyxy

zc_plugin_chessboard's Issues

CREATE AN OPTION TO RESIGN DURING A GAME

A player should be able to withdraw from a current game so that they can be able to end it when they want.
Any player that withdraws from a game loses

Add Checkmate Feature

A user should be able to checkmate their opponent based on chess rules so that a winner can emerge.

CREATE A SECTION TO SEE TOURNAMENT RULES

As a user I want to be able to see the rules of a tournament to see if it suits me

CREATE A FUNCTION THAT HOLDS THE CURRENT STATE OF THE GAME

On single player mood:

A player should be able to resume the game when the connection fails.
A function that holds the current state of the game should be created so that in a scenario where the player falls into network issues they can still get back their previous state in the game.

A popup to display score after a match

As a player I want to see my scores after a game so as to determine my growth and lots more. At the end of a match, after a period of time, summary of the game is displayed at the top of the page.

CREATE AN OPTION TO VIEW THE CHESS BOARD FROM DIFFERENT ANGLES

A player should be able to view the board from different angles to make the game more enjoyable.
A user once logged in could see the camera icon for example and on clicking it a popup of different view modes to choose from shows.

CREATE AN OPTION TO ORGANISE A TOURNAMENT

A player should be able to organize a mini-tournament amongst interested players so that can rank up ranks and earn points.
There should be an option to organize a mini-tournament amongst interested user so that they could compete amongst themselves and then they can earn points in which the users with most points are given higher ranks.

ADD A CHESS TUTORIAL LINK

A beginner should be able to watch a tutorial on chess so that they can learn how to play the game.
A link leading to a chess tutorial should be added to enable beginners learn about the game.

TURNING OFF/ON CHAT NOTIFICATIONS WHILE PLAYING

Users should be able to turn off/on chat notifications to play better and avoid distractions.
There should be a turn-on/turn-off notification button.

Create a Dropdown to Select the Difficulty Option

As a player I want to be able to choose my skill level in order to play at my own pace. Click on select difficulty and a list of difficulty levels pop up.

CREATE A RECORDING OPTION

A player should be able to record moves in a game so that they can watch them later.
This option once clicked should begin to record the game and save such record in the database for easy retrieval by a user.

ADD SHARE RESULT BUTTON

A player should be able to share his/her game results with other users.

CREATE A FEATURE FOR USERS TO ASK FOR A REMATCH

A user should be able to ask for a rematch so they can get to play again with their opponents.

CREATE A FILTERING LEADERBOARD METRIC

As a user I want to have control over my view by being able to filter the leaderboard by a metric(ascending order, highest scores user etc)

Add an Invite button for spectators to watch a game

A player should be able to invite spectators to watch and learn how to play.

Add Option to Select Game Difficulty

A user in the game options setting should be able to set game difficulty. The setting is automatically applied to all forthcoming games.

CREATE AN OPTION TO RATE THE GAME

A player should be allowed to rate the game play, so it can serve as a feedback for the development team in improving the experience.

CREATE A RESTART GAME BUTTON (AI GAME ONLY)

As a user, I want to be able to restart a current game so I can start afresh.

GAME STATE ALERT [DRAW, WIN, LOSE]

A player should see alerts that show the state of the game or what has occurred. For example, "A draw has occurred"

ADD A REACTION BUTTON

A player should be able to add reactions based on how they feel with moves.
When the game is in progress and I capture the opponents' piece, I can click a happy emoji that expresses their joy.

ADD FUNCTION TO SELECT CHESS PIECE COLOR

Allow a user to select their piece color.
Ensure both "white" and "black" pieces have different colors

An option for a chess match scheduling should be added.

As a player i should be able to schedule be able to schedule a game in advance, so that I can save a slot (TO BE REVIEWED).
This optioned if clicked should allow a player schedule a game in advance.

ADD GAME PLAY AND UPDATE NOTIFICATIONS

A player should be able to see requests to play and also chess updates so that they do not miss out on any update.
An area should be created where information such as :

players request to play
chess updates, are displayed so that players do not miss out on any updates.

CREATE A SECTION TO SEE TOURNAMENT RULES

As a user I want to be able to see the rules of a tournament

CREATE A VARIETY OF BOARD THEMES OPTION

As a user I want to be able to choose a variety of chess board themes according to my preference

Add functionalities that enables a player send notifications to channels whenever a chess match is about to start.

As a player i should be able to notify when a match would begin on channels, so that I can have an audience (TO BE REVIEWED).
Basically this function should enable a user send notifications to various channels notifying them that a match is about to begin.

ADD OPTION TO CHANGE THE DIMENSION [2D OR 3D]

Users should be able to change the display settings to either 3D or 2D to make it more appealing visually.
When a user clicks on the display options, users should be able to change the dimension of the pieces.

Add option to create a Chat Window [[REPEATED]]

As a player, I want to chat with my opponent while playing to make the game more realistic. Clicking on the chat icon displays the window.

ADD A FEATURE THAT ALLOWS ANONYMOUS PLAY

A player should be able to play anonymously, so their details remain unknown to everyone else.

ADD FUNCTION TO SELECT COLOR OF CHESSBOARD

A player should have the privilege of selecting a preferred color of the chessboard, to make the game more visually appealing.

ADD OPTIONS TO HELP SEE CLUES

There should be clues and hints when a player spends so much time deliberating on a move.
This should be toggled on and off

ADD OPTION TO LOG IN AS A SPECTATOR

A spectator should be able to watch others when they're playing, for the purpose of learning or have fun watching.
Case Scenario: Once I log in as a user, I can click a button to identify as a spectator and be able to watch or observe others playing.

Make the king and rook have the ability to castle

As a player, the rook and the king should have the ability to castle so that the king moves two spaces to the left or to the right, and the rook moves over and in front of the king, all in one move!

ADD FEATURE TO CHANGE THE SHAPE OF THE CHESSBOARD AND PIECES

To make it more visually appealing, there should be a setting for users to change the display and options when the display setting is clicked.

CREATE A GAME RESTART LOGIC

When playing against another user, the restart function should stop the current game.
The player that invokes it loses and the other player wins
If it is against a bot or the computer, no win or loss - (the game simply restarts)

A player should be able to search for users [chess players] to play against.
The search bar could have a drop-down list containing names of different users that match the current search string.