Initial commit

Author: masked-rpgmaker

.eslintrc.js

@@ -0,0 +1,13 @@
+module.exports = {
+    parser: "@typescript-eslint/parser",
+    parserOptions: {
+        ecmaVersion: 2020,
+        sourceType: "module"
+    },
+    extends: [
+        "plugin:@typescript-eslint/recommended"
+    ],
+    rules: {
+        "brace-style": ["error", "allman", { "allowSingleLine": true }]
+    }
+};

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+dist/

LICENSE

@@ -0,0 +1,17 @@
+zlib License
+
+This software is provided 'as-is', without any express or implied
+warranty.  In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+3. This notice may not be removed or altered from any source distribution.

README.md

@@ -0,0 +1,46 @@
+# RPG Maker MZ - Typescript Plugin Archetype
+
+This is a template repository for writing Typescript plugins for RPG Maker MZ.
+The main purpose here is to set a basis from which other repositories can
+derive from and more easily be ready to start actual development.
+
+
+## Getting Started
+
+First of all, make sure you run `npm install` to install all the dependencies
+for the project, such as [rollup.js](https://rollupjs.org/) and typescript.
+
+Make sure to set `package.json` up correctly, changing the package name to that
+of your plugin (this will be used to generate the output file) and adjust the
+values of the `version` and `description` fields (and, optionally, `keywords`).
+Also make sure to add a property `testProjectDir` if you want to test your
+plugin (can be relative).
+
+To configure plugin parameters and the likes, change `header.js`. This file is
+prepended to the generated output after the build process.
+
+Once you are done, `npm run build` will create a JS file for your plugin as
+`dist/js/plugins/{pkg.name}.js`.
+
+**TL;DR**:
+
+First:
+- `npm install`
+- Modify `package.json`
+
+Then:
+- Modify `header.js` and write Typescript code on `src`
+- `npm run build`
+- Your plugin shows up compiled in `dist/js/plugins`
+- Repeat
+
+
+## Guidelines
+
+This repo's purpose is **exclusively** providing a basic structure for other
+plugin repos.
+It is **not** the place to create core functionality! (i.e. no application
+code here!)
+
+Changes to this repo **must not** demand that repos derived from it be changed, but it **should** be possible to update them to a more recent version of the
+archetype fairly easily.

header.js

@@ -0,0 +1,24 @@
+//=============================================================================
+// RMMZ - Typescript Plugin Archetype
+//=============================================================================
+
+/*:
+ *
+ * @target MZ
+ * @plugindesc Typescript Plugin Archetype.
+ * @author Comuns
+ * 
+ * @help Typescript Plugin Archetype.
+ * 
+ * This is a plugin archetype, it does not provide any functionality, only a
+ * template for other plugins.
+ *
+ */
+
+//=============================================================================
+// ** NOTICE **
+//-----------------------------------------------------------------------------
+// The code below is generated by a compiler, and is not well suited for human
+// reading. If you are interested on the source code, please take a look at
+// the Github repository for this plugin!
+//=============================================================================