Skip to content

Website, UCP and ACP ​

web-platform/web/ is one Next.js application containing your community’s public website, the player UCP and the staff ACP. It shares the game database. The separate OpenRP Framework project website is not part of this runtime.

Local installation ​

Inside web-platform/web/:

sh
npm ci

Copy .env.example to .env.local. Set DATABASE_URL, a generated AUTH_SECRET, AUTH_URL, your SMTP details and the agent connection. The environment reference provides full examples and downloads.

sh
npm run db:generate
npm run dev

Open http://localhost:3000. Configure the first administrator, verify email and create your character.

Production build ​

sh
npm run db:check
npm test
npm run build
npm start

npm run build creates Next.js standalone output and copies its public/static assets. npm start runs the supplied launcher, which loads .env.local and starts that output. Avoid substituting next start for this standalone configuration.

The launcher uses WEB_BIND=127.0.0.1 and port 3000 by default. Use PORT to change the port. An HTTPS reverse proxy should handle public access. On Windows, stop the standalone server before rebuilding, because its working directory is inside the generated output.

Brand the public template ​

Edit lib/site-config.ts for the community name, description, public URL, connect address, optional links, logo, hero image, rules, terms, privacy information and updates. These fields are public; never put secrets there.

The default hero image and department badges are in public/img/. The common favicon/logo is public/favicon.png. Rebuild after changing source or public assets in an immutable deployment.

URLs and access ​

PathPurpose
/Public community website
/ucp/loginAccount sign-in
/ucp/registerNew account registration
/ucpSigned-in player dashboard
/ucp/account/settingsEmail, password and web 2FA settings
/acpStaff dashboard, Junior level and above

Staff levels are read from the database when protecting ACP operations. Membership in a faction does not grant ACP access. Character/faction UCP pages check ownership and relevant faction permissions.

Set AUTH_URL to the exact public HTTPS origin, without a path or trailing slash. Use that hostname when testing login. Configure your proxy to preserve the correct host and protocol and prevent untrusted clients from bypassing it. Production authentication uses secure cookies; plain HTTP is for local development.

Mail links use your configured site origin. A public server with AUTH_URL=http://localhost:3000 sends recipients links to their own machine. Test a verification and password-reset message from an external browser before launch.

What is optional? ​

Discord login, external voice and custom skin uploads are off by default. No API, channel, guild or role credentials are supplied. Keep them disabled until you configure services you own. Core account login and ACP functionality do not need the optional Fastify API.

Open-source roleplay foundations for open.mp. Bring your own world.