Skip to content

Jastro/gamedevbar

Repository files navigation

Virtual Bar for Gamedev Mediavida

A 3D virtual bar built with Three.js where users can interact, chat and have fun. Project developed for the Gamedev subforum at Mediavida.com. Originally proposed in this thread.

Features

  • 3D environment with a classic bar layout
  • Real-time user interaction
  • Chat system with emotes
  • Multiple seating areas
  • Interactive bathroom with privacy features
  • Challenge other users to mini-games

Development Setup

Prerequisites

  • Node.js (Latest LTS version recommended)
  • NPM

Installation

  • Clone the repository
git clone https://github.com/yourusername/virtualbar.git
cd virtualbar

Install dependencies

npm install

Start development server

npm run dev

The application will start in development mode with hot reload enabled. Any changes you make to the code will automatically refresh the application.

  • Frontend runs on port 5148
  • Backend WebSocket server runs on port 3000

Contributing

Contributions are welcome! Here's how you can contribute:

Fork the repository

Create a new branch for your feature

git checkout -b feature/AmazingFeature

Make your changes

Commit your changes

git commit -m 'Add some AmazingFeature'

Push to the branch

git push origin feature/AmazingFeature

Open a Pull Request

Pull Request Guidelines

  • Ensure the PR description clearly describes the problem and solution
  • Include the relevant issue number if applicable
  • Update the README.md with details of changes if needed
  • The PR must be tested in development environment before submission

Built With

  • Three.js - 3D graphics library
  • WebSocket - Real-time communication
  • Express - Web framework
  • Vite - Frontend build tool

License

MIT License Copyright (c) 2024 Virtual Bar for Gamedev Mediavida Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Acknowledgments

Thanks to the Mediavida Gamedev community for the inspiration and support Special thanks to all contributors who have helped shape this project