Directories
¶
| Path | Synopsis |
|---|---|
|
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. |
|
Package auth provides users, password hashing and session tokens.
|
Package auth provides users, password hashing and session tokens. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
Package config resolves the server's launch settings.
|
Package config resolves the server's launch settings. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
Package ffmpeg locates and drives the bundled FFmpeg binaries.
|
Package ffmpeg locates and drives the bundled FFmpeg binaries. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
Package hls runs FFmpeg transcodes that produce HLS segments on demand.
|
Package hls runs FFmpeg transcodes that produce HLS segments on demand. |
|
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. |
|
Package instance keeps to one server per data folder.
|
Package instance keeps to one server per data folder. |
|
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. |
|
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. |
|
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). |
|
Package library owns libraries, media items, scanning and metadata.
|
Package library owns libraries, media items, scanning and metadata. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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 |
|
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"). |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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). |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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 |
|
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. |
|
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. |
|
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. |
|
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. |
|
Package themes manages interface themes.
|
Package themes manages interface themes. |
|
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. |
|
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. |
|
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). |
|
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. |
|
Package uninstall removes WittyMediaServer from a computer.
|
Package uninstall removes WittyMediaServer from a computer. |
|
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. |
|
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. |
|
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. |
|
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. |
|
Package zipsafe checks a zip before anything allocates for it.
|
Package zipsafe checks a zip before anything allocates for it. |
Click to show internal directories.
Click to hide internal directories.