The Screeps Capture client connects to a Screeps World and displays interesting content by analyzing the warpath battle API.
This client was developed by AlinaNova21 for live streaming Screeps events such as BotArena and Screeps Warfare Championship on Twitch.
This fork was made in 2023 for live streaming the BotArena 214 event.
The Screeps Capture client is built with Electron and Vue on Node.js and uses the Screeps Renderer engine and APIs to display the Screeps World.
Before diving in, ensure you have the following installed:
- Node.js (LTS recommended)
- Clone the source code or download and extract it to your preferred directory.
- Navigate to the project folder using your terminal.
- Run
npm install
oryarn
to install the depdencencies.
- Rename or copy
.screeps.example.yml
to.screeps.yml
and update it with your Screeps credentials.
npm run start
- starts the app in Production modenpm run start:dev
- starts the app in Development mode with a dev console for debuggingnpm run start:log
- starts the app in Production mode and displays logs in the terminalnpm run start:nogpu
- starts the app in Production mode with GPU rendering disabled