▄        ▄     ▄  ▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄  ▄     ▄ 
  ▐░▌      ▐░▌   ▐░▌▐░█▀▀▀▀▀  ▀▀█░█▀▀ ▐░▌   ▐░▌
  ▐░▌      ▐░▌   ▐░▌▐░▌         ▐░▌   ▐░█   █░▌
  ▐░▌      ▐░▌   ▐░▌▐░▌         ▐░▌   ▐░░░░░░░▌
  ▐░▌      ▐░▌   ▐░▌▐░▌         ▐░▌    ▀▀▀▀▀█░▌
  ▐░█▄▄▄▄▄ ▐░█▄▄▄█░▌▐░█▄▄▄▄▄  ▄▄█░█▄▄       ▐░▌
   ▀▀▀▀▀▀▀  ▀▀▀▀▀▀▀  ▀▀▀▀▀▀▀  ▀▀▀▀▀▀▀        ▀ 
                                                                 

Helper scripts for Ampache

Lua Dependencies (using LuaRocks):

luarocks install luafilesystem
luarocks install lua-cjson
luarocks install dkjson
# Some users might also need to install lua-socket

Quick start examples

Main Script arts-collage.lua

Generates a collage of images from the stat passed as a parameter.
Stats can be newest, highest, frequent, recent, forgotten, flagged, random

lua arts-collage.lua -s <size> -f <stat> <serverAddress> <username> <password>

size: how many cover arts in the collage? Note, to make a squared image use: 4, 9, 16, 25, 32, ...
stat: can be newest, highest, frequent, recent, forgotten, flagged, random
serverAddress: your ampache instance address

Example of generated images:

16 covers	9 covers	25 covers

---

Print your stats (no image output)

Usage:

lua stats.lua <server_url> <username> <password> [OPTIONS]

ARGUMENTS:

Required arguments:
  <server_url>   The URL of the Ampache server
  <username>     The username for authentication
  <password>     The password for authentication

Optional arguments:
  -l <limit>     Limit the number of items to retrieve (default: 10)
  -t <type>      Specify the type of items to retrieve (valid values: album, song, artist, video, playlist, podcast, podcast_episode; default: album)
  -f <filter>    Specify the filter for the items (valid values: newest, highest, frequent, recent, forgotten, flagged, random; default: newest)
  -j		     Prints the original json from the network response, when this is passed, all other optional args are ignored
  -h             Show this help message

Sample output (Albums):

name: Dear Gods (id: 2769)
artist: Yellfire (id: 347)
time: 2561.0
year: 2024.0
songcount: 11.0
diskcount: 1.0
genre: Metal
art: http://192.168.16.141/image.php?object_id=29&object_type=album
flag: true
mbid: 7f73f74f-0e9c-4665-8b9f-9f10fd2e1468

name: The Duality of Decapitation and Wisdom (id: 2734)
artist: Veilburner (id: 234)
time: 2940.0
year: 2024.0
songcount: 7.0
diskcount: 1.0
genre: Death Metal
art: http://192.168.16.141/image.php?object_id=516&object_type=album
flag: false
mbid: 20a9d15f-9c08-4c1e-b9f9-2ba95864d3e5

... etc

Sample output (Songs):

name: The Calm That Keeps You Awake (id: 15491)
artist: Knocked Loose (id: 799)
album: You Won’t Go Before You’re Supposed To (id: 4322)
url: http://192.168.16.141/play/index.php?ssid=f80f50feb8e415b45d7072dc&type=song&oid=23771&uid=3&transcode_to=flac&bitrate=32000&player=api&name=Knocked%20Loose%20-%20The%20Calm%20That%20Keeps%20You%20Awake.flac
time: 161.0
playlisttrack: 10.0
format: flac
stream_format: flac
stream_mime: audio/flac
bitrate: 1110771.0
stream_bitrate: 32000.0
rate: 44100.0
mode: vbr
mime: audio/flac
stream_mime: audio/flac
year: 2024.0
art: http://192.168.16.141/image.php?object_id=22&object_type=album&name=art.jpg
flag: false
mbid: 2bbb6662-0db0-4c09-abc8-f89e3ee25caa

---

Other quick examples:

# just print the auth token
lua ampache-handshake-print.lua -a http://192.168.61.10 youruser yourpassword

# print the playlists response using the lua script to fetch the token in one line
curl "http://192.168.61.10/public/server/json.server.php?action=playlists&limit=100&filter=&exact=0&offset=0&hide_search=1&show_dupes=1&auth=$(lua ampache-handshake-print.lua -a http://192.168.61.10 youruser yourpassword)"

# save in a variable and reuse for multiple calls
#BASH
auth=$(lua ampache-handshake-print.lua -a http://192.168.61.10 youruser yourpassword)
#FISH
set auth $(lua ampache-handshake-print.lua -a http://192.168.61.10 youruser yourpassword)
curl "http://192.168.61.10/public/server/json.server.php?action=playlists&limit=100&filter=&exact=0&offset=0&hide_search=1&show_dupes=1&auth=$auth"

ampache-handshake.lua

require this in your lua scripts (see ampache-handshake-print.lua for example usage).

Exposed functions are:

• handshake : returns the full handshake json. serverUrl, username and password are the require parameters
• getAuthToken : returns the auth token used for all the authorized calls. serverUrl, username and password are the require parameters

ampache-handshake-print.lua

utility script to print handshake data.
options:

• -H --handshake or no option to print the full json response
• -a -auth to print the auth token, very useful to pipe to other commands or put into a variable in bash to run other commands
• -h --help, print help message