RetroAssembly Documentation

The project utilizes the following technologies across its layers:

• Frontend: React, React Router, Radix Themes, Tailwind CSS, Iconify, and Nostalgist.js.
• Backend: Hono, React Router, and Drizzle ORM.
• Infrastructure: Node.js or Cloudflare Workers, SQLite or Cloudflare D1, and Cloudflare R2.
• External Services: jsDelivr, Supabase Auth, and msleuth.

RetroAssembly is a browser-based retro game collection cabinet. You can use it via a hosted service or by self-hosting your own instance.

Option 1: Use the Official Hosted Version (Recommended)

Best for users who want to start playing immediately without technical setup.

1. Visit retroassembly.com.
2. Explore the library or try demo games.
3. Login and upload your own ROM files to create a personal library.
4. Select a game from your library to launch it in the browser.
5. Use the in-game menu to save and synchronize progress.

Option 2: Self-Host with Docker

Best for advanced users who want full control, privacy, or customization. Refer to the RetroAssembly Docker Hub page for deployment instructions.

To delete your account and all associated data from the Retro Assembly platform, you must submit a request via email to the platform administrators.

Email: theguidanceofawhitetower@gmail.com

If you discover a security issue in retroassembly, do not open a public issue. Instead, report the vulnerability via the GitHub Security Advisory tab to ensure a coordinated disclosure process.

https://github.com/arianrhodsandlot/retroassembly/security/advisories/new

Follow these steps to prepare your local environment for development. Ensure you have Node.js and pnpm installed, matching the versions specified in the project's package.json.

# 1. Install Node.js packages
pnpm i

# 2. Setup development environment
node --run=setup

# 3. Run development server
node --run=dev

When reporting bugs via GitHub issues, ensure you include the following information to help maintainers diagnose the problem:

• Expected vs. Actual Behavior: Describe what you expected to happen versus what actually occurred.
• Reproduction Steps: Provide the exact sequence of steps that lead to the issue.
• Environment Details: Include your OS and browser version if relevant.
• Evidence: Attach screenshots, screen recordings, or error logs.
• Consistency: Specify if the issue happens every time (consistently) or only occasionally (intermittently).

Users have the right to request access to, correction of, or deletion of their personal data. These requests should be directed to the contact email provided in the privacy policy.

Email: theguidanceofawhitetower@gmail.com

The API is prefixed with the base path api/v1. The application is composed of several routed modules:

• /api/v1/auth: Authentication routes.
• /api/v1/users: User management routes.
• /api/v1/*: Library routes (mounted at the root of the API version).

Errors are handled globally: HTTPException instances return a JSON object with the error message and the corresponding status code. All other unhandled errors return a 500 status code with a JSON error message.

You can deploy Retroassembly using a Docker Compose configuration. The service runs on port 8000 and requires a local directory mapped to /app/data for persistent storage.

Configuration Details:

• Image: arianrhodsandlot/retroassembly
• Ports: Maps host port 8000 to container port 8000.
• Volumes: Maps a local ./data directory to /app/data inside the container to ensure data persistence.
• Restart Policy: Set to unless-stopped to ensure the service restarts automatically unless manually stopped.

services:
  retroassembly:
    image: arianrhodsandlot/retroassembly
    ports: [8000:8000]
    volumes: [./data:/app/data]
    restart: unless-stopped

The future object allows you to opt-in to upcoming React Router features. Currently, this project enables unstable_optimizeDeps to improve dependency handling during development or build.

export default {
  future: {
    unstable_optimizeDeps: true,
  },
} satisfies Config;