Add network monitor window

Author: IntelOrca

.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup node.js
+      uses: actions/setup-node@v2
+    - name: Install modules
+      run: |
+          mv node_modules/@types .
+          npm install
+          mv @types node_modules
+    - name: Build
+      run: npm run build
+    - name: Minify
+      run: npm run minify
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v2
+      with:
+        name: "OpenRCT2 DevTools"
+        path: out/devtools.min.js

.gitignore

@@ -1,3 +1,6 @@
+out/
+package-lock.json
+
 # Logs
 logs
 *.log

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 OpenRCT2
+Copyright (c) 2021 OpenRCT2 developers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,35 @@
-# plugin-devtools
-Plugin for OpenRCT2 providing tools to aid development of OpenRCT2
+# OpenRCT2 DevTools Plugin
+
+Plugin for OpenRCT2 providing tools to aid development of OpenRCT2.
+
+## 🚀 Installation
+1. Download the latest version of the plugin from the [Releases page](https://github.com/OpenRCT2/devtools/releases).
+
+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.

package.json

@@ -0,0 +1,19 @@
+{
+    "name": "openrct2-devtools",
+    "version": "1.0.0",
+    "description": "Plugin for OpenRCT2 providing tools to aid development of OpenRCT2",
+    "license": "MIT",
+    "author": "OpenRCT2",
+    "main": "index.js",
+    "scripts": {
+        "build": "tsc",
+        "minify": "uglifyjs --compress --mangle --output out/devtools.min.js -- out/devtools.js",
+        "copy": "copy out\\devtools.js \"%HOMEDRIVE%%HOMEPATH%\\Documents\\OpenRCT2\\plugin\"",
+        "watch": "tsc-watch --onSuccess \"npm run copy\""
+    },
+    "devDependencies": {
+        "tsc-watch": "^4.2.9",
+        "typescript": "^4.1.3",
+        "uglify-js": "^3.12.5"
+    }
+}

src/main.ts

@@ -0,0 +1,24 @@
+const DEBUG = false;
+
+const main = () => {
+    if (typeof ui === 'undefined') {
+        console.log("Plugin not available on headless mode.");
+        return;
+    }
+
+    NetworkMonitor.register();
+
+    if (DEBUG) {
+        ui.closeAllWindows();
+        NetworkMonitor.getOrOpen();
+    }
+};
+
+registerPlugin({
+    name: 'DevTools',
+    version: '1.0',
+    authors: ['OpenRCT2'],
+    type: 'local',
+    licence: 'MIT',
+    main: main
+});