Screeps Clockwork

Usage

This guide will assume you're using Rollup along the lines of the Screeps Typescript starter kit.

Set up dependencies:

``
npm install screeps-clockwork
npm install -D @rollup/plugin-wasm rollup-plugin-copy
`

Update your Rollup build script to copy the WASM binary to your dist folder:

`js
// add to existing dependencies
import wasm from '@rollup/plugin-wasm';
import copy from 'rollup-plugin-copy';

// ...

export default {
// ...
external: ['screeps_clockwork.wasm'],
plugins: [
clear({ targets: ['dist'] }),
wasm(),
copy({
targets: [
{
src: 'node_modules/screeps-clockwork/dist/screeps_clockwork.wasm',
dest: 'dist'
}
]
}),
// ...
screeps({ config: cfg, dryRun: cfg == null })
]
};
`

rollup-plugin-screeps will automatically push the wasm file out when it deploys.

Then, in your main loop, call the initialize function before running anything else:

`js
import { initialize } from 'screeps-clockwork';
export const loop = () => {
initialize();
// ...
};
`

Dev Setup

Dependencies to build and run the project:

`bash


Install Rust + Cargo via rustup

curl https://sh.rustup.rs -sSf | sh

Install wasm-pack

curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh

Add rust-src component

rustup component add rust-src --toolchain nightly-x86_64-unknown-linux-gnu

Set nightly as the default

rustup default nightly

Install nvm

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash

Install node

nvm install --lts
nvm use --lts
nvm alias default --lts # optional

install project dependencies

npm install
`

To build the project:

`bash
npm run build
`

To set up the local Screeps server, you'll need to have docker installed:

`bash
cp .env.sample .env # fill this out with the path to your Screeps .nw package and Steam key
cp screeps.sample.json screeps.json # optionally, override this to connect to your own local Screeps server
./reset-docker.sh
`

Once running, you can log in and spawn into the server with the local screeps-steamless-client.

- Username: clockwork
- Password: passw0rd

To deploy the test codebase, once the server is running:

`bash
npm run watch
`

Set up commitizen and pre-commit for conventional commits:

`bash


requires Python 3.8+


pip install --user -U commitizen pre-commit
pre-commit install
``