OpenRCT2 Modding Cheat Sheet

🔌 Plugin Basics

registerPlugin({
    name: "My Plugin",
    version: "1.0",
    authors: ["You"],
    type: "remote",
    licence: "MIT",
    main: function() {
        console.log("Plugin loaded!");
    }
});

The main function runs once when the plugin is loaded set up your hooks and UI here.

🏞️ Park API

// read/write park cash
console.log(park.cash);
park.cash += 10000;

// park name
park.name = "Fun World";

// current in-game date
console.log(date.year, date.month, date.day);

🎢 Ride API

const rides = map.getAllEntities("ride");

rides.forEach(function(ride) {
    console.log(ride.name);
    console.log(ride.excitement);
    console.log(ride.intensity);
    console.log(ride.nausea);
});

Excitement, intensity and nausea are raw rating values, divide by 100 for the displayed star value.

🧑 Guest API

const guests = map.getAllEntities("guest");

guests.forEach(function(guest) {
    console.log(guest.happiness);
    console.log(guest.energy);
    console.log(guest.cash);
});

🪟 UI Windows

ui.openWindow({
    classification: "my-plugin-window",
    width: 200,
    height: 120,
    title: "My Plugin",
    widgets: [
        { type: "label",  x: 10, y: 20, width: 180, height: 14, text: "Hello!" },
        { type: "button", x: 10, y: 40, width: 80,  height: 16, text: "Click", onClick: function() {} },
        { type: "dropdown", x: 10, y: 60, width: 100, height: 14, items: ["A","B"] }
    ]
});

🗺️ Map & Tiles

const tile = map.getTile(10, 15);

tile.elements.forEach(function(el) {
    console.log(el.type);
});

// surface height (in z-units, divide by 8 for game height)
const surface = tile.elements.find(function(e) { return e.type === "surface"; });
console.log(surface.baseHeight);

🪝 Events & Hooks

context.subscribe("interval.tick", function() {
    // runs every game tick
});

context.subscribe("ride.ratings.calculate", function(e) {
    console.log("Ride ratings calculated for ride " + e.rideId);
});