Skip to content

ChessKhelo

Pre-release
Pre-release

Choose a tag to compare

View all tags
@BlockNotes-4515 BlockNotes-4515 released this 02 Sep 02:13
· 7 commits to main since this release
ChessKhelo
94e66d0
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Here’s a detailed README template for your GitHub repository, including sections for players, users, and a gallery with 13 photos. You can customize the content further based on your specific project details.

🎮 Real-Time Multiplayer Chess ♟️

Description

Welcome to Real-Time Multiplayer Chess! This project is a web-based chess game that allows two players to face off in real-time, each controlling either the white or black pieces from different tabs. The game features drag-and-drop controls, dynamic board flipping, and a smooth, intuitive interface.

Features

  • ⚔️ Real-Time Multiplayer: Play against another player in real-time.
  • 🔄 Dynamic Board Flipping: The board automatically flips for the black player for proper orientation.
  • 🖱️ Drag-and-Drop Controls: Intuitive drag-and-drop interface for moving pieces.
  • 🕹️ Socket.io Integration: Sockets handle communication between players.
  • 🌐 Web-Based: No downloads required! Just open the game in your browser.

Getting Started

Prerequisites

  • Node.js and npm installed on your system.

Installation

  1. Clone the repository: 
    git clone https://github.com/your-username/real-time-multiplayer-chess.git
  2. Navigate to the project directory: 
    cd real-time-multiplayer-chess
  3. Install dependencies: 
    npm install
  4. Start the server: 
    npm start
  5. Open the game in your browser:
    Go to http://localhost:3000 in two different tabs or windows to start playing.

How to Play

  1. Player Roles: When you open the game in a new tab, you'll be assigned either the white or black pieces. Your role will be displayed on the screen.
  2. Move Pieces: Click and drag a piece to move it to your desired square. Legal moves will be validated automatically.
  3. Real-Time Updates: Your moves will be reflected instantly on both players' screens.

Contributing

We welcome contributions from the community! If you find any bugs or have suggestions for new features, feel free to create an issue or submit a pull request.

Steps to Contribute:

  1. Fork the repository.
  2. Create a new branch: 
    git checkout -b feature-name
  3. Make your changes and commit them: 
    git commit -m 'Add some feature'
  4. Push to the branch: 
    git push origin feature-name
  5. Submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

This template should give users and contributors all the information they need to understand and participate in your project. The gallery section is ready to display your 13 images side by side. Just replace the placeholder image paths with the actual paths of your screenshots.

Assets 8
Loading