# screeps-modules

> Commit and retrieve modules from Screeps servers

Latest version **2.0.0** (published 2026-10-13) · MIT license · 12 weekly downloads

## Install

```sh
npm install screeps-modules
pnpm add screeps-modules
yarn add screeps-modules
bun add screeps-modules
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2026-10-13 |
| First published | 2016-11-13 |
| Weekly downloads | 12 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >= 24.0.0 |
| Dependencies | 1 |
| Unpacked size | 32.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 2 |
| Author | Filip Dupanović |
| Maintainers | malkron |
| Keywords | commit, fetch, modules, request, retrieve, screeps, scripts |

## Links

- npm: https://www.npmjs.com/package/screeps-modules
- Repository: https://github.com/langri-sha/screeps-modules
- Homepage: https://github.com/langri-sha/screeps-modules#readme
- Issues: https://github.com/langri-sha/screeps-modules/issues
- npm.io page: https://npm.io/package/screeps-modules

## Dependencies (1)

- [debug](https://npm.io/package/debug.md) ^4.0.0

## Recent versions

- 2.0.0 (latest) — 2026-10-13
- 1.2.0 — 2017-04-08
- 1.1.2 — 2016-11-19
- 1.1.1 — 2016-11-17
- 1.1.0 — 2016-11-17
- 1.0.2 — 2016-11-13
- 1.0.1 — 2016-11-13
- 1.0.0 — 2016-11-13

## README

# screeps-modules

[![CI][ci-badge]][ci] [![NPM][npm-badge]][npm] ![Node version][node-badge]

A thin client for committing/retrieving modules from a Screeps server, including
[private servers](http://support.screeps.com/hc/en-us/articles/213625765-Screeps-private-server-released-).
If you are using Webpack, see
[langri-sha/screeps-webpack-plugin](https://github.com/langri-sha/screeps-webpack-plugin).

The client uses the
[Screeps Web API](http://support.screeps.com/hc/en-us/articles/203022612-Committing-scripts-using-direct-API-access).
To authenticate, make sure you have an
[account password configured](https://screeps.com/a/#!/account), if you've
registered via Steam or GitHub. If you provide a token, it will be used instead
to authorize requests.

On private servers, make sure that you have the
[authorization mod](https://github.com/screepsmods/screepsmod-auth) installed
and an account created.

For something more comprehensive, check out
[screepers/node-sreeps-api](https://github.com/screepers/node-screeps-api).

# Install

```
npm install screeps-modules
```

The package requires Node.js 24 or later, and loads through both `import` and
`require()`:

```
import ScreepsModules from 'screeps-modules'
const ScreepsModules = require('screeps-modules')
```

## Usage

```
import ScreepsModules from 'screeps-modules'

const client = new ScreepsModules(options)
```

### Options

```
const client = new ScreepsModules({
  email: 'EMAIL',
  password: 'PASSWORD',
  token: 'TOKEN'
  serverUrl: 'https://screeps.com',
  serverPassword: 'SERVER_PASS',
  gzip: false
}
```

### `ScreepsModules#commit([branch,] modules): Object`

Commit modules to the provided branch, or to the one that's active in the world.

```
// Update branch 'sim'
await client.commit('sim', {
  main: 'module.exports = () => {console.log(Game.time)}'
})
// => {ok: 1}
// Update branch 'sim'

// Update the active world branch
await client.commit({
  main: 'module.exports = () => {console.log(Game.time)}'
})
// => {ok: 1}
```

### `ScreepsModules#fetch([branch])`

Retrieve scripts from the provided branch, or from the one that's active in the
world.

```
// Retrieve branch 'sim'
await client.retrieve('sim')
// => {main: 'module.exports = () => {console.log(Game.time)}'}

// Fetch active world branch
await client.retrieve()
// => Object
```

### `ScreepsModules#refreshToken()`

Updates the client token. Returns the token.

```
await client.refreshToken()
// => 'TOKEN'
```

## Troubleshooting

To avoid leaking sensitive information, the client only returns opaque responses
and is safe to use in CI. If you need to inspect the responses, start your
process with `DEBUG=screeps-modules node $ARGS`.

[ci]:
  https://github.com/langri-sha/screeps-modules/actions/workflows/workspace.yml
[ci-badge]:
  https://github.com/langri-sha/screeps-modules/actions/workflows/workspace.yml/badge.svg
[npm]: https://www.npmjs.com/package/screeps-modules
[npm-badge]: https://img.shields.io/npm/v/screeps-modules.svg
[node-badge]: https://img.shields.io/node/v/screeps-modules.svg

---
_Source: https://npm.io/package/screeps-modules · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._