whatisgithub

What is vaultarr?

linkssy2/vaultarr — explained in plain English

Analysis updated 2026-05-18

4PythonAudience · generalComplexity · 3/5Setup · moderate

In one sentence

A self-hosted digital museum that turns a folder of game files into a browsable library with automatic cover art, metadata, and manuals.

Mindmap

mindmap
  root((Vaultarr))
    What it does
      Digital game museum
      Auto metadata enrichment
      Manual and trailer finder
    Tech stack
      Python
      Docker
      Jinja templates
    Use cases
      Browse a personal game library
      Preserve manuals and box art
      Track compatibility patches
    Audience
      Game collectors
      Self-hosters
      Preservation hobbyists

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Turn a personal collection of game files into a browsable digital museum with cover art and metadata

USE CASE 2

Automatically pull box art, screenshots, and trailers for games already on disk

USE CASE 3

Download and organize scanned game manuals for a personal collection

USE CASE 4

Track preservation status and compatibility patches for older games

What is it built with?

PythonDockerJinja

How does it compare?

linkssy2/vaultarr1038lab/agnes-ai3eyedtiger/video2vrcemote
Stars444
LanguagePythonPythonPython
Setup difficultymoderateeasyeasy
Complexity3/52/51/5
Audiencegeneralvibe codervibe coder

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 30min

Runs via Docker Compose pulling a prebuilt image, with games, config, and backup folders mounted as volumes.

So what is it?

Vaultarr is a self-hosted application that turns a folder of game files into a browsable digital museum. You point it at the folders where your games already live, and a background process automatically enriches each one with cover art, screenshots, descriptions, and other metadata pulled from sources like LaunchBox, IGDB, RAWG, Steam, Wikipedia, and SteamGridDB, so you spend your time browsing a curated collection instead of manually organizing files. The interface presents each game as a floating card inside a museum style layout, with a home screen described as a calm lobby and plain language status updates from what the project calls its Curator. Beyond basic library scanning, Vaultarr can find trailers, track community patches and compatibility notes, group games into smart collections, and show a preservation status for each title covering any known issues or archived assets. A notable feature is its manual finder, which searches an indexed archive of scanned game manuals and falls back to a second manual only source when nothing suitable is found. Every manual is validated as a real PDF file, checked for a safe size limit, and matched against the correct scan resolution before it gets saved locally, so downloads are not left to guesswork. The normal way to run Vaultarr is Docker Compose, pulling a prebuilt image rather than building it yourself, with your games folder, a config folder, and a backups folder mounted as volumes. It also runs on Windows without Docker by extracting a release zip and launching a batch file. After first launch, a short onboarding flow walks you through adding your library and starting an initial scan. Vaultarr can require a login, with passwords stored in hashed form rather than plain text, and Docker users can set an initial admin username and password through environment variables. The project describes itself as an alpha release, with ongoing interface refinements and quality passes across its templates and scripts.

Copy-paste prompts

Prompt 1
Help me set up Vaultarr with Docker Compose pointing at my existing games folder
Prompt 2
Explain how Vaultarr's manual finder searches and validates scanned game manuals
Prompt 3
Show me how to enable authentication and set an admin password for my Vaultarr instance
Prompt 4
Walk me through running Vaultarr on Windows without Docker using the release zip

Frequently asked questions

What is vaultarr?

A self-hosted digital museum that turns a folder of game files into a browsable library with automatic cover art, metadata, and manuals.

What language is vaultarr written in?

Mainly Python. The stack also includes Python, Docker, Jinja.

How hard is vaultarr to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is vaultarr for?

Mainly general.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.