Publish curated Ludarium source from 781315f3f71031995159287f425aeac47a77515b
Public source validation / source (push) Successful in 3m8s
Public source validation / source (push) Successful in 3m8s
This commit is contained in:
1 parent
df869819ce
commit
93c840d38b
12 files changed
+599
-563
No files matched your search
@@ -1,5 +1,8 @@
|
||||
# Ludarium
|
||||
|
||||
<p align="center"><strong>Your game archive, searchable and accountable.</strong></p>
|
||||
<p align="center"><a href="#explore-the-interface">Interface</a> · <a href="#what-you-can-do">Features</a> · <a href="#quick-start">Quick start</a> · <a href="#architecture">Architecture</a></p>
|
||||
|
||||
**A local-first, self-hosted catalog for game archives.** Ludarium turns read-only folders of ROMs,
|
||||
disc images and archived Windows installers into a searchable library with provenance, integrity
|
||||
evidence and an explicit review queue. It is built for Unraid, but the supplied Compose deployment
|
||||
@@ -7,6 +10,14 @@ also works on a regular Docker host.
|
||||
|
||||

|
||||
|
||||
## Explore the interface
|
||||
|
||||
These captures show a deliberately empty, privacy-safe example archive. Your own files and metadata appear only after you add read-only library mounts and scan them.
|
||||
|
||||
| Searchable library | Review queue |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
## What you can do
|
||||
|
||||
- discover and fingerprint files without renaming, moving or executing them;
|
||||
@@ -65,6 +76,19 @@ for the content you index and for complying with the rules that apply to it.
|
||||
no credentials are configured.
|
||||
- Report vulnerabilities privately using [`SECURITY.md`](SECURITY.md).
|
||||
|
||||
## Architecture
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
Libraries[Read-only archive mounts] --> Scanner[Inventory and fingerprints]
|
||||
Scanner --> Review[Explicit review queue]
|
||||
Review --> Catalog[(PostgreSQL catalog)]
|
||||
Catalog --> Web[React library and collections]
|
||||
Catalog --> Exports[Portable catalog exports]
|
||||
```
|
||||
|
||||
The cataloging pipeline only reads mounted source libraries. PostgreSQL stores identities, provenance, collections and review state; cache, exports and optional player data use separate writable locations. This separation lets you re-scan or restore the catalog without changing original game files.
|
||||
|
||||
## Development
|
||||
|
||||
The backend targets .NET 10, the UI uses React 19 and Vite, and controller helpers use Python's standard
|
||||
|
||||
Reference in new issue
Block a user