https://github.com/riftlurker/open-screeps

:construction: reusable and tested building blocks for every screeps code base :construction:
https://github.com/riftlurker/open-screeps

ava lerna monorepo nyc screeps typescript

Last synced: 23 days ago
JSON representation

:construction: reusable and tested building blocks for every screeps code base :construction:

• Host: GitHub
• URL: https://github.com/riftlurker/open-screeps
• Owner: RiftLurker
• License: mit
• Created: 2017-12-20T11:30:08.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-03-12T09:23:09.000Z (almost 7 years ago)
• Last Synced: 2024-05-06T01:40:54.760Z (10 months ago)
• Topics: ava, lerna, monorepo, nyc, screeps, typescript
• Language: TypeScript
• Homepage:
• Size: 59.6 KB
• Stars: 23
• Watchers: 4
• Forks: 4
• Open Issues: 7
• Metadata Files:
  • Readme: readme.md
  • Contributing: contributing.md
  • License: license.md
  • Code of conduct: .github/code_of_conduct.md

Awesome Lists containing this project

README

        
# OpenScreeps

> reusable and tested building blocks for every [screeps][screeps-website] code base

This repository is a collection of useful snippets and methods that I came up with when programming for the game [screeps][screeps-website]. 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][screeps-website] 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][lerna-npm] for managing the monorepo and cross-dependencies

- [TypeScript][typescript-npm] for statically typed JavaScript

- [@types/screeps][@types/screeps-npm] for the screeps API type definitions

- [AVA][ava-npm] as the test runner

- [nyc][nyc-npm] for coverage reports

## Contributing

Check out our [Contributing Guidelines][contributing].

## License

[MIT][license]

[license]: ./license.md

[contributing]: ./contributing.md

[npm-website]: https://npmjs.org

[screeps-website]: https://screeps.com

[@types/screeps-npm]: https://npmjs.org/package/@types/screeps

[ava-npm]: https://npmjs.org/package/ava

[lerna-npm]: https://npmjs.org/package/lerna

[nyc-npm]: https://npmjs.org/package/nyc

[typescript-npm]: https://npmjs.org/package/typescript