Skip to content
BetterLyrics

Plugin Development Guide

1. Environment Preparation

Section titled “1. Environment Preparation”

2. Get the Main Project

Section titled “2. Get the Main Project”

Clone the main project repository and complete the local build:

Terminal window
git clone https://github.com/jayfunc/BetterLyrics.git

3. Create a Plugin Project

Section titled “3. Create a Plugin Project”

Clone and create your plugin project using the template link below:

4. Development & Configuration

Section titled “4. Development & Configuration”
  1. Open the plugin project, search globally for sections marked with // TODO, and write your plugin’s core logic.
  2. Open the project configuration file and change BetterLyricsHostDir to the absolute path where your local BetterLyrics main project solution is located.

5. Build & Package

Section titled “5. Build & Package”

Once development is complete, build the plugin project directly. Upon a successful build, the relevant outputs will be automatically generated:

  • Language Pack Folder (Langs): Located at BetterLyrics.Plugins.Template/Langs
  • Plugin Installation Package (.blp): Located at BetterLyrics.Plugins.Template/Dist

💡 Tip: If you need to improve or add multi-language support later, simply modify the contents in Langs and rebuild the project.