/tiny-ball

🏀 A relaxing multiplayer basketball court. Hang out, chat with friends, shoot hoops.

Primary LanguageJavaScriptOtherNOASSERTION

Tiny Ball 🏀

Tiny Basketball is a casual multiplayer game that allows friends and co-workers to hang out and shoot some hoops together. The repo includes a web app and a WebSocket server for real-time multiplayer interactions. Players take turns trying to score points by shooting basketballs into the hoop.

Features

  • Simple, whitelabel graphics
  • Real-time multiplayer gameplay using WebSocket
  • Perfect for a casual hangout or a quick break during work

How to Play

  1. Visit the Tiny Ball web app.
  2. Choose a username
  3. Invite friends or coworkers to join your room. Everyone visiting the same site will automatically appear in the same room.

Setup

Requirements

  • Node.js
  • npm

Installation

  1. Clone the repository:
    2. git clone https://github.com/maxibenner/tiny-ball.git
  2. Install dependencies:
    3. cd tiny-ball
npm install
  3. Run the WebSocket server:
    4. npm run server
  4. In a separate terminal, run the web app using live server

Contributing

We welcome contributions from the community! If you'd like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a branch with a descriptive name for your changes.
  3. Commit your changes to the branch and push to your fork.
  4. Create a pull request and describe the changes you made.

License

Tiny Basketball is licensed under the MIT License. See LICENSE for more details.