Files
MineGeo/docs/vercel-deployment.md

4.4 KiB

Deploy MineGeo

Optional Discord map and multiplayer-party announcements use DISCORD_BOT_TOKEN, DISCORD_MAPS_CHANNEL_ID, and DISCORD_PARTIES_CHANNEL_ID. All published parties use the same configured channel. Follow Discord bot setup for creation, permissions, Vercel variables, and retries. Apply the Discord queue migration before deploying this feature; the bot token stays server-only.

Optional community buttons appear in the footer when MINEGEO_DISCORD_URL or MINEGEO_TELEGRAM_URL is configured. Set these public links in .env.local for local development (ordinary .env also works). Restart the local server after changing a link. For the hosted site, add the same names as Production Config variables in the MineGeo Vercel project, then redeploy. These values are public destinations; no Discord bot token or Telegram API key is needed.

Discord accepts HTTPS links on discord.gg, discord.com, www.discord.com, and discordapp.com. Telegram accepts t.me and telegram.me, including group invite links. Blank, malformed, or unsupported URLs hide the corresponding button. Each button opens its configured destination in a new tab.

Run npm run deploy from the project directory. The script collects all web source files and public assets, uploads them in one request, waits for the build, and prints the deployment URL. It uses the Vercel deployments API. The database credentials already configured in Vercel remain there. Mod captures are processed by the deployed Vercel API: upload finalization starts background image processing with Next.js after, and the authenticated dashboard resumes queued or expired jobs. The function has a 300-second limit and uses the existing Supabase queue, Storage buckets, retry count, and completion transaction. It processes one PNG at a time in memory, so it needs no local capture directory or running Minecraft client.

Plugin terrain exports still require the standalone Minecraft rendering worker on its current host. That renderer builds panoramas with Chromium and vanilla Minecraft assets; it is separate from the deployed mod-image processor.

The script excludes Git metadata, local environment files, caches, generated captures, tests, Java build sources, and development tools. It checks uploaded content, including the downloadable JARs, for references to the Git server. Nothing is pushed to Gitea or connected to a Git provider.

Authentication is needed once: run vercel login, or put a Vercel token in the ignored .env.deploy.local file as VERCEL_TOKEN=.... The Codex Vercel plugin's login does not sign the local script in. Tokens are never included in the upload or command output.

Useful options:

  • npm run deploy -- --dry-run: inspect file count and the privacy check without uploading.
  • npm run deploy -- --preview: create a preview deployment.
  • npm run deploy -- --help: show usage.

Vercel Web Analytics is included in the root layout through @vercel/analytics/next, so page views and client-side navigation are tracked across the site. Enable Web Analytics in the MineGeo project's Analytics tab before deploying. After deployment, visit the site and navigate between pages to verify collection. Content blockers can prevent analytics requests.

Analytics uses the existing Vercel project and requires no Git connection or additional Supabase credentials.

Multiplayer uses the Supabase migration described in multiplayer.md. Apply that migration to a new database before deploying the multiplayer web files. Room chat also requires 20261007155622_multiplayer_chat.sql before the web update.

Map ZIP sharing requires 20261007145000_map_sharing.sql. Imported maps stay private and can be played without moderation; publication is blocked. See map-sharing.md for the archive format and verification.

The script targets the existing MineGeo project. Set VERCEL_PROJECT_ID and VERCEL_ORG_ID to deploy a copy to another Vercel project.

Player bug reporting requires 20261008071054_bug_reports.sql and the Linear server credentials described in bug-reports.md. Configure the Comment webhook before deploying so staff replies and glow commands reach players. Glow colors and user prefixes also require 20261008075322_profile_identity.sql before deploying the updated account, catalog, and multiplayer pages.