This is a repository focused on automating the Developer-centric game called Screeps.
At the time of writing, it's very early on, and as such not all code is expected to work.
This project is based on Screeps Typescript Starter. Link.
Screeps Typescript Starter is a starting point for a Screeps AI written in Typescript. It provides everything you need to start writing your AI whilst leaving main.ts as empty as possible.
You will need:
- Node.JS (10.x)
- A Package Manager (Yarn or npm) Download the latest source here and extract it to a folder.
Open the folder in your terminal and run your package manager to install the required packages and TypeScript declaration files:
# npm
npm install
# yarn
yarnFire up your preferred editor with typescript installed and you are good to go!
Screeps Typescript Starter uses webpack to compile your typescript and upload it to a screeps server.
Move or copy screeps.sample.json to screeps.json and edit it, changing the credentials and optionally adding or removing some of the destinations.
Important! To upload code to a private server, you must have screepsmod-auth installed and configured!
The type definitions for Screeps come from typed-screeps. If you find a problem or have a suggestion, please open an issue there.
We've also spent some time reworking the documentation from the ground-up, which is now generated through Gitbooks. Includes all the essentials to get you up and running with Screeps AI development in TypeScript, as well as various other tips and tricks to further improve your development workflow.
Maintaining the docs will also become a more community-focused effort, which means you too, can take part in improving the docs for this starter kit.
To visit the docs, click here.
Issues, Pull Requests, and contribution to the docs are welcome! See our Contributing Guidelines for more details.