How to Use


Follow these steps to synchronize your Agent interface with Night City.

1. Preparation & Installation

  • Ensure you have the Cyberpunk Red module installed in Foundry VTT.
  • Install the Cyberpunk Red Agent Bridge module in Foundry VTT by adding this manifest URL in the module installer:
    https://gitlab.com/surrealtech/Cyberpunk-Red-Agent-Bridge/-/raw/main/module.json
  • Sign up and log in to this app. Your personal data is only used for authentication.

2. GM Setup

  1. As the Game Master, navigate to the Settings page.
  2. Generate an API Key and copy it. This needs to be entered into the Agent Bridge module in Foundry.
  3. Copy your Channel ID from the Settings page.
  4. In Foundry, go to Configure Settings -> Agent Bridge and paste the Channel ID and API Key.
  5. Share this Channel ID with your players.

3. Player Setup

Players must link their accounts to the GM's session:

  1. Log in to this Agent app and navigate to Settings.
  2. Generate your own API Key and copy it. Enter this key into your Foundry account settings provided by the GM (as below).
  3. Paste the Channel ID provided by your GM into the Channel ID field and click Commit Sync.
  4. Within Foundry VTT, go to Configure Settings -> Agent Bridge and enter your individual API Key.

4. Character Assignment & Sync

  1. In Foundry VTT, the GM should open the Character Assignment menu (found in the Agent Bridge module).
  2. The GM assigns a playable character to each player who has linked their API key.
  3. Once assigned, the player's Agent Link (a long unique code) should appear in the menu. The players must be online for this to appear, so dont worry if it doesn't appear straight away.
  4. The player is now fully synced. Character data, stats, and rolls will flow between Foundry and the Agent interface in real-time.
Return