screepsmod-market-simulator 1.0.0

package/index.js

@@ -0,0 +1,504 @@
+const path = require('path');
+const fs = require('fs');
+
+// ============================================================
+// Default Configuration
+// ============================================================
+const DEFAULTS = {
+    // Interval between order recreation cycles (5 minutes)
+    intervalMs: 5 * 60 * 1000,
+
+    // NPC user for phantom orders
+    npcUserId: '2',
+    npcUsername: 'NPC_Market',
+
+    // NPC credit backing: credits (display) and money (engine-internal integer, credits × 1000)
+    // Restocked to this value on every refresh cycle
+    npcCredits: 10000000,
+    npcMoney: 10000000 * 1000,
+
+    // Phantom room names — interior corners of 22×22 map for max coverage
+    phantomRooms: [
+        'W9N9',
+        'E9N9',
+        'W9S9',
+        'E9S9',
+        'W5S5',
+        'E5S5'
+    ],
+
+    // Price spread factors for buy and sell orders
+    buySpreadFactors: [0.85, 0.92, 1.0],
+    sellSpreadFactors: [1.0, 1.08, 1.15],
+
+    // Hard cap on order amounts (units per order per resource per spread level)
+    maxOrderAmount: 50000,
+
+    // Terminal store: amount per resource, restocked on every refresh
+    terminalStoreAmount: 200000,
+
+    // Terminal capacity: must hold storeAmount × resourceCount + energy buffer
+    terminalStoreCapacity: 30000000,
+
+    // How to store prices: multiply by this and store as integer
+    priceMultiplier: 1000,
+
+    // Batch size for order insertion
+    insertionBatchSize: 500,
+
+    debug: true
+};
+
+// ============================================================
+// All 89 Screeps Resource Types with Base Prices
+// ============================================================
+const RESOURCES = [
+    { type: 'energy', basePrice: 0.01 },
+    // Base minerals
+    { type: 'U', basePrice: 0.2 },
+    { type: 'L', basePrice: 0.2 },
+    { type: 'K', basePrice: 0.2 },
+    { type: 'Z', basePrice: 0.2 },
+    { type: 'O', basePrice: 0.2 },
+    { type: 'H', basePrice: 0.2 },
+    { type: 'X', basePrice: 0.2 },
+    { type: 'G', basePrice: 0.5 },
+    // Base compounds
+    { type: 'ZK', basePrice: 0.3 },
+    { type: 'UL', basePrice: 0.3 },
+    { type: 'OH', basePrice: 0.5 },
+    // Processed base resources
+    { type: 'silicon', basePrice: 0.3 },
+    { type: 'metal', basePrice: 0.3 },
+    { type: 'mist', basePrice: 0.4 },
+    { type: 'oxidant', basePrice: 0.3 },
+    { type: 'reductant', basePrice: 0.3 },
+    { type: 'purifier', basePrice: 0.3 },
+    { type: 'biomass', basePrice: 0.3 },
+    { type: 'zymite', basePrice: 1.0 },
+    { type: 'catalytic_agent', basePrice: 1.0 },
+    { type: 'hydroxide', basePrice: 0.5 },
+    // Tier 1 boosts
+    { type: 'UH', basePrice: 0.5 },
+    { type: 'UO', basePrice: 0.5 },
+    { type: 'KH', basePrice: 0.5 },
+    { type: 'KO', basePrice: 0.5 },
+    { type: 'LH', basePrice: 0.5 },
+    { type: 'LO', basePrice: 0.5 },
+    { type: 'ZH', basePrice: 0.5 },
+    { type: 'ZO', basePrice: 0.5 },
+    // Tier 1 Ghodium boosts
+    { type: 'GH', basePrice: 1.0 },
+    { type: 'GO', basePrice: 1.0 },
+    // Tier 2 boosts
+    { type: 'UH2O', basePrice: 1.0 },
+    { type: 'UHO2', basePrice: 1.0 },
+    { type: 'KH2O', basePrice: 1.0 },
+    { type: 'KHO2', basePrice: 1.0 },
+    { type: 'LH2O', basePrice: 1.0 },
+    { type: 'LHO2', basePrice: 1.0 },
+    { type: 'ZH2O', basePrice: 1.0 },
+    { type: 'ZHO2', basePrice: 1.0 },
+    // Tier 2 Ghodium boosts
+    { type: 'GH2O', basePrice: 2.0 },
+    { type: 'GHO2', basePrice: 2.0 },
+    // Tier 3 catalyzed boosts
+    { type: 'XUH2O', basePrice: 2.0 },
+    { type: 'XUHO2', basePrice: 2.0 },
+    { type: 'XKH2O', basePrice: 2.0 },
+    { type: 'XKHO2', basePrice: 2.0 },
+    { type: 'XLH2O', basePrice: 2.0 },
+    { type: 'XLHO2', basePrice: 2.0 },
+    { type: 'XZH2O', basePrice: 2.0 },
+    { type: 'XZHO2', basePrice: 2.0 },
+    // Tier 3 catalyzed Ghodium boosts
+    { type: 'XGH2O', basePrice: 4.0 },
+    { type: 'XGHO2', basePrice: 4.0 },
+    // Commodities tier 1
+    { type: 'wire', basePrice: 0.5 },
+    { type: 'alloy', basePrice: 0.5 },
+    { type: 'cell', basePrice: 0.5 },
+    { type: 'concentrate', basePrice: 0.5 },
+    { type: 'board', basePrice: 0.7 },
+    // Commodities tier 2
+    { type: 'switch', basePrice: 0.7 },
+    { type: 'phlegm', basePrice: 0.7 },
+    { type: 'tube', basePrice: 0.7 },
+    { type: 'extract', basePrice: 0.7 },
+    // Commodities tier 3
+    { type: 'transistor', basePrice: 1.0 },
+    { type: 'tissue', basePrice: 1.0 },
+    { type: 'fixtures', basePrice: 1.0 },
+    { type: 'spirit', basePrice: 1.0 },
+    // Commodities tier 4
+    { type: 'microchip', basePrice: 1.5 },
+    { type: 'muscle', basePrice: 1.5 },
+    { type: 'frame', basePrice: 1.5 },
+    { type: 'emanation', basePrice: 1.5 },
+    // Commodities tier 5
+    { type: 'circuit', basePrice: 2.0 },
+    { type: 'organoid', basePrice: 2.0 },
+    { type: 'hydraulics', basePrice: 2.0 },
+    { type: 'condensate', basePrice: 2.0 },
+    // High-tier commodities
+    { type: 'device', basePrice: 2.5 },
+    { type: 'machine', basePrice: 3.0 },
+    { type: 'organism', basePrice: 3.0 },
+    // Base products
+    { type: 'battery', basePrice: 0.2 },
+    { type: 'composite', basePrice: 0.2 },
+    { type: 'crystal', basePrice: 0.2 },
+    { type: 'liquid', basePrice: 0.2 },
+    // Bars
+    { type: 'utrium_bar', basePrice: 0.5 },
+    { type: 'lemergium_bar', basePrice: 0.5 },
+    { type: 'zynthium_bar', basePrice: 0.5 },
+    { type: 'keanium_bar', basePrice: 0.5 },
+    { type: 'ghodium_melt', basePrice: 1.0 },
+    // Power resources
+    { type: 'power', basePrice: 0.6 },
+    { type: 'ops', basePrice: 0.5 },
+    { type: 'essence', basePrice: 1.0 },
+    { type: 'mitochondrion', basePrice: 5.0 }
+];
+
+const RESOURCE_COUNT = RESOURCES.length;
+
+// ============================================================
+// Helper: Store price as integer (price * multiplier)
+// ============================================================
+function storePrice(price, cfg) {
+    return Math.round(price * cfg.priceMultiplier);
+}
+
+// ============================================================
+// Build all orders for a single phantom room
+// ============================================================
+function buildOrdersForRoom(roomName, cfg) {
+    const orders = [];
+    const now = Date.now();
+    const amount = cfg.maxOrderAmount;
+
+    RESOURCES.forEach((res, resIdx) => {
+        const basePrice = res.basePrice;
+
+        cfg.buySpreadFactors.forEach((factor, buyIdx) => {
+            const rawPrice = basePrice * factor;
+            const price = storePrice(rawPrice, cfg);
+            const orderId = `buy_${res.type}_${roomName}_${resIdx}_${buyIdx}`;
+            orders.push({
+                _id: orderId,
+                user: cfg.npcUserId,
+                roomName: roomName,
+                resourceType: res.type,
+                type: 'buy',
+                price: price,
+                amount: amount,
+                remainingAmount: amount,
+                totalAmount: amount,
+                active: true,
+                created: now,
+                createdTimestamp: now
+            });
+        });
+
+        cfg.sellSpreadFactors.forEach((factor, sellIdx) => {
+            const rawPrice = basePrice * factor;
+            const price = storePrice(rawPrice, cfg);
+            const orderId = `sell_${res.type}_${roomName}_${resIdx}_${sellIdx}`;
+            orders.push({
+                _id: orderId,
+                user: cfg.npcUserId,
+                roomName: roomName,
+                resourceType: res.type,
+                type: 'sell',
+                price: price,
+                amount: amount,
+                remainingAmount: amount,
+                totalAmount: amount,
+                active: true,
+                created: now,
+                createdTimestamp: now
+            });
+        });
+    });
+
+    return orders;
+}
+
+// ============================================================
+// Build all orders across all phantom rooms
+// ============================================================
+function buildAllOrders(cfg) {
+    let allOrders = [];
+    cfg.phantomRooms.forEach(roomName => {
+        const roomOrders = buildOrdersForRoom(roomName, cfg);
+        allOrders = allOrders.concat(roomOrders);
+    });
+    return allOrders;
+}
+
+// ============================================================
+// Build terminal store object with all resources
+// ============================================================
+function buildStoreObject(cfg) {
+    const store = {};
+    RESOURCES.forEach(res => {
+        store[res.type] = cfg.terminalStoreAmount;
+    });
+    return store;
+}
+
+// ============================================================
+// Restock NPC user: credits + money to baseline
+// ============================================================
+async function restockNpcUser(db, cfg) {
+    try {
+        await db['users'].update(
+            { _id: cfg.npcUserId },
+            {
+                $setOnInsert: {
+                    _id: cfg.npcUserId,
+                    username: cfg.npcUsername,
+                    cpu: 100,
+                    active: true
+                },
+                $set: {
+                    money: cfg.npcMoney,
+                    credits: cfg.npcCredits,
+                    lastLoginTime: Date.now()
+                }
+            },
+            { upsert: true }
+        );
+        if (cfg.debug) console.log(`[MarketSim] NPC user restocked: ${cfg.npcCredits.toLocaleString()} credits`);
+    } catch (e) {
+        if (cfg.debug) console.log(`[MarketSim] Note: upsert NPC user: ${e.message}`);
+    }
+}
+
+// ============================================================
+// Ensure phantom room documents and terminal objects exist
+// ============================================================
+async function ensurePhantomRooms(db, cfg) {
+    const npcUserId = cfg.npcUserId;
+
+    for (const roomName of cfg.phantomRooms) {
+        try {
+            await db['rooms'].update(
+                { _id: roomName },
+                {
+                    $setOnInsert: {
+                        _id: roomName,
+                        status: 'normal',
+                        active: true
+                    }
+                },
+                { upsert: true }
+            );
+        } catch (e) {
+            if (cfg.debug) console.log(`[MarketSim] Note: upsert room ${roomName}: ${e.message}`);
+        }
+
+        const store = buildStoreObject(cfg);
+        const terminalId = `terminal_${roomName}`;
+
+        try {
+            await db['rooms.objects'].update(
+                { _id: terminalId },
+                {
+                    $set: {
+                        _id: terminalId,
+                        type: 'terminal',
+                        room: roomName,
+                        user: npcUserId,
+                        x: 25,
+                        y: 25,
+                        store: store,
+                        storeCapacity: cfg.terminalStoreCapacity,
+                        energy: 0,
+                        cooldown: 0,
+                        nextSendTick: 0,
+                        send: {}
+                    }
+                },
+                { upsert: true }
+            );
+        } catch (e) {
+            if (cfg.debug) console.log(`[MarketSim] Note: upsert terminal for ${roomName}: ${e.message}`);
+        }
+    }
+
+    if (cfg.debug) console.log(`[MarketSim] Phantom rooms initialized: ${cfg.phantomRooms.join(', ')}`);
+}
+
+// ============================================================
+// Restock terminal stores to baseline for all phantom rooms
+// ============================================================
+async function restockTerminals(db, cfg) {
+    const store = buildStoreObject(cfg);
+
+    for (const roomName of cfg.phantomRooms) {
+        const terminalId = `terminal_${roomName}`;
+        try {
+            await db['rooms.objects'].update(
+                { _id: terminalId },
+                { $set: { store: store, storeCapacity: cfg.terminalStoreCapacity } }
+            );
+        } catch (e) {
+            if (cfg.debug) console.log(`[MarketSim] Note: restock terminal ${roomName}: ${e.message}`);
+        }
+    }
+
+    if (cfg.debug) console.log(`[MarketSim] Terminal stores restocked for ${cfg.phantomRooms.length} rooms`);
+}
+
+// ============================================================
+// Remove NPC orders, then recreate them (targeted refresh)
+// ============================================================
+async function recreateOrders(db, cfg) {
+    try {
+        // 1. Restock NPC credits and money
+        await restockNpcUser(db, cfg);
+
+        // 2. Restock terminal stores
+        await restockTerminals(db, cfg);
+
+        // 3. Remove only NPC-created orders (not player orders)
+        try {
+            await db['market.orders'].removeWhere({ user: cfg.npcUserId });
+        } catch (e) {
+            // LokiJS uses removeWhere, MongoDB uses deleteMany
+            if (cfg.debug) console.log(`[MarketSim] Note: removeWhere not supported, trying deleteMany`);
+            try {
+                await db['market.orders'].deleteMany({ user: cfg.npcUserId });
+            } catch (e2) {
+                if (cfg.debug) console.log(`[MarketSim] Note: deleteMany also not supported, trying remove`);
+                try {
+                    await db['market.orders'].remove({ user: cfg.npcUserId });
+                } catch (e3) {
+                    if (cfg.debug) console.log(`[MarketSim] Warning: Could not remove old NPC orders: ${e3.message}`);
+                }
+            }
+        }
+
+        // 4. Build new orders
+        const allOrders = buildAllOrders(cfg);
+
+        // 5. Insert in batches (staggered to avoid blocking the storage thread)
+        const batchSize = cfg.insertionBatchSize || 500;
+        let inserted = 0;
+
+        for (let i = 0; i < allOrders.length; i += batchSize) {
+            const batch = allOrders.slice(i, i + batchSize);
+
+            try {
+                await db['market.orders'].insertMany(batch);
+                inserted += batch.length;
+            } catch (e) {
+                // Fall back to individual upserts
+                for (const order of batch) {
+                    try {
+                        await db['market.orders'].update(
+                            { _id: order._id },
+                            order,
+                            { upsert: true }
+                        );
+                        inserted++;
+                    } catch (e2) {
+                        if (cfg.debug) console.log(`[MarketSim] Failed to insert order ${order._id}: ${e2.message}`);
+                    }
+                }
+            }
+        }
+
+        const roomCount = cfg.phantomRooms.length;
+        const resCount = RESOURCE_COUNT;
+        const ordersPerResource = cfg.buySpreadFactors.length + cfg.sellSpreadFactors.length;
+        if (cfg.debug) {
+            console.log(`[MarketSim] Refreshed ${inserted} orders across ${roomCount} rooms ` +
+                `(${resCount} resources × ${ordersPerResource} orders each per room, ` +
+                `${cfg.maxOrderAmount.toLocaleString()} units each)`);
+        }
+    } catch (err) {
+        console.log(`[MarketSim] Error recreating orders: ${err.message}`);
+    }
+}
+
+// ============================================================
+// Main mod entry point
+// ============================================================
+module.exports = function (config, pluginContext) {
+    if (!config || !config.backend) return;
+
+    // Load optional user config from marketSimulatorConfig.js
+    let userConfig = {};
+    const configPath = path.join(__dirname, 'marketSimulatorConfig.js');
+    try {
+        if (fs.existsSync(configPath)) {
+            userConfig = require(configPath);
+            if (typeof userConfig === 'function') {
+                userConfig = userConfig(config, pluginContext);
+            }
+            console.log('[MarketSim] Loaded custom config from marketSimulatorConfig.js');
+        }
+    } catch (e) {
+        if (DEFAULTS.debug) {
+            console.log(`[MarketSim] No marketSimulatorConfig.js found, using defaults`);
+        }
+    }
+
+    // Merge configs (deep merge for arrays)
+    const cfg = Object.assign({}, DEFAULTS, userConfig);
+    if (userConfig.phantomRooms) cfg.phantomRooms = userConfig.phantomRooms;
+    if (userConfig.buySpreadFactors) cfg.buySpreadFactors = userConfig.buySpreadFactors;
+    if (userConfig.sellSpreadFactors) cfg.sellSpreadFactors = userConfig.sellSpreadFactors;
+
+    const db = config.common && config.common.storage && config.common.storage.db;
+
+    if (!db) {
+        console.log('[MarketSim] ERROR: No database available via config.common.storage.db');
+        return;
+    }
+
+    console.log('[MarketSim] Mod loaded — initializing phantom market system...');
+
+    const roomsCount = cfg.phantomRooms.length;
+    const resCount = RESOURCE_COUNT;
+    const ordersPerRes = cfg.buySpreadFactors.length + cfg.sellSpreadFactors.length;
+    const totalOrders = roomsCount * resCount * ordersPerRes;
+    console.log(`[MarketSim] Expected: ${totalOrders} orders ` +
+        `(${roomsCount} rooms × ${resCount} resources × ${ordersPerRes} price levels)`);
+
+    // Initialize phantom rooms then start refresh cycle
+    restockNpcUser(db, cfg)
+        .then(() => ensurePhantomRooms(db, cfg))
+        .then(() => {
+            console.log('[MarketSim] Phantom rooms ready');
+            recreateOrders(db, cfg);
+
+            // Prefer cronjobs if available, fall back to setInterval
+            if (config.cronjobs) {
+                config.cronjobs.marketSimRefresh = [
+                    cfg.intervalMs / 1000,
+                    () => recreateOrders(db, cfg)
+                ];
+                console.log(`[MarketSim] Registered cronjob: marketSimRefresh every ${cfg.intervalMs / 1000}s`);
+            } else {
+                const intervalId = setInterval(() => {
+                    recreateOrders(db, cfg);
+                }, cfg.intervalMs);
+                console.log(`[MarketSim] Using setInterval every ${cfg.intervalMs / 1000}s`);
+
+                if (pluginContext && pluginContext.onUnload) {
+                    pluginContext.onUnload(() => {
+                        clearInterval(intervalId);
+                        console.log('[MarketSim] Unloaded');
+                    });
+                }
+            }
+        })
+        .catch(err => {
+            console.log(`[MarketSim] Initialization failed: ${err.message}`);
+        });
+};

package/marketSimulatorConfig.js

@@ -0,0 +1,89 @@
+/**
+ * Configuration overrides for screepsmod-market-simulator.
+ *
+ * This file is optional. If absent or exporting an empty object, the defaults
+ * in index.js are used. Uncomment and modify any settings below to customize.
+ *
+ * --- Market Simulation Overview ---
+ *
+ * The mod seeds the market order book with buy and sell orders for ALL 89
+ * Screeps resource types across configurable phantom rooms. Each order has a
+ * hard-capped amount (maxOrderAmount) to prevent runaway CPU/memory usage.
+ * On every refresh cycle (default 5 min), NPC credits, terminal stores, and
+ * all orders are restocked to their configured baselines.
+ *
+ * The Screeps engine handles ALL transactional aspects of dealing (resource
+ * transfer, credit exchange, energy costs, cooldowns). This mod only seeds
+ * the database.
+ *
+ * --- Key Settings ---
+ *
+ * maxOrderAmount       Hard cap on every order's amount, remainingAmount,
+ *                      and totalAmount. This prevents the engine from
+ *                      computing absurd amounts from NPC money.
+ *                      Higher = more market depth, but larger DB writes.
+ *
+ * npcCredits / npcMoney NPC backing for buy orders. Restocked to this value
+ *                      every refresh. npcMoney is the internal integer field
+ *                      (credits × 1000). Keep these high enough to cover all
+ *                      active buy orders at once.
+ *
+ * terminalStoreAmount  Amount of EACH resource in NPC terminal stores,
+ *                      restocked every refresh. Backs sell orders.
+ *                      Must fit within terminalStoreCapacity when summed.
+ *
+ * terminalStoreCapacity Total NPC terminal capacity. Must exceed:
+ *                      terminalStoreAmount × 89 (resource count) + energy.
+ *
+ * buySpreadFactors     Price multipliers for buy orders relative to base
+ *                      price. E.g., 0.85 = 85% of base = below market.
+ *
+ * sellSpreadFactors    Price multipliers for sell orders relative to base
+ *                      price. E.g., 1.15 = 115% of base = above market.
+ */
+
+module.exports = {
+
+    // --- Phantom Rooms ---
+    // Room names that don't exist in the world. Each gets a terminal
+    // and posts buy/sell orders for all resources.
+    // phantomRooms: ['W777N777', 'E777N777', 'W777S777', 'E777S777'],
+
+    // --- NPC Identity ---
+    // npcUserId: '2',
+    // npcUsername: 'NPC_Market',
+
+    // --- NPC Credit Backing ---
+    // Restocked every refresh. Money is the internal integer field
+    // used by the engine (credits × 1000).
+    // npcCredits: 5000000,
+    // npcMoney: 5000000000,
+
+    // --- Order Size ---
+    // Hard cap on EACH order's amount/remainingAmount/totalAmount.
+    // Limits CPU/memory impact of engine order processing.
+    // maxOrderAmount: 25000,
+
+    // --- Price Spreads ---
+    // Multiplied against basePrice to compute order price.
+    // Must have at least 1 entry each.
+    // buySpreadFactors: [0.80, 0.90, 0.95, 1.0],
+    // sellSpreadFactors: [1.0, 1.05, 1.10, 1.20],
+
+    // --- Terminal Stores ---
+    // terminalStoreAmount must be >= maxOrderAmount so sell orders
+    // are properly backed. terminalStoreCapacity must hold all
+    // resources × storeAmount plus energy buffer.
+    // terminalStoreAmount: 100000,
+    // terminalStoreCapacity: 15000000,
+
+    // --- Refresh Interval ---
+    // Milliseconds between restock + order refresh cycles.
+    // intervalMs: 300000,  // 5 minutes
+
+    // --- Prices ---
+    // priceMultiplier: 1000,  // Store prices as integers
+
+    // --- Debugging ---
+    // debug: false  // Set false to suppress log output
+};

package/package.json

@@ -0,0 +1,9 @@
+{
+    "name": "screepsmod-market-simulator",
+    "version": "1.0.0",
+    "description": "Populates the Screeps market order book with buy/sell orders for phantom rooms to test bot trading systems",
+    "main": "index.js",
+    "author": "Custom",
+    "license": "MIT",
+    "screeps_mod": true
+}