AutoCR

AutoCR is a static web app for analyzing and reviewing data associated with RetroAchievements achievement sets, such as trigger logic for achievements, leaderboards, and rich presence.

Requirements

• Bun

Install

The first step is to install the dependencies:

bun install

Run locally

Dev run

To get a dev run with hot reload:

bun run dev

Build run

Build the project:

bun run build

Serve the built artifacts:

bun run start

Open http://localhost:8080.

Run the middleware locally

The middleware is a proxy server that logs in to RetroAchievements and gets achievement set data and code notes. To run it locally follow these steps.

First, copy middleware/.env.example to middleware/.env.local. Then, write your RetroAchievements credentials:

RA_USERNAME=your-ra-username
RA_PASSWORD=your-ra-password

Bun reads .env and .env.local automatically.

Then start the middleware:

cd middleware
bun install
bun start

The middleware runs at http://localhost:3000. To use it, change the middleware URL in js/overview.js to http://localhost:3000/pack/.

Local Checks

test/ exists, but for now, all testing is local fixtures. There are no automated checks for the time being.

Deployment

Commits to main automatically deploy the repo root to GitHub Pages.

The middleware currently deploys to Vercel. Changes to server.js do not currently trigger a redeploy.