Pandipipas 41e4e91c4b feat: enhance NodeCG runtime management and packaging
- Update .gitignore and .prettierignore to exclude additional cache and configuration files.
- Revise README.md for clarity on build processes and runtime behavior.
- Improve architecture documentation to reflect changes in startup flow and module responsibilities.
- Modify troubleshooting guide to address common runtime issues and installation steps.
- Enhance ESLint configuration to ignore more directories.
- Update package.json scripts for better build and distribution processes.
- Introduce build-scoreko-bundle.mjs for building the Scoreko bundle.
- Implement prepare-nodecg-runtime.mjs for managing NodeCG runtime installation and updates.
- Add runtime-provisioner.ts to handle user-specific NodeCG runtime provisioning.
- Create tests for runtime provisioning to ensure correct behavior.
- Refactor process-manager.ts and main.ts to integrate new runtime management logic.
2026-05-09 17:45:36 +02:00
2026-02-15 20:40:35 +01:00
END
2026-02-25 20:27:12 +01:00

scoreko-electron

Windows desktop installer for Scoreko. The packaged app includes Electron, NodeCG, the compiled scoreko-dev bundle, and the production modules needed to run it, so end users do not need Node.js, pnpm, or a cloned repository.

Build on a development machine

From the repository root:

pnpm install

Then from scoreko-electron-dev:

npm install
npm run dist:win

The installer is written to scoreko-electron-dev/release/Scoreko-setup-0.1.0.exe.

What the build does

  • Builds the parent scoreko-dev bundle with pnpm build.
  • Creates scoreko-electron-dev/lib/nodecg with a small NodeCG runtime.
  • Installs production runtime modules into that runtime.
  • Rebuilds better-sqlite3 for Electron before creating the installer.
  • Packages the runtime as an Electron extra resource outside the app archive.

Runtime behavior

On first launch, Scoreko copies the packaged NodeCG runtime to the user's app data folder and runs it from there. This keeps cfg, db, and logs writable on Windows even when the app is installed under Program Files.

Useful scripts

  • npm run start: build everything and run Electron locally.
  • npm run prepare:runtime: recreate lib/nodecg from the parent bundle.
  • npm run rebuild:native: rebuild NodeCG native modules for Electron.
  • npm run dist:win: create the Windows installer.
  • npm run doctor: check the prepared runtime and the configured port.

Configuration

The defaults match the parent bundle:

  • NODECG_BUNDLE_NAME=scoreko-dev
  • NODECG_PORT=9090
  • SCOREKO_DASHBOARD_ROUTE=dashboard/scoreko-dev/main.html?standalone=true
  • SCOREKO_LOADING_ROUTE=dashboard/loading/main.html?standalone=true

Copy .env.example only if you need local overrides while developing.

S
Description
No description provided
Readme 1.1 MiB
Languages
TypeScript 82.4%
JavaScript 11%
HTML 4.7%
NSIS 1.9%