README
¶
This is the development repository for Zaparoo Core.
Visit Zaparoo.org for more information about the Zaparoo project or the Downloads page to download Zaparoo Core for your platform.
Contributors
See the Contributors page for a complete list of all contributors to the Zaparoo project. Contributions are welcome and appreciated!
Sponsors
Free code signing on Windows provided by SignPath.io, certificate by SignPath Foundation
Trademarks
This repository contains Zaparoo trademarks which are explicitly licensed to the project in this location by the trademark owner. These trademarks must be removed from the project or replaced if you intend to redistribute or adapt the project in any form. See the Zaparoo Terms of Use for further details.
License
The code in this repository is released under the GNU General Public License v3.0.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
batocera
command
|
|
|
bazzite
command
|
|
|
chimeraos
command
|
|
|
libreelec
command
|
|
|
linux
command
|
|
|
mac
command
|
|
|
mister
command
|
|
|
mistex
command
|
|
|
recalbox
command
|
|
|
replayos
command
|
|
|
retropie
command
|
|
|
steamos
command
|
|
|
windows
command
|
|
|
zapos
command
|
|
|
internal
|
|
|
telemetry
Package telemetry provides opt-in error reporting via Sentry.
|
Package telemetry provides opt-in error reporting via Sentry. |
|
vdfbinary
Package vdfbinary parses Valve's binary VDF format.
|
Package vdfbinary parses Valve's binary VDF format. |
|
pkg
|
|
|
api/crypto
Package crypto provides AES-256-GCM encryption with HKDF-derived per-session keys for the Zaparoo API WebSocket transport.
|
Package crypto provides AES-256-GCM encryption with HKDF-derived per-session keys for the Zaparoo API WebSocket transport. |
|
api/permissions
Package permissions defines client roles and the capability lookup that gates privileged API methods.
|
Package permissions defines client roles and the capability lookup that gates privileged API methods. |
|
api/validation
Package validation provides validation for API request parameters using go-playground/validator with custom validators for Zaparoo-specific types.
|
Package validation provides validation for API request parameters using go-playground/validator with custom validators for Zaparoo-specific types. |
|
audio
Package audio provides cross-platform audio playback using malgo.
|
Package audio provides cross-platform audio playback using malgo. |
|
database/perfmetrics
Package perfmetrics captures coarse process and SQLite resource counters for long media operations.
|
Package perfmetrics captures coarse process and SQLite resource counters for long media operations. |
|
database/scraper
Package scraper defines the metadata scraper types and generic run loop.
|
Package scraper defines the metadata scraper types and generic run loop. |
|
database/scraper/gamelistxml
Package gamelistxml implements a scraper that reads EmulationStation gamelist.xml files to enrich the Zaparoo MediaDB with developer, publisher, genre, rating, year, artwork paths, and descriptions.
|
Package gamelistxml implements a scraper that reads EmulationStation gamelist.xml files to enrich the Zaparoo MediaDB with developer, publisher, genre, rating, year, artwork paths, and descriptions. |
|
database/scraper/localmedia
Package localmedia imports EmulationStation-style media folder artwork.
|
Package localmedia imports EmulationStation-style media folder artwork. |
|
helpers/bgpriority
Package bgpriority lowers the scheduling priority of dedicated background worker goroutines so long-running work (media indexing, scraping) yields CPU and storage bandwidth to foreground activity.
|
Package bgpriority lowers the scheduling priority of dedicated background worker goroutines so long-running work (media indexing, scraping) yields CPU and storage bandwidth to foreground activity. |
|
helpers/command
Package command provides an abstraction over exec.Command for testability.
|
Package command provides an abstraction over exec.Command for testability. |
|
helpers/gameid
Package gameid wraps go-gameid disc identification for the two things that need it: the indexer (identify a disc image to store as a media property) and the optical drive reader (identify an inserted disc live).
|
Package gameid wraps go-gameid disc identification for the two things that need it: the indexer (identify a disc image to store as a media property) and the optical drive reader (identify an inserted disc live). |
|
helpers/pathutil
Package pathutil provides path resolution utilities with no dependencies on other Zaparoo packages.
|
Package pathutil provides path resolution utilities with no dependencies on other Zaparoo packages. |
|
helpers/syncutil
Package syncutil provides mutex primitives with optional deadlock detection.
|
Package syncutil provides mutex primitives with optional deadlock detection. |
|
launchables
Package launchables defines shared IDs and URI helpers for platform-owned virtual launch targets.
|
Package launchables defines shared IDs and URI helpers for platform-owned virtual launch targets. |
|
platforms/ids
Package ids provides platform ID constants.
|
Package ids provides platform ID constants. |
|
platforms/mediaslot
Package mediaslot defines media slot identifiers shared across launch, playback, and playlist routing.
|
Package mediaslot defines media slot identifiers shared across launch, playback, and playlist routing. |
|
platforms/shared/esapi
Package esapi provides types and helpers for reading EmulationStation gamelist.xml files.
|
Package esapi provides types and helpers for reading EmulationStation gamelist.xml files. |
|
platforms/shared/esde
Package esde provides shared utilities for EmulationStation Desktop Edition based platforms including ES-DE, Batocera ES, and RetroBat.
|
Package esde provides shared utilities for EmulationStation Desktop Edition based platforms including ES-DE, Batocera ES, and RetroBat. |
|
platforms/shared/esmedia
Package esmedia resolves local EmulationStation-style media folders and paths.
|
Package esmedia resolves local EmulationStation-style media folders and paths. |
|
platforms/shared/linuxbase/gamescope
Package gamescope makes externally launched windows visible and focused in gamescope Gaming Mode sessions.
|
Package gamescope makes externally launched windows visible and focused in gamescope Gaming Mode sessions. |
|
platforms/shared/linuxbase/procscanner
Package procscanner provides a shared process scanner for monitoring multiple types of processes with a single /proc scan.
|
Package procscanner provides a shared process scanner for monitoring multiple types of processes with a single /proc scan. |
|
platforms/shared/linuxbase/proctracker
Package proctracker provides process exit tracking using pidfd_open on Linux 5.3+.
|
Package proctracker provides process exit tracking using pidfd_open on Linux 5.3+. |
|
platforms/shared/retroarch
Package retroarch provides reusable RetroArch CLI launchers.
|
Package retroarch provides reusable RetroArch CLI launchers. |
|
platforms/shared/steam/steamtracker
Package steamtracker provides Steam game lifecycle tracking on Linux.
|
Package steamtracker provides Steam game lifecycle tracking on Linux. |
|
platforms/windows/windowfocus
Package windowfocus activates windows created by launched Windows processes.
|
Package windowfocus activates windows created by launched Windows processes. |
|
platforms/zapos
Package zapos implements the Zaparoo OS appliance platform.
|
Package zapos implements the Zaparoo OS appliance platform. |
|
readers/testutils
Package testutils provides common testing utilities for reader tests.
|
Package testutils provides common testing utilities for reader tests. |
|
service/broker
Package broker provides a simple in-process notification broker for broadcasting messages to multiple consumers without blocking.
|
Package broker provides a simple in-process notification broker for broadcasting messages to multiple consumers without blocking. |
|
service/idle
Package idle provides a small scheduler for "run eventually" background work.
|
Package idle provides a small scheduler for "run eventually" background work. |
|
service/inbox
Package inbox provides a service for managing persistent system notifications.
|
Package inbox provides a service for managing persistent system notifications. |
|
service/profiles
Package profiles implements device profiles: named buckets of preferences and limits.
|
Package profiles implements device profiles: named buckets of preferences and limits. |
|
testing/helpers
Package helpers provides testing utilities for API operations.
|
Package helpers provides testing utilities for API operations. |
|
testing/scantest
Package scantest populates media databases in tests through the production staging pipeline.
|
Package scantest populates media databases in tests through the production staging pipeline. |
|
testing/sqlmock
Package sqlmock provides SQL mocking utilities for testing.
|
Package sqlmock provides SQL mocking utilities for testing. |
|
ui/events
Package events manages global, transient UI requests.
|
Package events manages global, transient UI requests. |
|
scripts
|
|
|
generate-update-manifest
command
generate-update-manifest builds a manifest.yaml for go-selfupdate's HttpSource from a directory of release assets.
|
generate-update-manifest builds a manifest.yaml for go-selfupdate's HttpSource from a directory of release assets. |
|
genhistorydb
command
Command genhistorydb builds a user.db full of legacy MediaHistory rows (no identity snapshot, policy version 0) for stress-testing the media history identity backfill sweep on real hardware.
|
Command genhistorydb builds a user.db full of legacy MediaHistory rows (no identity snapshot, policy version 0) for stress-testing the media history identity backfill sweep on real hardware. |
|
tasks/utils/makezip
command
|
|
|
tasks/utils/windowsiss
command
|
|
|
tasks/utils/windowsmeta
command
|
Click to show internal directories.
Click to hide internal directories.