Code Monkey home page Code Monkey logo

plugin-devtools's Introduction

OpenRCT2 DevTools Plugin

Plugin for OpenRCT2 providing tools to aid development of OpenRCT2.

✔️ Features

  • Entity Viewer - Select an entity and show it's internal properties.
  • Image List - Display all the loaded sprites in the game with configurable palette.
  • Network Monitor - Display incoming and outgoing network traffic.

🚀 Installation

  1. Download the latest version of the plugin from the Releases page.

  2. To install it, put the downloaded *.js file into your /OpenRCT2/plugin folder.

    • Easiest way to find the OpenRCT2-folder is by launching the OpenRCT2 game, click and hold on the red toolbox in the main menu, and select "Open custom content folder".
    • Otherwise this folder is commonly found in C:\Users\<YOUR NAME>\Documents\OpenRCT2\plugin on Windows.
    • If you already had this plugin installed before, you can safely overwrite the old file.
    • Once the file is there, it should show up ingame in the dropdown menu under the map icon.
  3. Once the file is there, it should show up ingame in the dropdown menu under the map icon.

🔨 Building

The plugin is written in TypeScript and requires compiling to JavaScript before it can be used in OpenRCT2. Ensure you have NodeJS and a package managed such as npm installed, then run the following:

npm install
npm run build

Then copy out/devtools.js to your OpenRCT2 plugin directory.

If you want to automatically update the plugin when you edit and save the TypeScript code, you can run:

npm run watch

This will watch for changes to the source code in the background and automatically compile and copy the plugin to your OpenRCT2 directory. This is currently only configured for Windows.

Make sure you have hot reload enabled in OpenRCT2 so that OpenRCT2 will automatically reload the plugin.

⚖️ Licence

This plugin is licensed under the MIT licence.

plugin-devtools's People

Contributors

broxzier avatar intelorca avatar pfroud avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

plugin-devtools's Issues

Create new release to fix target API warning

The current codebase has a targetApiVersion noted, but a new version hasn't been released since the changes were implemented, leading to this warning on each boot:

Plug-in “DevTools” does not specify a target API version or specifies it incorrectly. Emulating deprecated APIs..

Resizing of sprite window broken.

You cannot make the window smaller than the initial size of opening. The way i go about fixing that currently is make the window of openrct2 small, open it and go fullscreen again. Quite tedious tho

Show first image of object

The image list plugin is nice, but it would be more nice if it showed me the base image of the object or even able to view only one object's images.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.