Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tkanx/lyre-together
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.
https://github.com/tkanx/lyre-together
genshin-impact lyre music socket-io
Last synced: 14 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/tkanx/lyre-together
- Owner: TKanX
- License: mit
- Created: 2024-08-24T16:19:55.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-09T21:06:50.000Z (about 1 month ago)
- Last Synced: 2024-10-16T20:59:15.351Z (28 days ago)
- Topics: genshin-impact, lyre, music, socket-io
- Language: JavaScript
- Homepage: https://lyre-together.com
- Size: 5.91 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:**
```bash
git clone https://github.com/TKanX/lyre-together.git
cd lyre-together
```
2. **Install the dependencies:**
```bash
npm install
```
3. **Start the server:**
```bash
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](https://nodejs.org/) - JavaScript runtime
- [Express](https://expressjs.com/) - Web framework for Node.js
- [Socket.IO](https://socket.io/) - Real-time engine for WebSockets
## Acknowledgments
- [Genshin Impact](https://genshin.mihoyo.com/) - Inspiration for the lyre simulator
- [WindsongLyre-Sim](https://github.com/haveyouwantto/WindsongLyre-Sim/) - Reference for the lyre simulator
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.