Better README.

Added images and checkboxes to the features section.
This commit is contained in:
天クマ 2026-03-27 18:40:19 -03:00
commit 98cd823999
11 changed files with 33 additions and 12 deletions

View file

@ -1,17 +1,32 @@
# LivingRoom
![Screenshot showing three browser sessions containing the games page, the game page and the download page.](media/screenshots/1.jpg)
This is a work-in-progress kinda of game launcher. LivingRoom is a server software that allows you to organize, display and distribute your catalog of games.
The server includes a (working but very WIP) HTTP API for third-party clients and an web interface.
## Features
The server includes a (working but very WIP) HTTP API for third-party clients and a web interface.
- HTTP API (NO AUTHENTICATION YET)
- Web interface
- User management
## Features
### HTTP API
- [ ] Authentication
- [x] Library info
- [x] Game info
- [x] Downloads
- [ ] Resumable downloads
- [ ] User Management
- [ ] Search
### Web interface
- [x] Authentication
- [x] Game listing
- [x] Game page
- [x] Admin actions
- [x] Deindex game
- [x] Trigger new scan
- [x] Downloads (from the API)
- [x] User Management
## Stack
- **Freemarker** for web rendering
- **Manual HTTP** handling
- **SQLite** for storing game information