LyreTogether

LyreTogether is designed to simulate the lyre from Genshin Impact. This project enables multiple users to play together in real-time using WebSockets. It also includes features for adding and practicing sheet music.

Features

• Multi-User Rooms: Connect with friends and play the lyre together in real-time. Each user can join a room and interact with others in the same space.
• Sheet Music Support: Upload and integrate sheet music into the simulator for practice and performance.
• Practice Mode: Practice with various pieces of sheet music, including features to help improve your performance skills.

Getting Started

Prerequisites

• Node.js and npm (for the WebSocket server)
• A web browser for the client-side interface

Installation

1. Clone the repository:

git clone https://github.com/TKanX/lyre-together.git
cd lyre-together

2. Install the dependencies:

npm install

3. Start the server:

npm start

4. Open the client:

Navigate to http://localhost:3000 in your web browser.

Environment Variables

The server uses environment variables to configure the WebSocket connection. You can set these variables in a .env file in the root directory of the project.

• PORT: The port number for the server (default is 3000)
• HOST: The host address for the server (default is localhost)
• USE_HTTPS: Set to true to use HTTPS (default is false)
• SSL_KEY_PATH: The path to the SSL key file (required if USE_HTTPS is true)
• SSL_CERT_PATH: The path to the SSL certificate file (required if USE_HTTPS is true)

Built With

• Node.js - JavaScript runtime
• Express - Web framework for Node.js
• Socket.IO - Real-time engine for WebSockets

Acknowledgments

• Genshin Impact - Inspiration for the lyre simulator
• WindsongLyre-Sim - Reference for the lyre simulator

License

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