# grunt-screeps

> A Grunt plugin for committing code to your Screeps account

Latest version **1.5.0** (published 2020-11-25) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2020-11-25 |
| First published | 2015-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 0 |
| Unpacked size | 11.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 65 |
| Author | Artem Chivchalov |
| Maintainers | artch, screeps |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-screeps
- Repository: https://github.com/screeps/grunt-screeps
- Issues: https://github.com/screeps/grunt-screeps/issues
- npm.io page: https://npm.io/package/grunt-screeps

## Recent versions

- 1.5.0 (latest) — 2020-11-25
- 1.4.0 — 2017-12-25
- 1.3.0 — 2017-06-14
- 1.2.1 — 2016-05-17
- 1.2.0 — 2015-11-25
- 1.1.0 — 2015-07-31
- 1.0.3 — 2015-02-04
- 1.0.2 — 2015-02-03
- 1.0.1 — 2015-02-03
- 1.0.0 — 2015-02-03

## README

[![npm version](https://badge.fury.io/js/grunt-screeps.svg)](https://badge.fury.io/js/grunt-screeps)

# grunt-screeps

> A Grunt plugin for committing code to your [Screeps](https://screeps.com) account.

## Getting Started
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-screeps 
```

### Usage Example

**Gruntfile.js:**
```js
module.exports = function(grunt) {

    grunt.loadNpmTasks('grunt-screeps');

    grunt.initConfig({
        screeps: {
            options: {
                email: 'YOUR_EMAIL',
                token: 'AUTH_TOKEN',
                branch: 'default',
                // server: 'season'
            },
            dist: {
                files: [
                    {
                        expand: true,
                        cwd: 'dist/',
                        src: ['**/*.{js,wasm}'],
                        flatten: true
                    }
                ]
            }
        }
    });
}
```

Now you can run this command to commit your code from `dist` folder to your Screeps account:
```
grunt screeps
```

See more advanced usage examples in [this docs article](http://docs.screeps.com/contributed/advanced_grunt.html).

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