ibratabian17/KPoe

KaraokePoe is a work-in-progress karaoke player (counted as game), built using the Electron framework. This project aims to create a free karaoke application (excluding song list).

KaraokePoe 🎤

KaraokePoe is an in-progress karaoke player built using the Electron framework. This project aims to create a free and versatile karaoke application, focusing on user customization and flexibility (song list not included). Whether you're a karaoke enthusiast or a developer looking to contribute, KaraokePoe offers a robust and open-source platform to enjoy and create karaoke experiences.

Table of Contents

• Features
• Installation
• Usage
• Customizing Your Experience
• Notes
• Example Files
• Contributing
• License
• Acknowledgements

Features 🚀

KaraokePoe is packed with exciting features to enhance your karaoke sessions:

• Working Lyrics System: Dynamic and customizable lyrics display.
• No Singer Mode: Sing A Song with the instrumental only!.
• Easy to Use for Song Makers: Streamlined tools for creating and customizing songs.
• Gamepad Support: Play and control your karaoke sessions using a gamepad (button only).
• Video & Audio Support: Seamlessly integrate videos and audio tracks.
• Custom Lyrics Styles:
  • "normal": Traditional 2-line scrolling lyrics.
  • "apple": Apple Music-inspired display.
  • "two-line": 2 lines positioned on the left and right.
  • "one-line": Single line with a fading effect.
  • Made Your Own LyricsStyle!: Yes! you can use a custom lyrics styles by editing css on the song files
• Mobile Friendly: Optimized for a smooth experience on mobile devices.
• Portable Web: Play KPoe on your browser without installing!

Note: The application is still under development, and more features are on the way!

Installation 🛠️

To get started with KaraokePoe (Developer mode), follow these steps:

1. Clone the repository:

   git clone https://github.com/ibratabian17/KPoe.git

2. Install dependencies:

   cd KPoe
   npm install

3. Start the application:

   npm start

Usage 🎮

Once the application is running, you can start enjoying karaoke by adding your own song files. The application is designed to be user-friendly and easy to navigate, whether you're on a desktop or mobile device.

Customizing Your Experience 🎨

KaraokePoe allows users to customize their karaoke experience extensively:

• Adding Songs: Import your own songs to the application. The song list is not included by default, allowing for maximum personalization.
• Lyrics Formats: Utilize various lyrics formats similar to Just Dance Now, adapted to work seamlessly with KaraokePoe.
• Tools for Song Creation:
  • Use KpoeTools to convert eLRC or Apple's TTML into the KPoe Format.
  • Alternatively, try Kmake by ecnivtwelve.

Notes 📝

• Song List: The application does not include a song list. Users must add their own songs manually.
• Lyrics Format: The lyrics format is similar to Just Dance Now but modified to suit KaraokePoe.
• Development: As a work in progress, some features may be incomplete or subject to change.

Example Files 📁

To help you get started, here are some example files:

• Song Database: songdb-example.json
• Lyrics Data: Magnetic.json

Contributing 🤝

Contributions are welcome! If you're interested in improving KaraokePoe, feel free to fork the repository and submit a pull request. Please make sure to follow the contribution guidelines.

License 📜

This project is licensed under the MIT License. Feel free to use, modify, and distribute this software in your projects.

Acknowledgements 🌟

Special thanks to all contributors and the open-source community for their continuous support and contributions.