screeps 4.2.14 → 4.2.15

package/example-mods/change-constant.js

@@ -1,30 +0,0 @@
-// Change a global constant
-
-module.exports = function (config) {
-    if(config.common) {
-        config.common.constants.MAX_CREEP_SIZE = 70;
-        config.common.constants.SPAWN_ENERGY_START = 1000000;
-        config.common.constants.SPAWN_ENERGY_CAPACITY = 1000000;
-        config.common.constants.CREEP_SPAWN_TIME = 0;
-    }
-    if (config.engine) {
-        const cl = console.log;
-        config.engine.on('playerSandbox', sandbox => {
-            // cl(sandbox.get('C'));
-            // console.log('emited');
-
-/*
-            sandbox.run('\
-		global.MAX_CREEP_SIZE = 70;\
-		global.SPAWN_ENERGY_START = 1000000;\
-		global.SPAWN_ENERGY_CAPACITY = 1000000;\
-		global.CREEP_SPAWN_TIME = 0;\
-		');
-*/
-
-
-        });
-        console.log(`Mod loaded into engine`);
-        //console.log(`Engine config found by mod: ${JSON.stringify(config.engine, 0, 2)}`)
-    }
-};

package/example-mods/cli-method.js

@@ -1,12 +0,0 @@
-// Add test() method to the CLI sandbox environment
-
-module.exports = function(config) {
-    if(config.cli) {
-        config.cli.on('cliSandbox', function(sandbox) {
-            sandbox.test = function() {
-                sandbox.print('This is the test!');
-                return 'Test result';
-            };
-        });
-    }
-};

package/example-mods/cronjob.js

@@ -1,14 +0,0 @@
-// Add a new cron job function
-
-var cnt = 0;
-module.exports = function(config) {
-    if(config.cronjobs) {
-        config.cronjobs.myCronJob = [
-            5,                              // interval in seconds
-            function myCronJob() {
-                cnt++;
-                console.log(cnt);           // Output goes to backend log
-            }
-        ];
-    }
-};

package/example-mods/custom-objects/advanced.js

@@ -1,93 +0,0 @@
-// Add an object with type "myobject" visually represented by a green circle
-// It should have a counter incrementing each tick
-
-module.exports = function(config) {
-
-    if(config.backend) {
-        // Add side panel
-        config.backend.customObjectTypes.myobject = {
-            sidepanel: '<div><label>Counter:</label><span>{{object.counter}}</span></div>'
-        };
-
-        // Add visuals, see examples in renderer
-        config.backend.renderer.metadata['myobject'] = {
-            calculations: [
-                {
-                    id: 'displayCounter',
-                    props: ['counter'],
-                    func: {$state: 'counter'}
-                }
-            ],
-            processors: [
-                {
-                    type: 'draw',
-                    once: true,
-                    payload: {
-                        drawings: [
-                            { method: 'beginFill', params: [0x77FF77] },
-                            { method: 'drawCircle', params: [0,0,40] },
-                            { method: 'endFill' }
-                        ],
-                    }
-                },
-                {
-                    type: 'text',
-                    props: ['counter'],
-                    payload: {
-                        text: { $calc: 'displayCounter' },
-                        style: {  align: 'center', fill: '#000000', fontSize: 50, fontWeight: 'bold' },
-                        anchor: {x: 0.5, y: 0.5}
-                    }
-                }
-            ]
-        };
-    }
-
-    if(config.engine) {
-        // Add MyObject prototype to user scripts
-        config.engine.registerCustomObjectPrototype('myobject', 'MyObject', {
-            properties: {
-                counter: object => object.counter
-            },
-            prototypeExtender(prototype, scope) {
-                prototype.getCounter = function() {
-                    scope.globals.console.log('Current counter is:', this.counter);
-                    return this.counter + '!';
-                }
-            },
-            findConstant: 10000
-        });
-
-        // Increment the counter each tick
-        config.engine.on('processObject', function(object, roomObjects, roomTerrain, gameTime,
-                                                   roomInfo, objectsUpdate, usersUpdate) {
-
-            if(object.type == 'myobject') {
-                objectsUpdate.update(object, {
-                    counter: object.counter + 1
-                });
-            }
-        });
-    }
-}
-
-/*
-
- How to test
-
- Add a new object using CLI:
-
- storage.db['rooms.objects'].insert({type: 'myobject', room: yourRoomName,
-    x: 20, y: 20, counter: 0});
-
- Now you will see a green circle at this position in the room.
- This object will have MyObject prototype in your script,
- you can address it this way:
-
- var objects = Game.rooms[yourRoomName].find(10000);
-
- You will see how its counter grows:
-
- console.log(objects[0].counter);
-
- */

package/example-mods/custom-objects/intent-custom.js

@@ -1,76 +0,0 @@
-// Add an object with type "myobject" visually represented by a green circle
-// It should have a command for increment the counter 
-
-module.exports = function(config) {
-
-    if(config.backend) {
-        // Add visuals
-        config.backend.customObjectTypes.myobject = {
-
-            svg: `<ellipse cx="0" cy="0" rx="40" ry="40" fill="#77ff77"></ellipse>
-                  <text x="0" y="20" text-anchor="middle" font-size="50" 
-                        fill="#000000" font-weight="bold">{{object.counter}}</text>`,
-
-            sidepanel: '<div><label>Counter:</label><span>{{object.counter}}</span></div>'
-        }
-    }
-
-    if(config.engine) {
-
-        // Add a new custom intent type description.
-        // It is global for all object types
-        config.engine.customIntentTypes.incCounter = {
-            incValue: 'number'
-        };
-
-        // Add MyObject prototype to user scripts
-        config.engine.registerCustomObjectPrototype('myobject', 'MyObject', {
-            properties: {
-                counter: object => object.counter
-            },
-            prototypeExtender(prototype, scope) {
-                prototype.increment = function(value) {
-                    scope.intents.set(this.id, 'incCounter', {incValue: value});
-                    return 0;
-                }
-            },
-            findConstant: 10000
-        });
-
-        // Add "incCounter" command processing
-        config.engine.on('processObjectIntents', function(object, userId, intents, roomObjects,
-                                                          roomTerrain, gameTime, roomInfo, objectsUpdate,
-                                                          usersUpdate) {
-
-            if (object.type == 'myobject') {
-                if (intents.incCounter) {
-                    objectsUpdate.update(object, {
-                        counter: object.counter + intents.incCounter.incValue
-                    });
-                }
-            }
-        });
-    }
-}
-
-/*
-
- How to test
-
- Add a new object using CLI:
-
- storage.db['rooms.objects'].insert({type: 'myobject', room: yourRoomName,
-    x: 20, y: 20, counter: 0});
-
- Now you will see a green circle at this position in the room.
- This object will have MyObject prototype in your script,
- you can address it this way:
-
- var objects = Game.rooms[yourRoomName].find(10000);
-
- Run the command:
-
- objects[0].increment(2);
- console.log(objects[0].counter);
-
- */

package/example-mods/custom-objects/intent.js

@@ -1,102 +0,0 @@
-// Add an object with type "myobject" visually represented by a green circle
-// It should be able to run the "move" command
-
-module.exports = function(config) {
-
-    if(config.backend) {
-        // Add visuals
-        config.backend.customObjectTypes.myobject = {
-            svg: `<ellipse cx="0" cy="0" rx="40" ry="40" fill="#77ff77"></ellipse>`
-        }
-    }
-
-    if(config.engine) {
-        // Add MyObject prototype to user scripts
-        config.engine.registerCustomObjectPrototype('myobject', 'MyObject', {
-            userOwned: true,
-            prototypeExtender(prototype, scope) {
-                prototype.move = function(direction) {
-                    scope.intents.set(this.id, 'move', {direction});
-                    return 0;
-                }
-            },
-            findConstant: 10000
-        });
-
-        // Add "move" command processing logic
-        config.engine.on('processObjectIntents', function(object, userId, intents, roomObjects,
-                                                          roomTerrain, gameTime, roomInfo, objectsUpdate,
-                                                          usersUpdate) {
-
-            if(object.type == 'myobject') {
-                if(intents.move) {
-                    var x = object.x, y = object.y;
-                    switch(intents.move.direction) {
-                        case 1: {
-                            y = object.y - 1;
-                            break;
-                        }
-                        case 2: {
-                            x = object.x + 1;
-                            y = object.y - 1;
-                            break;
-                        }
-                        case 3: {
-                            x = object.x + 1;
-                            break;
-                        }
-                        case 4: {
-                            x = object.x + 1;
-                            y = object.y + 1;
-                            break;
-                        }
-                        case 5: {
-                            y = object.y + 1;
-                            break;
-                        }
-                        case 6: {
-                            x = object.x - 1;
-                            y = object.y + 1;
-                            break;
-                        }
-                        case 7: {
-                            x = object.x - 1;
-                            break;
-                        }
-                        case 8: {
-                            x = object.x - 1;
-                            y = object.y - 1;
-                            break;
-                        }
-                    }
-                    objectsUpdate.update(object, {x,y});
-                }
-            }
-        });
-    }
-}
-
-/*
-
- How to test
-
- Find your user id:
-
- storage.db.users.findOne({username: yourUserName})
-
- Add a new owned object using CLI:
-
- storage.db['rooms.objects'].insert({type: 'myobject', room: yourRoomName,
-    x: 20, y: 20, user: yourUserId});
-
- Now you will see a green circle at this position in the room.
- This object will have MyObject prototype in your script,
- you can address it this way:
-
- var objects = Game.rooms[yourRoomName].find(10000);
-
- Now you can move it:
-
- objects[0].move(TOP);
-
- */

package/example-mods/custom-objects/simple.js

@@ -1,35 +0,0 @@
-// Add an object with type "myobject" visually represented by a green circle
-
-module.exports = function(config) {
-
-    if(config.backend) {
-        // Add visuals
-        config.backend.customObjectTypes.myobject = {
-            svg: '<ellipse cx="0" cy="0" rx="40" ry="40" fill="#77ff77"></ellipse>'
-        }
-    }
-
-    if(config.engine) {
-        // Add MyObject prototype to user scripts
-        config.engine.registerCustomObjectPrototype('myobject', 'MyObject', {
-            findConstant: 10000
-        });
-    }
-}
-
-/*
-
- How to test
-
- Add a new object using CLI:
-
- storage.db['rooms.objects'].insert({type: 'myobject', room: yourRoomName,
-    x: 20, y: 20});
-
- Now you will see a green circle at this position in the room.
- This object will have MyObject prototype in your script,
- you can address it this way:
- 
- Game.rooms[yourRoomName].find(10000);
-
- */

package/example-mods/driver-method.js

@@ -1,17 +0,0 @@
-// Change driver.getAllUsers method and exclude particular users from executing
-
-var _ = require('lodash');
-
-module.exports = function(config) {
-    if(config.engine) {
-        var oldGetAllUsers = config.engine.driver.getAllUsers;
-        config.engine.driver.getAllUsers = function() {
-            var promise = oldGetAllUsers.apply(this, Array.prototype.slice.call(arguments));
-
-            return promise.then(result => {
-                _.remove(result, {username: 'user_to_exclude'});
-                return result;
-            });
-        }
-    }
-};

package/example-mods/http-endpoint.js

@@ -1,9 +0,0 @@
-// Add an endpoint /api/test to the HTTP server
-
-module.exports = function(config) {
-    if(config.backend) {
-        config.backend.router.get('/test', (request, response) => {
-            response.json({ok: 1, foo: request.query.foo});
-        })
-    }
-};

package/example-mods/notifications-mailer/notifications-mailer.js

@@ -1,35 +0,0 @@
-module.exports = function(config) {
-
-    if(config.backend) {
-
-        var nodemailer = require('nodemailer');
-        var transporter = nodemailer.createTransport('smtps://user%40gmail.com:pass@smtp.gmail.com');
-
-        config.backend.on('sendUserNotifications', function(user, notifications) {
-
-            if(!user.email) {
-                return;
-            }
-
-            var mailOptions = {
-                from: 'Private Screeps Mailer <user@gmail.com>', 
-                to: user.email,
-                subject: 'Screeps private server notifications'
-            };
-
-            mailOptions.text = notifications.length + ' notifications received:\n\n';
-
-            notifications.forEach(notification => {
-                mailOptions.text += `${notification.message}\n[${notification.type}] (${notification.count})\n\n`;
-            })
-
-            transporter.sendMail(mailOptions, function (error, info) {
-                if (error) {
-                    return console.error(error);
-                }
-            });
-        });
-
-    }
-
-}

package/example-mods/player-sandbox.js

@@ -1,15 +0,0 @@
-// Add a new function to player sandbox space
-// Try to run `test()` using your in-game console
-
-module.exports = function(config) {
-    if(config.engine) {
-        config.engine.on('playerSandbox', function(sandbox, userId) {
-            sandbox.set('myInValue', 123);
-            sandbox.run(`function test() {
-                console.log('Current game tick is:', Game.time, 'myInValue:', global.myInValue);
-                global.myOutValue = 999; 
-            }`);
-            console.log(`User ${userId} global.myOutValue=${sandbox.get('myOutValue')}`);
-        });
-    }
-};

package/example-mods/process-object.js

@@ -1,12 +0,0 @@
-// Disable Source Keepers spawning
-
-module.exports = function(config) {
-    if(config.engine) {
-        config.engine.on('processObject', function(object, roomObjects, roomTerrain, gameTime,
-                                                   roomInfo, objectsUpdate, usersUpdate) {
-            if(object.type == 'keeperLair') {
-                object._skip = true; // This object will not be processed
-            }
-        });
-    }
-};

package/example-mods/renderer/draw-parameterized.js

@@ -1,111 +0,0 @@
-// Add simple graphic for custom object type "test"
-// Use this CLI command to add it in the game:
-// storage.db['rooms.objects'].insert({type: "test", room: "W3N3", x: 20, y: 20, score: 0, scoreMax: 100});
-// Then try to set the score property:
-// storage.db['rooms.objects'].update({type: 'test'}, {$set: {score: 30}});
-//
-// See renderer documentation: https://github.com/screeps/renderer
-
-module.exports = function (config) {
-    if (config.backend) {
-        config.backend.renderer.metadata['test'] = {
-            calculations: [
-                {
-                    // it is addressed from the second draw processor below
-                    id: 'scoreDrawRadius',
-                    //recalculate when `score` or `scoreMax` are changed
-                    props: ['score','scoreMax'],
-                    // 40 * state / stateMax
-                    func: {
-                        $mul: [
-                            40,
-                            {$div: [
-                                {$state: 'score'},
-                                {$state: 'scoreMax'}
-                            ]}
-                        ]
-                    }
-                }
-            ],
-            processors: [
-
-                // base rectangle
-                {
-                    type: 'draw',
-                    once: true,
-                    payload: { 
-                        drawings: [
-                            // Each element here describes a PIXI.Graphics method
-                            // See http://pixijs.download/dev/docs/PIXI.Graphics.html
-                            {
-                                method: 'lineStyle',
-                                params: [
-                                    5,
-                                    0xFFAAFF
-                                ],
-                            },
-                            {
-                                method: 'beginFill',
-                                params: [0xFF00FF]
-                            },
-                            {
-                                method: 'drawRoundedRect',
-                                params: [
-                                    -40,
-                                    -40,
-                                    80,
-                                    80,
-                                    10,
-                                ],
-                            },
-                            {
-                                method: 'endFill'
-                            },
-                        ],
-                    },
-                },
-
-                // a circle with radius depending on the `score` property
-                {
-                    type: 'draw',
-                    props: ['score','scoreMax'], // recreate this drawing when `score` or `scoreMax` are changed
-                    when: {$gt: [{$state: 'score'}, 0]}, // only display if `score` property is greater than 0
-                    payload: {
-                        drawings: [
-                            {
-                                method: 'beginFill',
-                                params: [0xFFFFFF]
-                            },
-                            {
-                                method: 'drawCircle',
-                                params: [
-                                    0,
-                                    0,
-                                    {$calc: 'scoreDrawRadius'}
-                                ],
-                            },
-                            {
-                                method: 'endFill'
-                            },
-                        ],
-                    },
-                },
-
-                // add some conditional lighting
-                {
-                    type: 'sprite',
-                    once: true,
-                    layer: 'lighting',
-                    when: {$gt: [{$state: 'score'}, 0]}, // only display if `score` property is greater than 0
-                    payload: {
-                        texture: 'glow',
-                        width: 800,
-                        height: 800,
-                        tint: 0xFFFFFF,
-                    },
-                },
-
-            ],
-        }
-    }
-}

package/example-mods/renderer/draw.js

@@ -1,49 +0,0 @@
-// Add simple graphic for custom object type "test"
-// Use this CLI command to add it in the game:
-// storage.db['rooms.objects'].insert({type: "test", room: "W3N3", x: 20, y: 20});
-//
-// See renderer documentation: https://github.com/screeps/renderer
-
-module.exports = function (config) {
-    if (config.backend) {
-        config.backend.renderer.metadata['test'] = {
-            processors: [
-                {
-                    type: 'draw',
-                    once: true,
-                    payload: {                            
-                        drawings: [
-                            // Each element here describes a PIXI.Graphics method
-                            // See http://pixijs.download/dev/docs/PIXI.Graphics.html
-                            {
-                                method: 'lineStyle',
-                                params: [
-                                    5,
-                                    0xFFAAFF
-                                ],
-                            },
-                            {
-                                method: 'beginFill',
-                                params: [0xFF00FF]
-                            },
-                            {
-                                method: 'drawRoundedRect',
-                                params: [
-                                    -40,
-                                    -40,
-                                    80,
-                                    80,
-                                    10,
-                                ],
-                            },
-                            {
-                                method: 'endFill'
-                            },
-                        ],
-                    },
-                },
-
-            ],
-        }
-    }
-}