Screeps

https://docs.screeps.com/
Admin
Screeps is a massively multiplayer online real-time strategy game where players write JavaScript...
Tokens:129,876
Snippets:1,220
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Setup Screeps Server Environment

Source: https://docs.screeps.com/contributed/ps_ubuntu.html

Initializes the Screeps server environment by creating a directory, installing the Screeps package, and running the initialization command.

```bash
mkdir ~/world
```

```bash
cd ~/world
```

```bash
npm install screeps
```

```bash
npx screeps init
```

--------------------------------

### Install Build Tools

Source: https://docs.screeps.com/contributed/ps_ubuntu.html

Installs essential build and development tools required for the Screeps server setup on Ubuntu.

```bash
sudo apt install -y build-essential tcl git
```

--------------------------------

### Install MongoDB

Source: https://docs.screeps.com/contributed/ps_ubuntu.html

Installs the MongoDB server package after configuring its apt repository.

```bash
sudo apt-get install -y mongodb-org
```

--------------------------------

### Start and Enable MongoDB Service

Source: https://docs.screeps.com/contributed/ps_ubuntu.html

Starts the MongoDB service and configures it to launch automatically on system boot.

```bash
sudo systemctl start mongod
```

```bash
sudo systemctl enable mongod
```

--------------------------------

### Install Redis Server

Source: https://docs.screeps.com/contributed/ps_ubuntu.html

Installs the Redis server using a PPA, which provides a more up-to-date version than the default Ubuntu repositories.

```bash
sudo apt install software-properties-common
```

```bash
sudo add-apt-repository ppa:chris-lea/redis-server
```

```bash
sudo apt update
```

```bash
sudo apt install redis-server
```

--------------------------------

### Install time-grunt

Source: https://docs.screeps.com/contributed/advanced_grunt.html

Install the time-grunt plugin to get a breakdown of the time spent on each Grunt task during execution.

```bash
npm install time-grunt --save-dev
```

--------------------------------

### Store Methods

Source: https://docs.screeps.com/api

Provides information and examples for interacting with the Store object, including methods to get capacity, free capacity, and used capacity for resources.

```APIDOC
## Store Methods

### `getCapacity([resource])`

Returns capacity of this store for the specified resource. For a general purpose store, it returns total capacity if `resource` is undefined.

#### Parameters
- `resource` (string, optional) - The type of the resource.

#### Return value
Returns capacity number, or `null` in case of an invalid `resource` for this store type.

### `getFreeCapacity([resource])`

Returns free capacity for the store. For a limited store, it returns the capacity available for the specified resource if `resource` is defined and valid for this store.

#### Parameters
- `resource` (string, optional) - The type of the resource.

#### Return value
Returns available capacity number, or `null` in case of an invalid `resource` for this store type.

### `getUsedCapacity([resource])`

Returns the capacity used by the specified resource. For a general purpose store, it returns total used capacity if `resource` is undefined.

#### Parameters
- `resource` (string, optional) - The type of the resource.

#### Return value
Returns used capacity number, or `null` in case of a not valid `resource` for this store type.
```

--------------------------------

### Example Market Orders Output

Source: https://docs.screeps.com/api

An example of the structure of the orders array returned by Game.market.getAllOrders.

```json
[
    {
        id : "55c34a6b5be41a0a6e80c68b",
        created : 13131117,
        type : "sell",
        resourceType : "OH",
        roomName : "W1N1",
        amount : 15821,
        remainingAmount : 30000,
        price : 2.95
    }, {
        createdTimestamp: 1543253147522,
        type: "sell",
        amount: 1000,
        remainingAmount: 1000,
        resourceType: "O",
        price: 1,
        roomName: "E2S7",
        created: 12010056,
        id: "5bfc2c9bd719fb605037c06d"
    }, {
        id : "55c34a6b5be41a0a6e80c123",
        createdTimestamp: 1543253155580,
        type : "sell",
        resourceType : "token",
        amount : 3,
        remainingAmount : 10,
        price : 50000
    }
]
```

--------------------------------

### Install grunt-rsync

Source: https://docs.screeps.com/contributed/advanced_grunt.html

Install the grunt-rsync plugin to facilitate code uploads to a private server via the Steam client.

```bash
npm install grunt-rsync --save-dev
```

--------------------------------

### Install grunt-screeps

Source: https://docs.screeps.com/commit.html

Install the grunt-screeps plugin using npm. This is the first step to using Grunt for committing scripts.

```bash
npm install grunt-screeps
```

--------------------------------

### Install Node.js 8.x

Source: https://docs.screeps.com/contributed/ps_ubuntu.html

Installs Node.js version 8.x from the NodeSource apt repository, as Ubuntu's default version is older.

```bash
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
```

```bash
sudo apt install -y nodejs
```

--------------------------------

### Start Screeps Server Manually

Source: https://docs.screeps.com/contributed/ps_ubuntu.html

Starts the Screeps server manually from the command line. This is a prerequisite for initializing the database. Ensure you are in the '~/world' directory and running as the 'screeps' user.

```bash
cd ~/world
npx screeps start
```

--------------------------------

### Install grunt-jsbeautifier

Source: https://docs.screeps.com/contributed/advanced_grunt.html

Install the grunt-jsbeautifier plugin to help maintain code style consistency.

```bash
npm install grunt-jsbeautifier --save-dev
```

--------------------------------

### Incoming Transactions Example

Source: https://docs.screeps.com/api

An example of the structure for incoming market transactions. This array contains the last 100 transactions to your terminals.

```javascript
[
    {
        transactionId : "56dec546a180ce641dd65960",
        time : 10390687,
        sender : {username: "Sender"},
        recipient : {username: "Me"},
        resourceType : "U",
        amount : 100,
        from : "W0N0",
        to : "W10N10",
        description : "trade contract #1",
        order: {        // optional
            id : "55c34a6b5be41a0a6e80c68b",
            type : "sell",
            price : 2.95
        }
    }
]
```

--------------------------------

### Install Screeps Server Mods

Source: https://docs.screeps.com/contributed/ps_ubuntu.html

Installs all necessary server mods using npm. Ensure you are running this command as the 'screeps' user.

```bash
npm install screepsmod-mongo screepsmod-auth screepsmod-tickrate screepsmod-admin-utils screepsmod-features
```

--------------------------------

### Install Grunt Plugins for Copy and Clean

Source: https://docs.screeps.com/contributed/advanced_grunt.html

Install the necessary Grunt plugins for file manipulation. These are required for managing your Screeps build process.

```bash
npm install grunt-contrib-clean --save-dev
npm install grunt-contrib-copy --save-dev
```

--------------------------------

### Install Grunt File Append Plugin

Source: https://docs.screeps.com/contributed/advanced_grunt.html

Install the grunt-file-append plugin to add content to files during the build process. This is used for versioning.

```bash
npm install grunt-file-append --save-dev
```

--------------------------------

### Configure MongoDB Apt Repository

Source: https://docs.screeps.com/contributed/ps_ubuntu.html

Adds the MongoDB official apt repository to ensure an up-to-date version is installed.

```bash
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 2930ADAE8CAF5059EE73BB4B58712A2291FA4AD5
```

```bash
echo "deb http://repo.mongodb.org/apt/ubuntu xenial/mongodb-org/3.6 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-3.6.list
```

```bash
sudo apt update
```

--------------------------------

### Find Optimal Path with Custom Costs

Source: https://docs.screeps.com/api

This example demonstrates how to find an optimal path for a creep, customizing costs for roads, swamps, and non-walkable structures. It also avoids other creeps and favors roads.

```javascript
  let creep = Game.creeps.John;

  let goals = _.map(creep.room.find(FIND_SOURCES), function(source) {
    // We can't actually walk on sources-- set `range` to 1 
    // so we path next to it.
    return { pos: source.pos, range: 1 };
  });

  let ret = PathFinder.search(
    creep.pos, goals,
    {
      // We need to set the defaults costs higher so that we
      // can set the road cost lower in `roomCallback`
      plainCost: 2,
      swampCost: 10,

      roomCallback: function(roomName) {

        let room = Game.rooms[roomName];
        // In this example `room` will always exist, but since 
        // PathFinder supports searches which span multiple rooms 
        // you should be careful!
        if (!room) return;
        let costs = new PathFinder.CostMatrix;

        room.find(FIND_STRUCTURES).forEach(function(struct) {
          if (struct.structureType === STRUCTURE_ROAD) {
            // Favor roads over plain tiles
            costs.set(struct.pos.x, struct.pos.y, 1);
          } else if (struct.structureType !== STRUCTURE_CONTAINER &&
                     (struct.structureType !== STRUCTURE_RAMPART ||
                      !struct.my)) {
            // Can't walk through non-walkable buildings
            costs.set(struct.pos.x, struct.pos.y, 0xff);
          }
        });

        // Avoid creeps in the room
        room.find(FIND_CREEPS).forEach(function(creep) {
          costs.set(creep.pos.x, creep.pos.y, 0xff);
        });

        return costs;
      },
    }
  );

  let pos = ret.path[0];
  creep.move(creep.pos.getDirectionTo(pos));
```

--------------------------------

### Checking and Creating a Creep

Source: https://docs.screeps.com/api

This example demonstrates how to check if a creep can be created using `canCreateCreep` before attempting to create it with `createCreep`. This prevents errors related to insufficient energy or other spawn constraints.

```javascript
if(spawn.canCreateCreep(body, name) == OK) {
    spawn.createCreep(body, name);
}
```

--------------------------------

### Full Gruntfile.js Example for Screeps

Source: https://docs.screeps.com/contributed/advanced_grunt.html

This Gruntfile configures tasks for cleaning, copying, versioning, and deploying Screeps game code. It supports deployment to the official servers or a private server.

```javascript
module.exports = function (grunt) {
  require('time-grunt')(grunt);

  // Pull defaults (including username and password) from .screeps.json
  var config = require('./.screeps.json')

  // Allow grunt options to override default configuration
  var branch = grunt.option('branch') || config.branch;
  var email = grunt.option('email') || config.email;
  var password = grunt.option('password') || config.password;
  var ptr = grunt.option('ptr') ? true : config.ptr
  var private_directory = grunt.option('private_directory') || config.private_directory;


  var currentdate = new Date();
  grunt.log.subhead('Task Start: ' + currentdate.toLocaleString())
  grunt.log.writeln('Branch: ' + branch)

  // Load needed tasks
  grunt.loadNpmTasks('grunt-screeps')
  grunt.loadNpmTasks('grunt-contrib-clean')
  grunt.loadNpmTasks('grunt-contrib-copy')
  grunt.loadNpmTasks('grunt-file-append')
  grunt.loadNpmTasks("grunt-jsbeautifier")
  grunt.loadNpmTasks("grunt-rsync")

  grunt.initConfig({

    // Push all files in the dist folder to screeps. What is in the dist folder
    // and gets sent will depend on the tasks used.
    screeps: {
      options: {
        email: email,
        password: password,
        branch: branch,
        ptr: ptr
      },
      dist: {
        src: ['dist/*.js']
      }
    },


    // Copy all source files into the dist folder, flattening the folder
    // structure by converting path delimiters to underscores
    copy: {
      // Pushes the game code to the dist folder so it can be modified before
      // being send to the screeps server.
      screeps: {
        files: [{
          expand: true,
          cwd: 'src/',
          src: '**',
          dest: 'dist/',
          filter: 'isFile',
          rename: function (dest, src) {
            // Change the path name utilize underscores for folders
            return dest + src.replace(/\//g,'_');
          }
        }],
      }
    },


    // Copy files to the folder the client uses to sink to the private server.
    // Use rsync so the client only uploads the changed files.
    rsync: {
        options: {
            args: ["--verbose", "--checksum"],
            exclude: [".git*"],
            recursive: true
        },
        private: {
            options: {
                src: './dist/',
                dest: private_directory,
            }
        },
    },


    // Add version variable using current timestamp.
    file_append: {
      versioning: {
        files: [
          {
            append: "\nglobal.SCRIPT_VERSION = "+ currentdate.getTime() + "\n",
            input: 'dist/version.js',
          }
        ]
      }
    },


    // Remove all files from the dist folder.
    clean: {
      'dist': ['dist']
    },


    // Apply code styling
    jsbeautifier: {
      modify: {
        src: ["src/**/*.js"],
        options: {
          config: '.jsbeautifyrc'
        }
      },
      verify: {
        src: ["src/**/*.js"],
        options: {
          mode: 'VERIFY_ONLY',
          config: '.jsbeautifyrc'
        }
      }
    }

  })

  // Combine the above into a default task
  grunt.registerTask('default',  ['clean', 'copy:screeps',  'file_append:versioning', 'screeps']);
  grunt.registerTask('private',  ['clean', 'copy:screeps',  'file_append:versioning', 'rsync:private']);
  grunt.registerTask('test',     ['jsbeautifier:verify']);
  grunt.registerTask('pretty',   ['jsbeautifier:modify']);
}
```

--------------------------------

### Install Screeps PTR Version Locally

Source: https://docs.screeps.com/ptr.html

Use this command to install the PTR version of the Screeps private server package locally. This allows you to run the engine code changes from the PTR on your own machine.

```bash
npm install screeps@ptr
```

--------------------------------

### Example Response from Screeps API

Source: https://docs.screeps.com/commit.html

This is an example of a successful response from the Screeps API after committing code. It indicates the operation was successful with 'ok': 1.

```http
X-Powered-By: Express
Content-Type: application/json; charset=utf-8
Content-Length: 8
Date: Mon, 02 Feb 2015 18:46:11 GMT
Connection: close

{"ok":1}
```

--------------------------------

### C Function for WebAssembly

Source: https://docs.screeps.com/modules.html

Write a simple C function that will be compiled into a WebAssembly binary module. This example defines a function to add two integers.

```c
int addTwo(int a, int b) {
    return a + b;
}
```

--------------------------------

### createCreep

Source: https://docs.screeps.com/api

Deprecated method to start the creep spawning process. It takes the creep's body, an optional name, and optional memory. Energy is drawn from spawns and extensions in the room. Returns the creep name on success or an error code.

```APIDOC
## createCreep(body, [name], [memory])

### Description
Deprecated method to start the creep spawning process. It takes the creep's body, an optional name, and optional memory. Energy is drawn from spawns and extensions in the room. Returns the creep name on success or an error code.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **body** (array<string>) - Required - An array describing the new creep’s body. Should contain 1 to 50 elements with one of the following constants: WORK, MOVE, CARRY, ATTACK, RANGED_ATTACK, HEAL, TOUGH, CLAIM.
- **name** (string) - Optional - The name of a new creep. The name length limit is 100 characters. It should be unique. If not defined, a random name will be generated.
- **memory** (any) - Optional - The memory of a new creep. If provided, it will be immediately stored into `Memory.creeps[name]`.

### Request Example
```javascript
Game.spawns['Spawn1'].createCreep([WORK, CARRY, MOVE], 'Worker1');
```
```javascript
Game.spawns['Spawn1'].createCreep([WORK, CARRY, MOVE], null, 
    {role: 'harvester'});
```
```javascript
const result = Game.spawns['Spawn1'].createCreep([WORK, CARRY, MOVE]);

if(_.isString(result)) {
    console.log('The name is: '+result);
}
else {
    console.log('Spawn error: '+result);
}
```

### Response
#### Success Response (string)
- **name** (string) - The name of the newly created creep.

#### Error Response (constant)
- **ERR_NOT_OWNER** (-1) - You are not the owner of this spawn.
- **ERR_NAME_EXISTS** (-3) - There is a creep with the same name already.
- **ERR_BUSY** (-4) - The spawn is already in process of spawning another creep.
- **ERR_NOT_ENOUGH_ENERGY** (-6) - The spawn and its extensions contain not enough energy to create a creep with the given body.
- **ERR_INVALID_ARGS** (-10) - Body is not properly described.
- **ERR_RCL_NOT_ENOUGH** (-14) - Your Room Controller level is insufficient to use this spawn.
```

--------------------------------

### spawnCreep

Source: https://docs.screeps.com/api

Starts the creep spawning process. Energy can be withdrawn from all spawns and extensions in the room. Requires creep body and name, with optional spawning options. Returns OK on success or an error code.

```APIDOC
## spawnCreep(body, name, [opts])

### Description
Starts the creep spawning process. Energy can be withdrawn from all spawns and extensions in the room. Requires creep body and name, with optional spawning options. Returns OK on success or an error code.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **body** (array<string>) - Required - An array describing the new creep’s body. Should contain 1 to 50 elements with one of the following constants: WORK, MOVE, CARRY, ATTACK, RANGED_ATTACK, HEAL, TOUGH, CLAIM.
- **name** (string) - Required - The name of a new creep. The name length limit is 100 characters. It must be a unique creep name.
- **opts** (object) - Optional - An object with additional options for the spawning process:
  - **memory** (any) - Memory of the new creep.
  - **energyStructures** (array) - Array of spawns/extensions from which to draw energy.
  - **dryRun** (boolean) - If true, only checks if it is possible to create a creep.
  - **directions** (array) - Set desired directions where the creep should move when spawned.

### Request Example
```javascript
Game.spawns['Spawn1'].spawnCreep([WORK, CARRY, MOVE], 'Worker1');
```
```javascript
Game.spawns['Spawn1'].spawnCreep([WORK, CARRY, MOVE], 'Worker1', {
    memory: {role: 'harvester'}
});
```
```javascript
Game.spawns['Spawn1'].spawnCreep([WORK, CARRY, MOVE], 'Worker1', {
    energyStructures: [
        Game.spawns['Spawn1'], 
        Game.getObjectById('anExtensionId')
    ]
});
```
```javascript
var testIfCanSpawn = Game.spawns['Spawn1'].spawnCreep([WORK, CARRY, MOVE], 
    'Worker1', { dryRun: true });
```

### Response
#### Success Response (number)
- **OK** (0) - The operation has been scheduled successfully.

#### Error Response (constant)
- **ERR_NOT_OWNER** (-1) - You are not the owner of this spawn.
- **ERR_NAME_EXISTS** (-3) - There is a creep with the same name already.
- **ERR_BUSY** (-4) - The spawn is already in process of spawning another creep.
- **ERR_NOT_ENOUGH_ENERGY** (-6) - The spawn and its extensions contain not enough energy to create a creep with the given body.
- **ERR_INVALID_ARGS** (-10) - Body is not properly described or name was not provided.
- **ERR_RCL_NOT_ENOUGH** (-14) - Your Room Controller level is insufficient to use this spawn.
```

--------------------------------

### Get All Objects at a Position

Source: https://docs.screeps.com/api

The `look()` method returns an array of all objects present at a specific room position. This is useful for inspecting the contents of a tile.

```javascript
const look = Game.flags.Flag1.pos.look();
look.forEach(function(lookObject) {
    if(lookObject.type == LOOK_CREEPS &&
       lookObject[LOOK_CREEPS].getActiveBodyparts(ATTACK) == 0) {
        creep.moveTo(lookObject.creep);
    }
});
```

--------------------------------

### Initialize Screeps Database via CLI

Source: https://docs.screeps.com/contributed/ps_ubuntu.html

Resets all data for the Screeps server using the CLI tool. This command should be run in a separate terminal after starting the server manually. You will need to exit the 'screeps' user session afterwards.

```bash
sudo su screeps
cd ~/world
npx screeps cli
> system.resetAllData()
```

--------------------------------

### Basic Module Loading with Require

Source: https://docs.screeps.com/contributed/caching-overview.html

Demonstrates the standard way to load modules using `require` in the global scope, which is cached by default.

```javascript
var mod = require('mod');

module.exports.loop = function() {
    // executed every tick
    mod.foo();
}
```

--------------------------------

### Reload Systemd Daemon and Start Screeps Service

Source: https://docs.screeps.com/contributed/ps_ubuntu.html

Reloads the systemd manager configuration to recognize the new service file and then starts the Screeps server service. It also enables the service to start automatically on system boot.

```bash
sudo systemctl daemon-reload
sudo systemctl start screeps-world
sudo systemctl enable screeps-world
```

--------------------------------

### Mineral Reaction in Labs

Source: https://docs.screeps.com/resources.html

Demonstrates how to initiate a mineral reaction using two reagent labs and a collector lab. The reaction produces a mineral compound, and the types of minerals present in the labs after the reaction are logged.

```javascript
var labs = room.find(FIND_MY_STRUCTURES, 
    {filter: {structureType: STRUCTURE_LAB}});

labs[0].runReaction(labs[1], labs[2]);

// on the next tick...

console.log(labs[0].mineralType) // -> OH
console.log(labs[1].mineralType) // -> O
console.log(labs[2].mineralType) // -> H
```

--------------------------------

### Outgoing Transactions Example

Source: https://docs.screeps.com/api

An example of the structure for outgoing market transactions. This array contains the last 100 transactions from your terminals.

```javascript
[
    {
        transactionId : "56dec546a180ce641dd65960",
        time : 10390687,
        sender : {username: "Me"},
        recipient : {username: "Recipient"},
        resourceType : "U",
        amount : 100,
        from : "W0N0",
        to : "W10N10",
        description : "trade contract #1",
        order: {        // optional
            id : "55c34a6b5be41a0a6e80c68b",
            type : "sell",
            price : 2.95
        }
    }
]
```

--------------------------------

### Get Terrain at Position (Deprecated)

Source: https://docs.screeps.com/api

Gets the terrain type at a specified room position. This method is deprecated; use Game.map.getRoomTerrain instead.

```javascript
console.log(Game.map.getTerrainAt(25,20,'W10N10'));
```

```javascript
console.log(Game.map.getTerrainAt(new RoomPosition(25,20,'W10N10')));
```

--------------------------------

### Create RoomVisual Object

Source: https://docs.screeps.com/api

Instantiate a `RoomVisual` object to draw on a specific room or all rooms. Visuals persist for one tick and are only visible to you.

```javascript
Game.rooms['W10N10'].visual.circle(10,20).line(0,0,10,20);
// the same as:
new RoomVisual('W10N10').circle(10,20).line(0,0,10,20);
```

```javascript
// this text will be displayed in all rooms
new RoomVisual().text('Some text', 1, 1, {align: 'left'});
```

--------------------------------

### Create a Sell Order

Source: https://docs.screeps.com/api

Use this to create a sell order for a specific resource. You will be charged a fee based on the price and amount. Ensure you have sufficient credits and the resource in your terminal.

```javascript
Game.market.createOrder({
    type: ORDER_SELL,
    resourceType: RESOURCE_GHODIUM,
    price: 9.95,
    totalAmount: 10000,
    roomName: "W1N1"
});
```

--------------------------------

### Example POST Request to Screeps API

Source: https://docs.screeps.com/commit.html

This is an example of the HTTP POST request sent to the Screeps API endpoint for committing code. It includes headers and the JSON payload.

```http
POST /api/user/code HTTP/1.1
Content-Type: application/json; charset=utf-8
Host: screeps.com:443
Authorization: Basic PHlvdXIgZS1tYWlsPjo8eW91ciBwYXNzd29yZD4=
Connection: close
Transfer-Encoding: chunked

{"branch":"default","modules":{"main":"require(\"hello\");","hello":"console.log(\"Hello World!\");"}}
```

--------------------------------

### Spawn Methods

Source: https://docs.screeps.com/api

Details on methods available for StructureSpawn, including checking creep creation feasibility.

```APIDOC
## canCreateCreep(body, [name])

### Description
Check if a creep can be created. This method is deprecated and will be removed soon. Please use `StructureSpawn.spawnCreep` with `dryRun` flag instead.

### Parameters
#### Parameters
- **body** (array<string>) - An array describing the new creep’s body. Should contain 1 to 50 elements with one of these constants: `WORK`, `MOVE`, `CARRY`, `ATTACK`, `RANGED_ATTACK`, `HEAL`, `TOUGH`, `CLAIM`.
- **name** (string, optional) - The name of a new creep. The name length limit is 100 characters. It should be unique creep name, i.e. the `Game.creeps` object should not contain another creep with the same name (hash key). If not defined, a random name will be generated.

### Return value
One of the following codes:
constant| value| description
---|---|---
`OK`| 0| A creep with the given body and name can be created.
`ERR_NOT_OWNER`| -1| You are not the owner of this spawn.
`ERR_NAME_EXISTS`| -3| There is a creep with the same name already.
`ERR_BUSY`| -4| The spawn is already in process of spawning another creep.
`ERR_NOT_ENOUGH_ENERGY`| -6| The spawn and its extensions contain not enough energy to create a creep with the given body.
`ERR_INVALID_ARGS`| -10| Body is not properly described.
`ERR_RCL_NOT_ENOUGH`| -14| Your Room Controller level is insufficient to use this spawn.
```

--------------------------------

### Get Room Terrain Data

Source: https://docs.screeps.com/api

Retrieves a Room.Terrain object for fast access to static terrain data in any room. Use the get() method to check terrain at specific coordinates.

```javascript
const terrain = Game.map.getRoomTerrain("E2S7");
switch(terrain.get(10,15)) {
    case TERRAIN_MASK_WALL:
        break;
    case TERRAIN_MASK_SWAMP:
        break;
    case 0:
        break;
}
```

--------------------------------

### RoomVisual constructor

Source: https://docs.screeps.com/api

Initializes a RoomVisual object for drawing debug information in a specified room. If no room name is provided, visuals are posted to all rooms.

```APIDOC
## constructor([roomName])

### Description
You can directly create new `RoomVisual` object in any room, even if it's invisible to your script.

### Parameters
#### Path Parameters
- **roomName** (string) - Optional - The room name. If undefined, visuals will be posted to all rooms simultaneously.
```

--------------------------------

### RawMemory.get()

Source: https://docs.screeps.com/api

Get a raw string representation of the Memory object.

```APIDOC
## RawMemory.get()

### Description
Get a raw string representation of the `Memory` object.

### Return value
Returns a string value.
```

--------------------------------

### Get World Size

Source: https://docs.screeps.com/api

Returns the total number of rooms spanning the world from corner to corner.

```javascript
Game.map.getWorldSize()
```

--------------------------------

### Simultaneous Actions with Dependencies

Source: https://docs.screeps.com/simultaneous-actions.html

Demonstrates how dependent actions are executed. Only the rightmost action in a dependency chain will execute if called together. Each successful execution returns 'OK'.

```javascript
    // tick 1
    creep.build(constructionSite); // ERR_NOT_ENOUGH_ENERGY
    creep.harvest(source); // OK – executed, creep gained energy
    // tick 2
    creep.build(constructionSite); // OK – executed
    creep.harvest(source); // OK, but execution failed since it was blocked by build
```

--------------------------------

### Find and Execute a Deal Based on Price and Transaction Cost

Source: https://docs.screeps.com/api

This snippet demonstrates how to find available sell orders for a resource and execute a deal if the transaction cost is within a specified limit. It iterates through orders, calculates transfer cost, and places a deal if conditions are met.

```javascript
const amountToBuy = 2000, maxTransferEnergyCost = 500;
const orders = Game.market.getAllOrders({type: ORDER_SELL, resourceType: RESOURCE_GHODIUM});

for(let i=0; i<orders.length; i++) {
    const transferEnergyCost = Game.market.calcTransactionCost(
        amountToBuy, 'W1N1', orders[i].roomName);

    if(transferEnergyCost < maxTransferEnergyCost) {
        Game.market.deal(orders[i].id, amountToBuy, "W1N1");
        break;
    }
}
```

--------------------------------

### Describe Exits from a Room

Source: https://docs.screeps.com/api

Use Game.map.describeExits to get a list of all available exits from a specified room.

```javascript
const exits = Game.map.describeExits('W8N3');
```

--------------------------------

### Get Market Order by ID

Source: https://docs.screeps.com/api

Retrieves information for a specific market order using its unique ID.

```javascript
const order = Game.market.getOrderById('55c34a6b5be41a0a6e80c123');
```

--------------------------------

### Get Raw Memory String

Source: https://docs.screeps.com/api

Retrieves the entire Memory object as a raw string. This is useful for custom serialization.

```javascript
const myMemory = JSON.parse(RawMemory.get());
```

--------------------------------

### Create Construction Site for Spawn

Source: https://docs.screeps.com/api

Schedule the creation of a new spawn at a specific location, optionally providing a name for the spawn. Ensure you have sufficient Room Controller Level and haven't exceeded the construction site limit.

```javascript
Game.flags['Flag1'].pos.createConstructionSite(STRUCTURE_SPAWN, 'MySpawn2');
```

--------------------------------

### Switch to Screeps User

Source: https://docs.screeps.com/contributed/ps_ubuntu.html

Switches the current user to the 'screeps' user to perform subsequent server setup operations.

```bash
sudo su screeps
```

--------------------------------

### All Resources Constant

Source: https://docs.screeps.com/api

Enumerates all possible resource types available in the game, including basic, commodity, and compound resources.

```javascript
RESOURCES_ALL: [
        exports.RESOURCE_ENERGY,
        exports.RESOURCE_POWER,

        exports.RESOURCE_HYDROGEN,
        exports.RESOURCE_OXYGEN,
        exports.RESOURCE_UTRIUM,
        exports.RESOURCE_KEANIUM,
        exports.RESOURCE_LEMERGIUM,
        exports.RESOURCE_ZYNTHIUM,
        exports.RESOURCE_CATALYST,
        exports.RESOURCE_GHODIUM,

        exports.RESOURCE_HYDROXIDE,
        exports.RESOURCE_ZYNTHIUM_KEANITE,
        exports.RESOURCE_UTRIUM_LEMERGITE,

        exports.RESOURCE_UTRIUM_HYDRIDE,
        exports.RESOURCE_UTRIUM_OXIDE,
        exports.RESOURCE_KEANIUM_HYDRIDE,
        exports.RESOURCE_KEANIUM_OXIDE,
        exports.RESOURCE_LEMERGIUM_HYDRIDE,
        exports.RESOURCE_LEMERGIUM_OXIDE,
        exports.RESOURCE_ZYNTHIUM_HYDRIDE,
        exports.RESOURCE_ZYNTHIUM_OXIDE,
        exports.RESOURCE_GHODIUM_HYDRIDE,
        exports.RESOURCE_GHODIUM_OXIDE,

        exports.RESOURCE_UTRIUM_ACID,
        exports.RESOURCE_UTRIUM_ALKALIDE,
        exports.RESOURCE_KEANIUM_ACID,
        exports.RESOURCE_KEANIUM_ALKALIDE,
        exports.RESOURCE_LEMERGIUM_ACID,
        exports.RESOURCE_LEMERGIUM_ALKALIDE,
        exports.RESOURCE_ZYNTHIUM_ACID,
        exports.RESOURCE_ZYNTHIUM_ALKALIDE,
        exports.RESOURCE_GHODIUM_ACID,
        exports.RESOURCE_GHODIUM_ALKALIDE,

        exports.RESOURCE_CATALYZED_UTRIUM_ACID,
        exports.RESOURCE_CATALYZED_UTRIUM_ALKALIDE,
        exports.RESOURCE_CATALYZED_KEANIUM_ACID,
        exports.RESOURCE_CATALYZED_KEANIUM_ALKALIDE,
        exports.RESOURCE_CATALYZED_LEMERGIUM_ACID,
        exports.RESOURCE_CATALYZED_LEMERGIUM_ALKALIDE,
        exports.RESOURCE_CATALYZED_ZYNTHIUM_ACID,
        exports.RESOURCE_CATALYZED_ZYNTHIUM_ALKALIDE,
        exports.RESOURCE_CATALYZED_GHODIUM_ACID,
        exports.RESOURCE_CATALYZED_GHODIUM_ALKALIDE,

        exports.RESOURCE_OPS,

        exports.RESOURCE_SILICON,
        exports.RESOURCE_METAL,
        exports.RESOURCE_BIOMASS,
        exports.RESOURCE_MIST,

        exports.RESOURCE_UTRIUM_BAR,
        exports.RESOURCE_LEMERGIUM_BAR,
        exports.RESOURCE_ZYNTHIUM_BAR,
        exports.RESOURCE_KEANIUM_BAR,
        exports.RESOURCE_GHODIUM_MELT,
        exports.RESOURCE_OXIDANT,
        exports.RESOURCE_REDUCTANT,
        exports.RESOURCE_PURIFIER,
        exports.RESOURCE_BATTERY,
        exports.RESOURCE_COMPOSITE,
        exports.RESOURCE_CRYSTAL,
        exports.RESOURCE_LIQUID,

        exports.RESOURCE_WIRE,
        exports.RESOURCE_SWITCH,
        exports.RESOURCE_TRANSISTOR,
        exports.RESOURCE_MICROCHIP,
        exports.RESOURCE_CIRCUIT,
        exports.RESOURCE_DEVICE,

        exports.RESOURCE_CELL,
        exports.RESOURCE_PHLEGM,
        exports.RESOURCE_TISSUE,
        exports.RESOURCE_MUSCLE,
        exports.RESOURCE_ORGANOID,
        exports.RESOURCE_ORGANISM,

        exports.RESOURCE_ALLOY,
        exports.RESOURCE_TUBE,
        exports.RESOURCE_FIXTURES,
        exports.RESOURCE_FRAME,
        exports.RESOURCE_HYDRAULICS,
        exports.RESOURCE_MACHINE,

        exports.RESOURCE_CONDENSATE,
        exports.RESOURCE_CONCENTRATE,
    ]
```

--------------------------------

### Market Orders Object Example

Source: https://docs.screeps.com/api

An object containing your active and inactive buy/sell orders on the market. Keys are order IDs.

```javascript
{
    "55c34a6b5be41a0a6e80c68b": {
        id : "55c34a6b5be41a0a6e80c68b",
        created : 13131117,
        active: true,
        type : "sell"
        resourceType : "OH",
        roomName : "W1N1",
        amount : 15821,
        remainingAmount : 30000,
        totalAmount : 50000,
        price : 2.95
    },
    "55c34a6b52411a0a6e80693a": {
        id : "55c34a6b52411a0a6e80693a",
        created : 13134122,
        active: true,
        type : "buy"
        resourceType : "energy",
        roomName : "W1N1",
        amount : 94000,
        remainingAmount : 94000,
        totalAmount : 94000
        price : 0.45
    },
    "55c34a6b5be41a0a6e80c123": {
        id : "55c34a6b5be41a0a6e80c123",
        created : 13105123,
        active: false,
        type : "sell"
        resourceType : "token",
        amount : 0,
        remainingAmount : 10,
        totalAmount : 10,
        price : 50000
    }
}
```

--------------------------------

### Get Direction to Target

Source: https://docs.screeps.com/api

Determines the linear direction from the current position to a target position. Used for simple directional movement.

```javascript
const direction = creep.pos.getDirectionTo(target);
creep.move(direction);
```

--------------------------------

### Switch Resource Components

Source: https://docs.screeps.com/api

Details the components and properties for the RESOURCE_SWITCH.

```javascript
[exports.RESOURCE_SWITCH]: {
            level: 1,
            amount: 5,
            cooldown: 70,
            components: {
                [exports.RESOURCE_WIRE]: 40,
                [exports.RESOURCE_OXIDANT]: 95,
                [exports.RESOURCE_UTRIUM_BAR]: 35,
                [exports.RESOURCE_ENERGY]: 20
            }
        }
```

--------------------------------

### Apply Code Styling

Source: https://docs.screeps.com/contributed/advanced_grunt.html

Run the 'pretty' Grunt task to automatically format your JavaScript code according to the configured style rules.

```bash
grunt pretty
```

--------------------------------

### Get All Market Orders

Source: https://docs.screeps.com/api

Retrieves all active market orders. Can be filtered for performance. Use specific filters for faster results.

```javascript
Game.market.getAllOrders(); // slow
```

```javascript
Game.market.getAllOrders({type: ORDER_SELL, resourceType: RESOURCE_GHODIUM}); // fast
```

```javascript
const targetRoom = "W1N1";
Game.market.getAllOrders(order => order.resourceType == RESOURCE_GHODIUM &&
    order.type == ORDER_SELL &&
    Game.market.calcTransactionCost(1000, targetRoom, order.roomName) < 500); // slow
```

--------------------------------

### Game.cpu.getUsed()

Source: https://docs.screeps.com/api

Gets the amount of CPU time used from the beginning of the current game tick. Returns 0 in Simulation mode.

```APIDOC
## Game.cpu.getUsed()

### Description
Get amount of CPU time used from the beginning of the current game tick. Always returns 0 in the Simulation mode.

### Return value
Returns currently used CPU time as a float number.
```

--------------------------------

### Run WebAssembly Module in Screeps

Source: https://docs.screeps.com/modules.html

Load and execute a WebAssembly binary module within Screeps. This involves fetching the binary data and instantiating the WebAssembly module.

```javascript
// This will return an ArrayBuffer with `addTwo.wasm` binary contents
const bytecode = require('addTwo');

const wasmModule = new WebAssembly.Module(bytecode);

const imports = {};

// Some predefined environment for Emscripten. See here:
// https://github.com/WebAssembly/tool-conventions/blob/master/DynamicLinking.md
imports.env = {
    memoryBase: 0,
    tableBase: 0,
    memory: new WebAssembly.Memory({ initial: 256 }),
    table: new WebAssembly.Table({ initial: 0, element: 'anyfunc' })
    
};

const wasmInstance = new WebAssembly.Instance(wasmModule, imports);

console.log(wasmInstance.exports.addTwo(2,3));
```

--------------------------------

### Game.map.findExit

Source: https://docs.screeps.com/api

Finds the exit direction from a starting room to a destination room. This is useful for pathfinding when a creep needs to move to a different room.

```APIDOC
## Game.map.findExit(fromRoom, toRoom, [opts])

### Description
Find the exit direction from the given room en route to another room.

### Parameters
#### Path Parameters
- **fromRoom** (string, Room) - Required - Start room name or room object.
- **toRoom** (string, Room) - Required - Finish room name or room object.
- **opts** (object) - Optional - An object with the pathfinding options. See `findRoute`.

### Return value
The room direction constant, one of the following:
  * `FIND_EXIT_TOP`
  * `FIND_EXIT_RIGHT`
  * `FIND_EXIT_BOTTOM`
  * `FIND_EXIT_LEFT`

Or one of the following error codes:
constant| value| description  
---|---|---
`ERR_NO_PATH`| -2| Path can not be found.
`ERR_INVALID_ARGS`| -10| The location is incorrect.
```

--------------------------------

### Basic Resource Definitions

Source: https://docs.screeps.com/api

Defines basic resources like energy and their initial properties.

```javascript
                [exports.RESOURCE_UTRIUM_BAR]: 20,
                [exports.RESOURCE_ZYNTHIUM_BAR]: 20,
                [exports.RESOURCE_ENERGY]: 20
```

--------------------------------

### Get Range to Target

Source: https://docs.screeps.com/api

Calculates the linear distance (number of squares) between the current position and a target position. Useful for range-based actions.

```javascript
const range = creep.pos.getRangeTo(target);
if(range <= 3) {
    creep.rangedAttack(target);
}
```

--------------------------------

### Get Global Power Level

Source: https://docs.screeps.com/power.html

Access your account's Global Power Level (GPL) using the `Game.gpl` property in the API.

```javascript
Game.gpl
```

--------------------------------

### StructureSpawn

Source: https://docs.screeps.com/api

Properties and methods specific to Spawn structures.

```APIDOC
## StructureSpawn

### Description
Represents a Spawn structure, used for creating creeps.

### Properties
- **effects** (Array) - 
- **pos** (object) - 
- **room** (object) - 
- **hits** (number) - 
- **hitsMax** (number) - 
- **id** (string) - 
- **structureType** (string) - 
- **my** (boolean) - 
- **owner** (object) - 
- **energy** (number) - 
- **energyCapacity** (number) - 
- **memory** (object) - 
- **name** (string) - 
- **spawning** (object) - 
- **store** (object) - 

### Methods
- **destroy**() - 
- **isActive**() - 
- **notifyWhenAttacked**() - 
- **canCreateCreep**() - 
- **createCreep**() - 
- **spawnCreep**() - 
- **recycleCreep**() - 
- **renewCreep**() - 
```

--------------------------------

### export()

Source: https://docs.screeps.com/api

Generates a compact string representation of all visuals added to the map in the current tick. This string can be stored for later use, for example, in memory.

```APIDOC
## export()

### Description
Returns a compact representation of all visuals added on the map in the current tick.

### Return value
A string with visuals data. There's not much you can do with the string besides store them for later.
```

--------------------------------

### Process Power with Power Spawn

Source: https://docs.screeps.com/power.html

Use the `processPower` method on a StructurePowerSpawn to increase Global Power Level. This requires 1 unit of power resource and 50 units of energy.

```javascript
StructurePowerSpawn.prototype.processPower = function() {
    // ...
}
```

--------------------------------

### Structure Methods

Source: https://docs.screeps.com/api

Common methods available for most structures.

```APIDOC
## Structure Methods

### Description
Common methods available for most structures.

### Methods
- **destroy** () - Destroys the structure.
- **notifyWhenAttacked** (boolean) - Enables or disables notifications when the structure is attacked.
```

--------------------------------

### Create Screeps Systemd Service File

Source: https://docs.screeps.com/contributed/ps_ubuntu.html

Creates the systemd service file for the Screeps server. This file defines how the server runs as a background service. It should be created as the root user.

```bash
sudo nano /etc/systemd/system/screeps-world.service
```

--------------------------------

### Get Objects in Room Area

Source: https://docs.screeps.com/api

Retrieves all objects within a specified rectangular area of a room. The result format depends on the 'asArray' parameter.

```javascript
const look = creep.room.lookAtArea(10,5,11,7);
```

```javascript
// 10,5,11,7

{
    10: {
        5: [{ type: 'creep', creep: {...} },
            { type: 'terrain', terrain: 'swamp' }],
        6: [{ type: 'terrain', terrain: 'swamp' }],
        7: [{ type: 'terrain', terrain: 'swamp' }]
    },
    11: {
        5: [{ type: 'terrain', terrain: 'plain' }],
        6: [{ type: 'structure', structure: {...} },
            { type: 'terrain', terrain: 'swamp' }],
        7: [{ type: 'terrain', terrain: 'wall' }]
    }
}
```

```javascript
[
    {x: 5, y: 10, type: 'creep', creep: {...}},
    {x: 5, y: 10, type: 'terrain', terrain: 'swamp'},
    {x: 6, y: 10, type: 'terrain', terrain: 'swamp'},
    {x: 7, y: 10, type: 'terrain', terrain: 'swamp'},
    {x: 5, y: 11, type: 'terrain', terrain: 'plain'},
    {x: 6, y: 11, type: 'structure', structure: {...}},
    {x: 6, y: 11, type: 'terrain', terrain: 'swamp'},
    {x: 7, y: 11, type: 'terrain', terrain: 'wall'}
]
```

--------------------------------

### Game.map.getTerrainAt

Source: https://docs.screeps.com/api

Gets the terrain type at specified X and Y coordinates within a given room. This method is deprecated and `Game.map.getRoomTerrain` is recommended for better performance.

```APIDOC
## Game.map.getTerrainAt(x, y, roomName)

### Description
Get terrain type at the specified room position. This method works for any room in the world even if you have no access to it.

### Parameters
#### Path Parameters
- **x** (number) - Required - X position in the room.
- **y** (number) - Required - Y position in the room.
- **roomName** (string) - Required - The room name.

### Return value
One of the following string values:
  * `plain`
  * `swamp`
  * `wall`

### Example
```javascript
console.log(Game.map.getTerrainAt(25,20,'W10N10'));
console.log(Game.map.getTerrainAt(new RoomPosition(25,20,'W10N10')));
```
```
Tokens:
Raw