wittymediaserver

package module
v0.0.0-...-cab72fd Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 16, 2026 License: AGPL-3.0 Imports: 1 Imported by: 0

README

WittyMediaServer

Your films, shows, discs, music, books and games, on every screen in your home.
A self-hosted media server that plays DVDs and Blu-rays with their real menus, in any browser.

Runs on Windows, macOS, Linux, FreeBSD and Docker Version 0.8.x-alpha versions

Get started · Install · Guides · What's new

Alpha. Version 0.8.x-alpha versions are still changing quickly and can fail or lose data. Keep backups, and back up your data folder before you upgrade.

Install

Install the server on the computer or NAS that holds your media. Downloads are on the Releases page, and FFmpeg comes with them. When it's running, open http://<that computer>:9797/ in a browser to set it up.

On Do this Full guide
Windows 10 or 11 Download windows-amd64.msi (arm64 for ARM PCs), open it, and choose who it's for. Setup opens in your browser Windows
macOS 11 or later Download macos-arm64.pkg (Apple silicon) or macos-amd64.pkg (Intel), open it, then open WittyMediaServer from Applications. Not yet run on a real Mac macOS
Debian, Ubuntu sudo apt install ./wittymediaserver-<version>-linux-amd64.deb: the service is running Linux
Fedora, RHEL sudo dnf install ./wittymediaserver-<version>-linux-amd64.rpm: the service is running Linux
Any other Linux Unpack linux-amd64.tar.gz (or arm64, armv7, 386), then sudo ./install.sh for a service, or ./WittyMediaServer to just run it Linux
FreeBSD 14 or later pkg add wittymediaserver-<version>-freebsd-amd64.pkg, sysrc wittymediaserver_enable=YES, service wittymediaserver start FreeBSD
Docker docker run -d -p 9797:9797 -v wms-config:/config -v /path/to/media:/media:ro ghcr.io/wittywilla/wittymediaserver:alpha, or a ready compose file Docker
A NAS Docker, with a guide for each: UGREEN · Synology · QNAP · Unraid · TrueNAS SCALE · Asustor A NAS

Then watch from any device. Every phone, tablet, computer and TV with a browser can open the server's address and use everything. The app, WittyMediaClient, adds finding the server by itself and a TV-friendly view. It's early: Apps and devices says how far each has been run.

Device Get WittyMediaClient
Windows, macOS, Linux, FreeBSD, Plasma Big Screen The installer for your system from the WittyMediaClient releases page (.exe, .dmg, .deb, .rpm, .pacman, .AppImage, .pkg)
Android phones, tablets and TVs The .apk from the same page, installed by hand (adb install on a TV). Run on emulators only so far
iPhone, iPad, Apple TV Not available yet: use the browser. Apple TV has no browser, so it can't be used yet

Getting started walks through everything with no command line, and Installing covers services, updating, and what each download is.

The home page, with a large picture from a film and a row of libraries
The home page. Wing It!, Blender Studio, CC BY 4.0. Everything shown is openly licensed.

What it does

  • Films and TV. Posters, plots and ratings, Continue watching, skip intro and instant seeking. Information arrives with no API key, and you can add free keys or your own agents for more.
  • DVDs and Blu-rays. Disc images play like a disc player: intros, animated menus, scene selection, extras and the disc's own subtitles.
  • Live TV and channels. Channels made from your library, a guide, tuners, IPTV and recording.
  • Music, audiobooks and podcasts. Albums and artists, lyrics and karaoke, books that remember your place, and shows you follow.
  • Books and comics. EPUB, PDF, comics and manga, with highlights, notes and a pen.
  • Photos and videos. A timeline, albums and an offline map, a feed of vertical videos, and creators' videos by channel.
  • Games. Your own game files, played in a browser with a gamepad, keyboard or touch.
  • Everyone at home. Who's watching? profiles with their own progress, and Kids profiles that only show titles for their age.
  • Yours. It runs on your computer. No accounts with anyone, no telemetry and no cloud. No media comes with it.

Discs, games, photos, readers and tuners are modules: separate programs you add from a store inside the app, each with its own repository. The server works without any of them.

A look around

A test server, filled with openly licensed media to show what it can do. No media comes with it. Every work on that server is named in the credits, with its licence. See every step of first-time setup too.

A wall of film posters
Films
Open-licence and public-domain media, credited hereA film's page
A film's page
Sintel, Blender Foundation, CC BY 3.0A DVD's own menu in a browser
A DVD's real menu, in a browser
Sintel, Blender Foundation, CC BY 3.0, from its original DVDA Blu-ray playing in a browser
Blu-rays too
Sita Sings the Blues, Nina Paley, CC0A TV guide with a film playing in the preview
WittyTV: channels made from your library
Caminandes: Llamigos, Pablo Vazquez, Blender Foundation, CC BY 3.0The guide in the Classic look
Looks of its own to choose from
Singularity, Blender Studio, CC BY 4.0A light show behind the music player
Music, with WittyVisualizer
Collide, Aryll Fae, CC BY 4.0Lyrics beside the player
Lyrics and karaoke
"Take Me Out to the Ball Game", 1908, public domainA city-building game running in a browser
Games, played in a browser
µCity, Antonio Niño Díaz, GPL-3.0-or-later and CC BY-SA 4.0A library of games
Open-licence homebrew on many consoles
Each credited hereAn arcade game running in a browser
Thwaite
Thwaite, Damian Yerrick, GPL-3.0-or-laterA fighting game running in a browser
Super Tilt Bro
Super Tilt Bro, Sylvain Gadrat, WTFPLA book open in the reader
Books
Standard Ebooks, CC0A comic open in the reader
Comics
Pepper&Carrot, David Revoy, CC BY 4.0A timeline of photos
Photos
From Wikimedia Commons, credited hereA show's page with its episodes
TV shows
Open-licence and public-domain media, credited hereA page of podcasts
Podcasts and audiobooks
Credited hereA feed of vertical videos
Vertical videos
Clips cropped from open films, credited hereThe home page in the Light theme
Themes
Open-licence and public-domain media, credited here
TV mode, like the TV apps, for the couch
Driven with a remote or a game controllerThe module store
Add only what you want from the store
From a local test catalogueThe Libraries page in Settings
Everything is in plain settings
Settings, Libraries

Get started

  1. Install it on the computer or NAS that holds your media.
  2. Open http://<that computer>:9797/. On a desktop, the installer opens it for you.
  3. Create your account, point it at your folders and press Start watching.

Getting started has the full walkthrough, and First-time setup shows every page of it with pictures.

The server is on your home network only until you turn on Settings → Remote Access and follow its steps. See Remote access.

Where it has been run

The server is written for Windows, Linux, macOS and FreeBSD, and runs in Docker. Linux gets the most testing, with its packages installed, upgraded and removed on Debian, Ubuntu and Fedora. The Windows installers have been tested under Wine, not on real Windows. Nothing has been run on a real Mac yet. FreeBSD's package and service have run in virtual machines. The Docker image has run in WSL, not yet on a NAS. What has been tested has the details.

WittyMediaClient adds Android, Android TV, iOS, tvOS and Plasma Big Screen. Android has been run on emulators only, and iOS and tvOS have never been built. A web browser is the way to reach everything today. See Apps and devices.

Guides

Everything here is also inside the app, under Help, so you don't need this page once you're running.

Getting going
Getting started From install to your first film
First-time setup, step by step Every page of setup, with a picture of each
Installing Downloads, the tray app, services, updating and removing it
Docker The image, compose files, graphics cards, and a guide for each make of NAS
Libraries Adding your media, and naming your files
Accounts and profiles People, passwords, limits and sign-in
Profiles and parental controls Switching profile on a shared screen, limits, screen time and reports
Apps and devices Every device, and how far each has been run
Settings tour Where every setting lives
Troubleshooting Common problems, by what you're seeing
Your media
Watching and listening The player, keys, tracks and remotes
What each media type supports · Supported formats Which library to make, and every file type
DVDs · Blu-rays Menus, the remote, audio and subtitles
TV shows · Channels and live TV Show folders, channels, tuners and the guide
Music · Lyrics and karaoke Music, audiobooks, podcasts and singing along
Books, PDFs and comics · Photos Reading and looking
Vertical videos · Creator videos Feeds, channels and concerts
Collections, radio and Your year Smart playlists and internet radio
Games Your own games, from a folder to playing
Running a server
Metadata · Fixing wrong details · The metadata folder Posters, plots and wrong matches
Live transcoding · Library transcoding · Using Tdarr Converting video
Modules and the store Adding, updating and trusting modules
Remote access Watching away from home, safely
Backup and restore · Repair · WittyDiagnoser Keeping it healthy
Config file and logs · Statistics · Themes Fine tuning

For developers: Contributing, Repositories, Reference, Client API, Server-driven UI and for modules, Design 2, Making a module, Security model and the Changelog.

Privacy and security

  • No telemetry, no accounts with anyone, no cloud. Logs stay on your computer and never contain passwords or session tokens.
  • Your files stay here. By default, names taken from your file and folder names go to the metadata services you keep switched on, and the server asks GitHub for updates twice a day. Settings → Legal → Privacy lists every outside service, what it receives and what controls it.
  • Limits by default. Cross-site requests are refused, feeds and agents can't reach other devices on your network, and modules run in a sandbox where the system offers one.
  • Copy protection is never bypassed. Encrypted discs, broadcasts and game files are detected and refused.

To report a security problem, see SECURITY.md.

Contributing

Issues and pull requests are welcome. CONTRIBUTING.md has how to build, test and send a change. Disc engines must stay free of other players' code, because they're written from the public disc formats.

GNU Affero General Public License v3.0 (or later). Use, change and share WittyMediaServer, commercially or not, under its terms; please keep the attribution in NOTICE: "This product includes WittyMediaServer, developed by WittyWilla", in your distribution, documentation or About screen. Every Witty module is AGPL-3.0-or-later too. The client apps (WittyMediaClient, WittyMediaPlayer, WittyReader and the smaller apps) are under the GNU General Public License v3.0 or later. Code forked or derived from another project keeps that project's licence and is labelled with it; for example, WittyCouch Host is AGPL-3.0-or-later with its Moonlight-derived parts under the GPL-3.0. A few separate programs have licences of their own, and each is listed in the app and in THIRD_PARTY_LICENSES.md.

Your media, third parties and warranty

The app's own Legal page (Settings → Legal, or /legal on any server) has the full text. This is plain-language information, not legal advice.

Your media, your responsibility. WittyMediaServer organises and streams media you already have the right to use. It doesn't provide, host, own or check any of it. Server operators and users are responsible for the files they add and share, and for following the laws where they and their viewers live. The authors and contributors accept no liability for media stored on, played from or shared through a server, nor for how a server is used.

Web results and third-party content. Search results, details, artwork, podcasts, radio stations, TV channels and guides, and game details come from third parties. They aren't created by, associated with, endorsed by or checked by the WittyMediaServer project, its contributors or affiliates.

Games. No games, ROMs or BIOS files come with this software, and the project doesn't link to them. Use only files you've obtained legally.

No circumvention. Copy protection is never decrypted or bypassed: CSS-scrambled DVDs and AACS-encrypted Blu-rays are refused. Encrypted media isn't supported, and no plugin or setting changes that.

Third parties. Video is converted by FFmpeg, run as a separate program. The bundled builds are GPL-licensed, with sources linked from THIRD_PARTY_LICENSES.md. This product uses the TMDB API but is not endorsed or certified by TMDB. TV information is provided by TheTVDB and TVmaze (CC BY-SA 4.0), movie and game facts by Wikidata (CC0) and Wikipedia (CC BY-SA 4.0), anime by AniList, definitions by the Free Dictionary API, and podcast search by the Apple Podcasts directory. Each service's terms apply to its data.

No warranty. Provided "as is", without warranty of any kind.

No affiliation, and trademarks. WittyMediaServer is not affiliated with any other media software project, studio, console maker, service or rights holder. Third-party names only describe compatibility or where information came from, and belong to their owners. "DVD" is a trademark of DVD Format/Logo Licensing Corporation; "Blu-ray" and "Blu-ray Disc" are trademarks of the Blu-ray Disc Association. This software isn't a licensed or certified DVD or Blu-ray product.


WittyMediaServer 0.8.0-alpha · AGPL-3.0-or-later · Made by WittyWilla

Documentation

Overview

Package wittymediaserver holds this module's go.mod, so the server can report the versions of the engines it requires (Settings, About).

Index

Constants

This section is empty.

Variables

View Source
var GoMod string

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
cmd
wittyconnect command
Command wittyconnect is the desktop app's helper for peer-to-peer connections: the app starts it, tells it which server to reach, and gets back a local address to load the server from.
Command wittyconnect is the desktop app's helper for peer-to-peer connections: the app starts it, tells it which server to reach, and gets back a local address to load the server from.
wittymediaserver command
Command wittymediaserver is the server and its command line.
Command wittymediaserver is the server and its command line.
wittymediaserver-tray command
Command wittymediaserver-tray is the app a person opens: a system-tray or menu-bar icon that starts and stops the server, opens the web app, shows logs and can start itself at login.
Command wittymediaserver-tray is the app a person opens: a system-tray or menu-bar icon that starts and stops the server, opens the web app, shows logs and can start itself at login.
wittymediaserver-uninstall command
Command wittymediaserver-uninstall is the uninstaller with windows and buttons: Uninstall WittyMediaServer.exe on Windows, Uninstall WittyMediaServer.app on a Mac.
Command wittymediaserver-uninstall is the uninstaller with windows and buttons: Uninstall WittyMediaServer.exe on Windows, Uninstall WittyMediaServer.app on a Mac.
wms-forwarder command
Command wms-forwarder ships as wms(.exe) in the .zip and .tar.gz packages, only so a copy of 0.5.2-alpha or older can update to this one from Settings.
Command wms-forwarder ships as wms(.exe) in the .zip and .tar.gz packages, only so a copy of 0.5.2-alpha or older can update to this one from Settings.
internal
appcontrol
Package appcontrol knows about Windows' Smart App Control: whether it's on, whether the programs and libraries about to be installed are signed so that it would let them run, and how to say so when it blocks one.
Package appcontrol knows about Windows' Smart App Control: whether it's on, whether the programs and libraries about to be installed are signed so that it would let them run, and how to say so when it blocks one.
auth
Package auth provides users, password hashing and session tokens.
Package auth provides users, password hashing and session tokens.
backup
Package backup makes a ZIP of a server's data and metadata, and puts one back.
Package backup makes a ZIP of a server's data and metadata, and puts one back.
bdsession
Package bdsession turns WittyBluray navigator steps into what the disc player shows: HLS streams of the playlists, PNG overlays for menu buttons and their highlights, button geometry for the remote, and subtitle pictures.
Package bdsession turns WittyBluray navigator steps into what the disc player shows: HLS streams of the playlists, PNG overlays for menu buttons and their highlights, button geometry for the remote, and subtitle pictures.
boundaries
Package boundaries holds the test that keeps the packages meant to leave the server free of the rest of it, so each can move into its module or a core library without taking the server along.
Package boundaries holds the test that keeps the packages meant to leave the server free of the rest of it, so each can move into its module or a core library without taking the server along.
brandart
Package brandart draws every logo, icon and background of the WittyMediaServer family from code.
Package brandart draws every logo, icon and background of the WittyMediaServer family from code.
brandart/fonts
Package fonts holds Inter 4.1 (https://github.com/rsms/inter, SIL Open Font License 1.1, in OFL.txt), the font the website and web client name first, so the words in generated pictures are the same letters people read on the site.
Package fonts holds Inter 4.1 (https://github.com/rsms/inter, SIL Open Font License 1.1, in OFL.txt), the font the website and web client name first, so the words in generated pictures are the same letters people read on the site.
brandname
Package brandname splits the server's name into the parts drawn in the theme colour and the parts drawn plain, the way WittyMediaServer is drawn as Witty, Media in the theme colour, then Server.
Package brandname splits the server's name into the parts drawn in the theme colour and the parts drawn plain, the way WittyMediaServer is drawn as Witty, Media in the theme colour, then Server.
bufpool
Package bufpool keeps the buffers the server fills and empties all day, so each answer borrows one instead of asking for new memory that the garbage collector then has to find and free.
Package bufpool keeps the buffers the server fills and empties all day, so each answer borrows one instead of asking for new memory that the garbage collector then has to find and free.
cd
cdlookup
Package cdlookup finds out what an audio CD is, from MusicBrainz and the Cover Art Archive, using nothing but its table of contents: no names, no audio, and nothing about the person or their files.
Package cdlookup finds out what an audio CD is, from MusicBrainz and the Cover Art Archive, using nothing but its table of contents: no names, no audio, and nothing about the person or their files.
channels
Package channels builds always-on TV channels out of the libraries: what a channel may play (rules), when (blocks), and the schedule that follows.
Package channels builds always-on TV channels out of the libraries: what a channel may play (rules), when (blocks), and the schedule that follows.
config
Package config resolves the server's launch settings.
Package config resolves the server's launch settings.
db
Package db wraps the SQLite store (pure Go driver, no CGO) and migrations.
Package db wraps the SQLite store (pure Go driver, no CGO) and migrations.
desktop
Package desktop talks to the desktop the server runs on (when it has one): opening the web app in the default browser and showing the system's own folder picker during setup.
Package desktop talks to the desktop the server runs on (when it has one): opening the web app in the default browser and showing the system's own folder picker during setup.
diagnose
Package diagnose is WittyDiagnoser, the disk diagnoser: it looks at a DVD or Blu-ray, or at a storage folder, and says in plain words what it found.
Package diagnose is WittyDiagnoser, the disk diagnoser: it looks at a DVD or Blu-ray, or at a storage folder, and says in plain words what it found.
disckey
Package disckey remembers what was worked out about a disc for as long as the disc on disk is the same one: a small cache keyed by where the disc is, how large it is and when it last changed.
Package disckey remembers what was worked out about a disc for as long as the disc on disk is the same one: a small cache keyed by where the disc is, how large it is and when it last changed.
discovery
Package discovery lets apps find this server on the home network, by mDNS/DNS-SD (what Apple's and Android's own browsers use) and, as an extra for clients with raw sockets, by a small UDP question.
Package discovery lets apps find this server on the home network, by mDNS/DNS-SD (what Apple's and Android's own browsers use) and, as an extra for clients with raw sockets, by a small UDP question.
docscheck
Package docscheck holds the tests that keep the guides in docs/ and the in-app help honest: every link leads somewhere, every guide is in the app, nobody is sent to GitHub for help.
Package docscheck holds the tests that keep the guides in docs/ and the in-app help honest: every link leads somewhere, every guide is in the app, nobody is sent to GitHub for help.
dvd
What a WittyDVD helper process and a server say to each other about one open disc: the names of the calls and the form their answers travel in.
What a WittyDVD helper process and a server say to each other about one open disc: the names of the calls and the form their answers travel in.
dvdsession
Package dvdsession turns WittyDVD navigator steps into things a client can show: HLS streams or still frames for the video, PNG overlays for sub-pictures and button highlights, and button geometry for input handling.
Package dvdsession turns WittyDVD navigator steps into things a client can show: HLS streams or still frames for the video, PNG overlays for sub-pictures and button highlights, and button geometry for input handling.
ebook
Package ebook turns book formats a reader can't show directly into EPUB, which it can.
Package ebook turns book formats a reader can't show directly into EPUB, which it can.
ffmpeg
Package ffmpeg locates and drives the bundled FFmpeg binaries.
Package ffmpeg locates and drives the bundled FFmpeg binaries.
gamearchive
Package gamearchive reads the archives game collections come in, and unpacks them to play.
Package gamearchive reads the archives game collections come in, and unpacks them to play.
gameid
Package gameid works out what a game file is from its own bytes: which console it belongs to, whether it's a game at all, what it calls itself, and how sure that is.
Package gameid works out what a game file is from its own bytes: which console it belongs to, whether it's a game at all, what it calls itself, and how sure that is.
gameid/fixture
Package fixture makes tiny files for tests that have the headers real games have and nothing else: no game's code or data, only the marks the checks in gameid look for.
Package fixture makes tiny files for tests that have the headers real games have and nothing else: no game's code or data, only the marks the checks in gameid look for.
gamemeta
Package gamemeta finds out about video games: what they're called, what they are, who made them, how they were rated and what they look like.
Package gamemeta finds out about video games: what they're called, what they are, who made them, how they were rated and what they look like.
gameregion
Package gameregion holds the owner's order of regions: which version of a game to prefer when there's more than one.
Package gameregion holds the owner's order of regions: which version of a game to prefer when there's more than one.
hls
Package hls runs FFmpeg transcodes that produce HLS segments on demand.
Package hls runs FFmpeg transcodes that produce HLS segments on demand.
identity
Package identity gives a server something a look-alike can't copy: a random ID, which only names it, and an Ed25519 key, which proves it.
Package identity gives a server something a look-alike can't copy: a random ID, which only names it, and an Ed25519 key, which proves it.
instance
Package instance keeps to one server per data folder.
Package instance keeps to one server per data folder.
introdetect
Package introdetect finds the part episodes of a season share: the title sequence at the front, the credits music at the back.
Package introdetect finds the part episodes of a season share: the title sequence at the front, the credits music at the back.
layout
Package layout knows what an installed WittyMediaServer looks like, on every system and however it was installed, and what its programs are called.
Package layout knows what an installed WittyMediaServer looks like, on every system and however it was installed, and what its programs are called.
legal
Package legal holds the words the project says about itself, in one place: the short notices shown beside content (notices.json) and the full Legal page (legal.json).
Package legal holds the words the project says about itself, in one place: the short notices shown beside content (notices.json) and the full Legal page (legal.json).
library
Package library owns libraries, media items, scanning and metadata.
Package library owns libraries, media items, scanning and metadata.
libtranscode
Package libtranscode converts the files of a library ahead of time, so they play without being converted later.
Package libtranscode converts the files of a library ahead of time, so they play without being converted later.
libtranscode/tdarr
Package tdarr talks to someone's own Tdarr server over its HTTP API, which is documented at docs.tdarr.io.
Package tdarr talks to someone's own Tdarr server over its HTTP API, which is documented at docs.tdarr.io.
licenses
Package licenses says what this server is made of and under which licenses, for Settings, About.
Package licenses says what this server is made of and under which licenses, for Settings, About.
licenses/gen command
Command gen writes internal/licenses/libraries.json.gz: every library compiled into what a release ships, with its license and its full text, for Settings, About.
Command gen writes internal/licenses/libraries.json.gz: every library compiled into what a release ships, with its license and its full text, for Settings, About.
livetv
Package livetv runs tuners for the server: their settings and channels, the guide data from XMLTV and from the broadcasts themselves, opening streams within each tuner's limits, and recording.
Package livetv runs tuners for the server: their settings and channels, the guide data from XMLTV and from the broadcasts themselves, opening streams within each tuner's limits, and recording.
logging
Package logging is the server's log: structured records in categories with their own levels, kept in memory for the viewer and written to daily files in a folder the owner chooses.
Package logging is the server's log: structured records in categories with their own levels, kept in memory for the viewer and written to daily files in a folder the owner chooses.
lyrics
SPDX-License-Identifier: AGPL-3.0-or-later Copyright (C) 2026 WittyWilla and contributors
SPDX-License-Identifier: AGPL-3.0-or-later Copyright (C) 2026 WittyWilla and contributors
mediaextras
Package mediaextras finds and keeps the things that go with a media file without being part of it: a short looping video shown behind a song or a title (a "canvas"), the separated parts of a song for karaoke ("stems"), and where the intro, recap, credits and adverts are in a video ("markers").
Package mediaextras finds and keeps the things that go with a media file without being part of it: a short looping video shown behind a song or a title (a "canvas"), the separated parts of a song for karaoke ("stems"), and where the intro, recap, credits and adverts are in a video ("markers").
mediatypes
Package mediatypes is the one list of the file types, containers and codecs the server knows: what each is called, how to recognise it, which libraries take it, how it plays and what it needs.
Package mediatypes is the one list of the file types, containers and codecs the server knows: what each is called, how to recognise it, which libraries take it, how it plays and what it needs.
mediatypes/gen command
Command gen writes the files made from the registry: the Supported formats page, the registry as JSON, and the few lists the web app needs before it has asked the server.
Command gen writes the files made from the registry: the Supported formats page, the registry as JSON, and the few lists the web app needs before it has asked the server.
metafolder
Package metafolder is the format of the editable metadata folder, and the checks on anything read back from a file someone can edit: the folder itself, and the NFO and JSON files beside media.
Package metafolder is the format of the editable metadata folder, and the checks on anything read back from a file someone can edit: the folder itself, and the NFO and JSON files beside media.
metrics
Package metrics watches the machine for the statistics screen, and costs almost nothing when nobody is looking.
Package metrics watches the machine for the statistics screen, and costs almost nothing when nobody is looking.
midi
Package midi reads Standard MIDI Files and plays them with a small synthesiser of its own: FFmpeg doesn't read MIDI, and this needs no sound font or other download.
Package midi reads Standard MIDI Files and plays them with a small synthesiser of its own: FFmpeg doesn't read MIDI, and this needs no sound font or other download.
modules
Package modules runs the plugins, none of which is compiled into the server: which version is in use, why, and getting a newer or older one.
Package modules runs the plugins, none of which is compiled into the server: which version is in use, why, and getting a newer or older one.
modules/bdremote
Package bdremote runs a Blu-ray session's engine in a helper process, of the WittyBluray version in use.
Package bdremote runs a Blu-ray session's engine in a helper process, of the WittyBluray version in use.
modules/dvdremote
Package dvdremote plays a disc through the WittyDVD version in use: a helper process for each open disc, behind the interfaces a session uses.
Package dvdremote plays a disc through the WittyDVD version in use: a helper process for each open disc, behind the interfaces a session uses.
modules/modtest
Package modtest gives a test real modules, from a catalogue on this machine: the one scripts/make-test-catalog.sh makes.
Package modtest gives a test real modules, from a catalogue on this machine: the one scripts/make-test-catalog.sh makes.
music
Package music is the music library's own framework: what ties a song to its music video, and how the two are matched.
Package music is the music library's own framework: what ties a song to its music video, and how the two are matched.
p2p
Package p2p connects an app to a server at home with nothing set up on the router and no machine rented anywhere.
Package p2p connects an app to a server at home with nothing set up on the router and no machine rented anywhere.
pace
Package pace fits the server to the machine it runs on, so a small one (a Raspberry Pi 3, an old Celeron mini PC) stays responsive.
Package pace fits the server to the machine it runs on, so a small one (a Raspberry Pi 3, an old Celeron mini PC) stays responsive.
parental
Package parental holds the parts of parental controls that are plain arithmetic: when a profile may watch, how long it has left, and what each country's ratings mean in years.
Package parental holds the parts of parental controls that are plain arithmetic: when a profile may watch, how long it has left, and what each country's ratings mean in years.
play
Package wittyplay is what a server knows of the module's package of that name: its types and constants as they are, and a call to the module for everything it does.
Package wittyplay is what a server knows of the module's package of that name: its types and constants as they are, and a call to the module for everything it does.
play/cores
Package cores is what a server knows of the module's package of that name: its types and constants as they are, and a call to the module for everything it does.
Package cores is what a server knows of the module's package of that name: its types and constants as they are, and a call to the module for everything it does.
play/fakecore
Package fakecore builds real shared libraries for tests of what happens when a core is added: one that works, and several that misbehave in the ways a hostile or broken file can.
Package fakecore builds real shared libraries for tests of what happens when a core is added: one that works, and several that misbehave in the ways a hostile or broken file can.
play/hostsandbox
Package hostsandbox is what the host does to itself before it loads a core.
Package hostsandbox is what the host does to itself before it loads a core.
play/ipc
Package ipc is what a server knows of the module's package of that name: its types and constants as they are, and a call to the module for everything it does.
Package ipc is what a server knows of the module's package of that name: its types and constants as they are, and a call to the module for everything it does.
play/patch
Package patch is what a server knows of the module's package of that name: its types and constants as they are, and a call to the module for everything it does.
Package patch is what a server knows of the module's package of that name: its types and constants as they are, and a call to the module for everything it does.
play/stream
Package stream is what a server knows of the module's package of that name: its types and constants as they are, and a call to the module for everything it does.
Package stream is what a server knows of the module's package of that name: its types and constants as they are, and a call to the module for everything it does.
playback
Package playback decides how a client plays a file: as it is (direct), rewrapped into HLS without touching the picture (remux), or converted (transcode).
Package playback decides how a client plays a file: as it is (direct), rewrapped into HLS without touching the picture (remux), or converted (transcode).
portmap
Package portmap asks the home router to forward a port to this machine, with NAT-PMP (RFC 6886) or UPnP IGD.
Package portmap asks the home router to forward a port to this machine, with NAT-PMP (RFC 6886) or UPnP IGD.
remote
Package remote holds what remote access is built on: deciding who a request really comes from (and whether forwarded headers may be believed), HTTPS certificates, and the numbers behind the Remote Access settings page.
Package remote holds what remote access is built on: deciding who a request really comes from (and whether forwarded headers may be believed), HTTPS certificates, and the numbers behind the Remote Access settings page.
reset
Package reset puts a server back the way it was first installed, or back to a copy kept by an earlier reset.
Package reset puts a server back the way it was first installed, or back to a copy kept by an earlier reset.
sduistore
Package sduistore keeps the server's UI configuration, ui_config.json in the data folder: the pages and navigation an administrator changed (pkg/sdui; what nobody changed comes from the built-in pages) and the theme overrides the Master Theme Engine applies.
Package sduistore keeps the server's UI configuration, ui_config.json in the data folder: the pages and navigation an administrator changed (pkg/sdui; what nobody changed comes from the built-in pages) and the theme overrides the Master Theme Engine applies.
seamcheck
Package seamcheck measures what a stream does to the disc underneath it: which pictures and how much sound it loses, repeats or moves at each chapter boundary.
Package seamcheck measures what a stream does to the disc underneath it: which pictures and how much sound it loses, repeats or moves at each chapter boundary.
separator
Package separator finds a stem separator the owner already installed (Demucs, Spleeter, audio-separator), so karaoke needs no configuration: the server looks on the PATH and in the usual places such tools are installed, and uses the best it finds.
Package separator finds a stem separator the owner already installed (Demucs, Spleeter, audio-separator), so karaoke needs no configuration: the server looks on the PATH and in the usual places such tools are installed, and uses the best it finds.
server
SPDX-License-Identifier: AGPL-3.0-or-later Copyright (C) 2026 WittyWilla and contributors
SPDX-License-Identifier: AGPL-3.0-or-later Copyright (C) 2026 WittyWilla and contributors
subtitle
Package subtitle turns subtitle text into WebVTT, the form players show beside a video.
Package subtitle turns subtitle text into WebVTT, the form players show beside a video.
syncplay
Package syncplay is watch parties: people in different places watching the same thing at the same moment.
Package syncplay is watch parties: people in different places watching the same thing at the same moment.
sysinfo
Package sysinfo asks the operating system what a support report needs to know: the processor, memory, graphics cards, and how much room a disk has.
Package sysinfo asks the operating system what a support report needs to know: the processor, memory, graphics cards, and how much room a disk has.
tasks
Package tasks is the one place the server keeps track of its background work: library scans, metadata, module installs, transcodes, backups and anything else that takes longer than a request.
Package tasks is the one place the server keeps track of its background work: library scans, metadata, module installs, transcodes, backups and anything else that takes longer than a request.
themes
Package themes manages interface themes.
Package themes manages interface themes.
totp
Package totp makes and checks one-time passwords: HOTP (RFC 4226) and the time-based TOTP built on it (RFC 6238), with the standard library only.
Package totp makes and checks one-time passwords: HOTP (RFC 4226) and the time-based TOTP built on it (RFC 6238), with the standard library only.
trayicon
Package trayicon draws the tray and menu-bar icon at runtime from the brand drawings (internal/brandart, docs/BRAND.md), so no asset files need shipping: the server's mark in colour, grey while the server is stopped, and a one-colour template for the macOS menu bar.
Package trayicon draws the tray and menu-bar icon at runtime from the brand drawings (internal/brandart, docs/BRAND.md), so no asset files need shipping: the server's mark in colour, grey while the server is stopped, and a one-colour template for the macOS menu bar.
tuner/mpegts
Package mpegts reads the parts of an MPEG transport stream a TV tuner needs: the scrambling bits, what the stream says it carries (PAT, PMT, SDT, ATSC VCT) and the programme guide inside it (DVB EIT, ATSC PSIP).
Package mpegts reads the parts of an MPEG transport stream a TV tuner needs: the scrambling bits, what the stream says it carries (PAT, PMT, SDT, ATSC VCT) and the programme guide inside it (DVB EIT, ATSC PSIP).
tuner/xmltv
Package xmltv reads XMLTV guide files as they stream by, so a very large guide needs very little memory.
Package xmltv reads XMLTV guide files as they stream by, so a very large guide needs very little memory.
uninstall
Package uninstall removes WittyMediaServer from a computer.
Package uninstall removes WittyMediaServer from a computer.
update
Package update finds, verifies and installs new releases of WittyMediaServer from its GitHub releases.
Package update finds, verifies and installs new releases of WittyMediaServer from its GitHub releases.
watchxref
Package watchxref answers "where can I watch this?" for one title: whether it's in this library (and in what quality and versions), next to where the outside services offer it in the viewer's region, to stream, rent or buy.
Package watchxref answers "where can I watch this?" for one title: whether it's in this library (and in what quality and versions), next to where the outside services offer it in the viewer's region, to stream, rent or buy.
wittyplayfile
Package wittyplayfile reads and writes .wittyplay files: a small, open JSON format that says how games are pictured in WittyPlay (box art fitted or filled, or drawn in a cartridge or case, which case, and what goes on its label), for everything, per console and per game.
Package wittyplayfile reads and writes .wittyplay files: a small, open JSON format that says how games are pictured in WittyPlay (box art fitted or filled, or drawn in a cartridge or case, which case, and what goes on its label), for everything, per console and per game.
wittyremote
Package wittyremote is the Remote Protocol: one WittyMedia client controlling another through the server.
Package wittyremote is the Remote Protocol: one WittyMedia client controlling another through the server.
zipsafe
Package zipsafe checks a zip before anything allocates for it.
Package zipsafe checks a zip before anything allocates for it.
pkg
sdui
Package sdui is WittyMediaServer's server-driven UI: the model an administrator writes pages in, the catalogue that describes it, the validator, and the renderer that turns one page into the tree of components one profile's app draws on one device.
Package sdui is WittyMediaServer's server-driven UI: the model an administrator writes pages in, the catalogue that describes it, the validator, and the renderer that turns one page into the tree of components one profile's app draws on one device.
sdui/conformance
Package conformance is the SDUI conformance kit: fixtures that pin down, case by case, the tree the server sends for a page and the layout a renderer makes of it, and the reference implementation of both steps.
Package conformance is the SDUI conformance kit: fixtures that pin down, case by case, the tree the server sends for a page and the layout a renderer makes of it, and the reference implementation of both steps.
wittyconnect
Package wittyconnect is the app's side of peer-to-peer connections, ready to use: it connects to a server by its connection ID and offers what an app already knows how to talk to, an HTTP address on this device.
Package wittyconnect is the app's side of peer-to-peer connections, ready to use: it connects to a server by its connection ID and offers what an app already knows how to talk to, an HTTP address on this device.
wittyconnect/mobile
Package mobile is wittyconnect in the shape gomobile can bind for Kotlin and Swift: plain strings, numbers and one small interface.
Package mobile is wittyconnect in the shape gomobile can bind for Kotlin and Swift: plain strings, numbers and one small interface.
scripts
biosdat command
Command biosdat writes internal/server/biosknown.txt: the BIOS files a games server can recognise by their checksum, wherever someone keeps them and whatever they're called.
Command biosdat writes internal/server/biosknown.txt: the BIOS files a games server can recognise by their checksum, wherever someone keeps them and whatever they're called.
corebuilds command
Command corebuilds keeps internal/server/corebuilds.txt true: which game cores libretro's build server publishes for each platform a server can download them on.
Command corebuilds keeps internal/server/corebuilds.txt true: which game cores libretro's build server publishes for each platform a server can download them on.
genicon command
Command genicon draws every logo, icon and background of the WittyMediaServer family from the brand drawings in internal/brandart (docs/BRAND.md): vector first, written as SVG, Android vector drawables, Kotlin and Swift drawing code, and rasterised to every PNG, ICO, ICNS, BMP and JPEG size each platform asks for.
Command genicon draws every logo, icon and background of the WittyMediaServer family from the brand drawings in internal/brandart (docs/BRAND.md): vector first, written as SVG, Android vector drawables, Kotlin and Swift drawing code, and rasterised to every PNG, ICO, ICNS, BMP and JPEG size each platform asks for.
pack command
Command pack writes a release archive (.zip or .tar.gz) of a directory with correct Unix permissions on any build machine.
Command pack writes a release archive (.zip or .tar.gz) of a directory with correct Unix permissions on any build machine.
perf command
Command perf measures a server build the same way each time, so that releases can be compared: start-up, memory and processor use while idle, library scans, and the API's answers.
Command perf measures a server build the same way each time, so that releases can be compared: start-up, memory and processor use while idle, library scans, and the API's answers.
sdui-catalog command
Command sdui-catalog is a developer tool and never ships.
Command sdui-catalog is a developer tool and never ships.
settingsini command
Command settingsini writes the settings.ini that archives and installers put beside the program, the same text the server writes (config.SettingsText), so there's one copy of it.
Command settingsini writes the settings.ini that archives and installers put beside the program, the same text the server writes (config.SettingsText), so there's one copy of it.
sign command
Command sign is a developer tool and never ships.
Command sign is a developer tool and never ships.
vulncheck command
Command vulncheck is a developer and CI tool and never ships.
Command vulncheck is a developer and CI tool and never ships.
Package themes holds the built-in interface themes.
Package themes holds the built-in interface themes.
Package web embeds the built single-page client (web/dist).
Package web embeds the built single-page client (web/dist).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL