Repository files navigation

This is a modern and clean project template for a new Screeps project inTypescript.

Features:

• Fast development environment withBun
• Linting withbiomejs (bun lint +bun format)
• Unit tests withscreeps-jest (bun run test)
• Code bundling usingrollup androllup-plugin-screeps

• Bun must be installed

To install dependencies:

$ bun install

To run linting:

$ bun lint

To auto format code (and write the changes):

$ bun format

To run tests:

(Note it's important to preload the setup script in./src/test/setup.ts tocreate globals like Game, Memory etc. from screeps-jest which is whybun run test is preferred overbun test here.)

$ bun runtest

To push to screeps:

1. First createscreeps.json with your screeps credentials.Seescreeps.sample.json for an example.
2. Runbun push-main to push to your main branch on screeps.com.

Alternatively runbun watch-main to watch for changes in your code as you editand push on demand.

Note: Althoughbun build runs significantly faster thantsc for a largecodebase, the build from bun is not currently able to target the slightlyold node runtime that Screeps runs on. For this reason we still use a vanillatsc compile step in the rollup script.