actualdankcoder / salmon

Salmon is a music tracking web server

Salmon is a music tracking server that connects with different sources to display a presence

Dependencies:

• git - To clone repo (optional).
• go - Required to compile the binary (Required, Make Dependency).
• make - Build system (Optional, Make Dependency).

Installation

Windows:

There are two ways to get salmon, you can either head to releases and download the latest binary

or

Compile the binary with the following commands:

git clone https://github.com/actualdankcoder/salmon
cd salmon
go mod tidy
go build

Once the binary is compiled, you can uninstall all dependencies and add salmon.exe to your PATH variable.

Linux & MacOS:

Install Go and Make with your package manager and then run the following in the project directory:

• git clone https://github.com/actualdankcoder/salmon
• cd salmon
  • make for a dynamically linked binary.
  • make static for a statically linked binary.
• sudo make install

Note: If you don't know the difference between dynamic & static linking then just use dynamic linker (make)

Usage

Ensure that salmon server is running before usage

• Install the salmon plugin to your favourite music player
• Head to http://localhost:8406 to verify if music data is being fetched

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Sponsors

License

MIT