Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Link

link, unlink, and relink connect the build output and game folders used during local development.

npm run cli -- link

What gets linked

LinkSourceDestination
Game linkconfigured game roottarget/game_link
Gamedata linktarget/gamedataconfigured game gamedata folder
Logs linkconfigured game logs foldertarget/logs_link

Game paths come from Steam detection or the fallback values in cli/config.json.

Commands

  • link: create the game, gamedata, and logs links.
  • unlink: remove the gamedata link, logs link, and game link.
  • relink: run unlink, then link.

link and relink support -f, --force to remove existing link targets first. Use it carefully: if a real game gamedata folder exists, --force removes it before creating the link.

Examples

npm run cli -- build --clean
npm run cli -- link
npm run cli -- relink --force
npm run cli -- unlink

Failure notes

If linking fails, verify the configured game path, executable name, and Steam installation detection. verify project checks the same paths.