TibixDev/GenshinLyreParser

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Building
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• Vite
• Vue.js
• Tailwind CSS

(back to top)

Getting Started

You can use this webapp on the deployed website or you can build it yourself using the instructions found below.

Prerequisites

• node.js (LTS recommended)
• npm

  npm install npm@latest -g
  

• yarn (optional)

  npm install --global yarn
  

Building

1. Clone the repo

   git clone https://github.com/TibixDev/GenshinLyreParser.git
   

2. Install NPM packages

   yarn install
   # or
   npm install
   

3. Build the project

   yarn build
   # or
   npm run build
   

4. Deploy the dist folder or view it using live-server
5. Enjoy!

(back to top)

Roadmap

• Improving detection accuracy
• Note detection color picker
• Exporting songs to Genshin Music Nightly
• The ability to modify songs manually

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

• Mail: [email protected]
• Discord: Tibix#5166

Project Link: https://github.com/TibixDev/GenshinLyreParser

(back to top)