Files

T

branderson 0980b789d5 feat(saves): store game saves on the player's account

Adds game_save_snapshots and /api/game-saves for copies of the saves games
keep in a player's browser. An upload matching the current save is a no-op,
the newest 10 snapshots per user and game are kept as backups, and saves may
be up to 10 MB, so the router parses its own bodies past the app's 1 MB JSON
limit.

2026-10-12 16:17:09 -07:00

scripts

feat: revamp the game serving feature

2026-02-07 23:36:45 +07:00

src

feat(saves): store game saves on the player's account

2026-10-12 16:17:09 -07:00

.env.example

chore(config): centralize and document environment variables

2026-08-11 16:02:06 +07:00

.eslintrc.json

chore: apply consistent code formatting across codebase

2026-02-04 06:03:39 +07:00

.gitignore

feat: initial features

2026-01-16 23:58:21 +07:00

docker-entrypoint.sh

feat(startup): serve the app while the server warms up

2026-08-12 14:05:14 +07:00

package-lock.json

feat: initial features

2026-01-16 23:58:21 +07:00

package.json

fix(playlists): bundle community playlist index

2026-08-13 13:57:52 +07:00

README.md

feat: revamp the game serving feature

2026-02-07 23:36:45 +07:00

tsconfig.json

feat: add shared download registry, type safety, and test infra

2026-02-11 14:43:00 +07:00

vitest.config.ts

feat: add shared download registry, type safety, and test infra

2026-02-11 14:43:00 +07:00

README.md

Flashpoint Web Backend

Node.js/Express API server for the Flashpoint Archive web application.

Features

RESTful API for game metadata
Direct SQLite database access (read-only)
Integrated game content serving (proxy + ZIP)
Image and logo serving
Playlist management
Platform and tag endpoints

Quick Start

# Install dependencies
npm install

# Configure environment
cp .env.example .env

# Start development server
npm run dev

Server runs on http://localhost:3100

API Endpoints

See ../../api-specification.md for complete API documentation.

Core Endpoints

GET /health - Health check
GET /api/games - List games
GET /api/games/:id - Get game details
GET /api/platforms - List platforms
GET /api/tags - List tags
GET /api/playlists - List playlists

Architecture

src/
├── routes/          # Express route handlers
├── services/        # Business logic layer
├── game/            # Integrated game service (proxy, ZIP, CGI)
├── middleware/      # Express middleware
├── utils/           # Helper functions
├── config.ts        # Configuration management
└── server.ts        # Application entry point

Database

Uses sql.js (pure JavaScript SQLite) for direct read-only access to:

D:\Flashpoint\Data\flashpoint.sqlite

No native compilation required! sql.js is a WebAssembly-based SQLite implementation that works without Visual Studio or build tools.

Schema includes tables for games, platforms, tags, and more.

Development

npm run dev        # Start with hot reload (tsx)
npm run build      # Compile TypeScript
npm run start      # Run compiled version
npm run typecheck  # Type checking only
npm run lint       # ESLint

Environment Variables

Required:

FLASHPOINT_PATH - Path to Flashpoint installation
FLASHPOINT_DB_PATH - Path to SQLite database

Optional:

PORT - Server port (default: 3100)
NODE_ENV - Environment (development/production)
DOMAIN - Frontend origin (default: http://localhost:5173)

See .env.example for all options.