api/README.md
2025-04-12 22:23:44 -06:00

1.0 KiB
Executable File

Almond API

TODO: Finish this README.

Almond v2 now uses an API instead of being merged as frontend routes in a web app. This allows developers to create custom clients for it.

Requirements

You can download binary builds in the Releases page and just run it in your server or locally.

However, if you prefer to build a binary for your system, you must have Rust installed and have the build configured to your needs. This option is for developers, it is assumed that you know what you're doing.

  • yt-dlp - for downloading YouTube videos, does most of the heavy lifting. Install options are listed there too.
  • yt-dlp-returnyoutubedislike - for adding ReturnYouTubeDislike information to a video's information JSON instead of adding an additional request to the API.