{"id":15132979,"url":"https://github.com/tkanx/lyre-together","last_synced_at":"2025-04-05T21:45:34.393Z","repository":{"id":254624524,"uuid":"847023287","full_name":"TKanX/lyre-together","owner":"TKanX","description":"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.","archived":false,"fork":false,"pushed_at":"2024-10-09T21:06:50.000Z","size":6196,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T21:45:28.495Z","etag":null,"topics":["genshin-impact","lyre","music","socket-io"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TKanX.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-24T16:19:55.000Z","updated_at":"2024-12-08T17:21:58.000Z","dependencies_parsed_at":"2024-10-31T13:05:23.408Z","dependency_job_id":"76cf4dd5-3e92-4d79-9375-c846d614c7a4","html_url":"https://github.com/TKanX/lyre-together","commit_stats":{"total_commits":22,"total_committers":1,"mean_commits":22.0,"dds":0.0,"last_synced_commit":"e5a5220d11c8e16b6e273a501b415cc4b69c3995"},"previous_names":["tkanx/lyre-together"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TKanX%2Flyre-together","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TKanX%2Flyre-together/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TKanX%2Flyre-together/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TKanX%2Flyre-together/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TKanX","download_url":"https://codeload.github.com/TKanX/lyre-together/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247406072,"owners_count":20933802,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["genshin-impact","lyre","music","socket-io"],"created_at":"2024-09-26T04:42:05.201Z","updated_at":"2025-04-05T21:45:34.368Z","avatar_url":"https://github.com/TKanX.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# LyreTogether\n\nLyreTogether 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.\n\n## Features\n\n- **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.\n- **Sheet Music Support:** Upload and integrate sheet music into the simulator for practice and performance.\n- **Practice Mode:** Practice with various pieces of sheet music, including features to help improve your performance skills.\n\n## Getting Started\n\n### Prerequisites\n\n- Node.js and npm (for the WebSocket server)\n- A web browser for the client-side interface\n\n### Installation\n\n1. **Clone the repository:**\n\n```bash\ngit clone https://github.com/TKanX/lyre-together.git\ncd lyre-together\n```\n\n2. **Install the dependencies:**\n\n```bash\nnpm install\n```\n\n3. **Start the server:**\n\n```bash\nnpm start\n```\n\n4. **Open the client:**\n\nNavigate to `http://localhost:3000` in your web browser.\n\n## Environment Variables\n\nThe 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.\n\n- `PORT`: The port number for the server (default is 3000)\n- `HOST`: The host address for the server (default is localhost)\n- `USE_HTTPS`: Set to `true` to use HTTPS (default is `false`)\n- `SSL_KEY_PATH`: The path to the SSL key file (required if `USE_HTTPS` is `true`)\n- `SSL_CERT_PATH`: The path to the SSL certificate file (required if `USE_HTTPS` is `true`)\n\n## Built With\n\n- [Node.js](https://nodejs.org/) - JavaScript runtime\n- [Express](https://expressjs.com/) - Web framework for Node.js\n- [Socket.IO](https://socket.io/) - Real-time engine for WebSockets\n\n## Acknowledgments\n\n- [Genshin Impact](https://genshin.mihoyo.com/) - Inspiration for the lyre simulator\n- [WindsongLyre-Sim](https://github.com/haveyouwantto/WindsongLyre-Sim/) - Reference for the lyre simulator\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftkanx%2Flyre-together","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftkanx%2Flyre-together","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftkanx%2Flyre-together/lists"}