Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/comuns-rpgmaker/plugin-metadata
Automated tool for plugin annotation validation and generation
https://github.com/comuns-rpgmaker/plugin-metadata
json-schema metadata plugin rpgmaker rpgmakermz
Last synced: about 1 month ago
JSON representation
Automated tool for plugin annotation validation and generation
- Host: GitHub
- URL: https://github.com/comuns-rpgmaker/plugin-metadata
- Owner: comuns-rpgmaker
- License: zlib
- Created: 2020-08-30T22:27:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T06:52:11.000Z (almost 2 years ago)
- Last Synced: 2024-10-13T08:51:07.734Z (3 months ago)
- Topics: json-schema, metadata, plugin, rpgmaker, rpgmakermz
- Language: JavaScript
- Homepage: https://comuns-rpgmaker.github.io/plugin-metadata
- Size: 149 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Plugin Metadata
[](https://codecov.io/gh/comuns-rpgmaker/plugin-metadata)
Plugin metadata validation and generation tool.
## Getting started
First of all, be sure you have Node installed.
You can install this tool globally with:
npm install -g @comuns-rpgmaker/plugin-metadata
## Usage
```
Options:
--version Shows the version [boolean]
--input, -i Input metadata file [string]
--output, -o Output file (default: stdout) [string]
--help, -h Shows help [boolean]
```
The CLI receives an input file (if none is given, `./plugin-metadata.json` is
assumed) and an output file (if none is given, `stdout` is assumed).
The input file must follow the schema specified in
[`./schema/plugin-metadata.json`](./schema/plugin-metadata.json). It accepts
both JSON and YAML files.
For instance, suppose we have the following YAML file (`plugin-metadata.yaml`):
```yaml
target: MZ
author: You
url: https://github.com/me/my-plugin
description: My plugin
help: |-
My Plugin
This is my plugin!
```
When we run this on the CLI (if it doesn't work, try `npm link`):
mz-mtdt -i plugin-metadata.yaml
We get the following output:
```js
/*:
* @target MZ
* @author You
* @url https://github.com/me/my-plugin
* @plugindesc My plugin
* @help My Plugin
*
* This is my plugin!
*/
```
For more examples, see the [test cases](/test/cases).
## Schema
The JSON schema for the input files is available here: [plugin-metadata.json](https://raw.githubusercontent.com/comuns-rpgmaker/plugin-metadata/master/schema/plugin-metadata.json).
To use it with VS Code, see [this article](https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings).