OpenScreeps

reusable and tested building blocks for every screeps code base

This repository is a collection of useful snippets and methods that I came up with when programming for the game screeps. I'm now attempting to restructure my code and splitting it into reusable modules for everyone to enjoy, teaching myself how to work with unit tests and a monorepo in the progress.

Disclaimer

This is still heavily work in progress while I extract modules from my code and get used to different tools. The disclaimer will get removed once I've established a workflow and published the packages to npm.

Usage

Creating a functional and feature rich bot for screeps can be a tedious and time consuming process. This projects aims to provide a lot of single purpose modules to simplify and extend the provided game API and improve the way you write your code.

You can check the src/ directory for a list of created modules, the directory names are usually very good indicators of what the containing code does. Never the less each module has a readme file with a description of it's purpose and a short example.

Built with

• Lerna for managing the monorepo and cross-dependencies
• TypeScript for statically typed JavaScript
• @types/screeps for the screeps API type definitions
• AVA as the test runner
• nyc for coverage reports

Contributing

Check out our Contributing Guidelines.

License

MIT