{"id":20547205,"url":"https://github.com/comuns-rpgmaker/plugin-metadata","last_synced_at":"2025-04-14T10:33:43.694Z","repository":{"id":40281639,"uuid":"291562175","full_name":"comuns-rpgmaker/plugin-metadata","owner":"comuns-rpgmaker","description":"Automated tool for plugin annotation validation and generation","archived":false,"fork":false,"pushed_at":"2023-01-07T06:52:11.000Z","size":153,"stargazers_count":3,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T23:41:53.935Z","etag":null,"topics":["json-schema","metadata","plugin","rpgmaker","rpgmakermz"],"latest_commit_sha":null,"homepage":"https://comuns-rpgmaker.github.io/plugin-metadata","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"zlib","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/comuns-rpgmaker.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-30T22:27:37.000Z","updated_at":"2022-10-16T14:52:42.000Z","dependencies_parsed_at":"2023-02-06T14:20:15.470Z","dependency_job_id":null,"html_url":"https://github.com/comuns-rpgmaker/plugin-metadata","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comuns-rpgmaker%2Fplugin-metadata","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comuns-rpgmaker%2Fplugin-metadata/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comuns-rpgmaker%2Fplugin-metadata/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comuns-rpgmaker%2Fplugin-metadata/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/comuns-rpgmaker","download_url":"https://codeload.github.com/comuns-rpgmaker/plugin-metadata/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248650504,"owners_count":21139677,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["json-schema","metadata","plugin","rpgmaker","rpgmakermz"],"created_at":"2024-11-16T02:06:40.747Z","updated_at":"2025-04-14T10:33:43.660Z","avatar_url":"https://github.com/comuns-rpgmaker.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Plugin Metadata\n\n![Docs](https://github.com/comuns-rpgmaker/plugin-metadata/workflows/Docs/badge.svg)\n![Node.js Package](https://github.com/comuns-rpgmaker/plugin-metadata/workflows/Node.js%20Package/badge.svg)\n![Tests](https://github.com/comuns-rpgmaker/plugin-metadata/actions/workflows/tests.yml/badge.svg)\n[![codecov](https://codecov.io/gh/comuns-rpgmaker/plugin-metadata/branch/master/graph/badge.svg?token=2CSXQBBOS3)](https://codecov.io/gh/comuns-rpgmaker/plugin-metadata)\n\nPlugin metadata validation and generation tool.\n\n## Getting started\n\nFirst of all, be sure you have Node installed.\n\nYou can install this tool globally with:\n\n    npm install -g @comuns-rpgmaker/plugin-metadata\n\n\n## Usage\n\n```\nOptions:\n  --version     Shows the version                                [boolean]\n  --input, -i   Input metadata file                               [string]\n  --output, -o  Output file (default: stdout)                     [string]\n  --help, -h    Shows help                                       [boolean]\n```\n\nThe CLI receives an input file (if none is given, `./plugin-metadata.json` is\nassumed) and an output file (if none is given, `stdout` is assumed).\n\nThe input file must follow the schema specified in\n[`./schema/plugin-metadata.json`](./schema/plugin-metadata.json). It accepts\nboth JSON and YAML files.\n\nFor instance, suppose we have the following YAML file (`plugin-metadata.yaml`):\n\n```yaml\ntarget: MZ\nauthor: You\nurl: https://github.com/me/my-plugin\ndescription: My plugin\nhelp: |-\n  My Plugin\n\n  This is my plugin!\n```\n\nWhen we run this on the CLI (if it doesn't work, try `npm link`):\n\n    mz-mtdt -i plugin-metadata.yaml\n\nWe get the following output:\n\n```js\n/*:\n * @target MZ\n * @author You\n * @url https://github.com/me/my-plugin\n * @plugindesc My plugin\n * @help My Plugin\n *\n * This is my plugin!\n */\n```\n\nFor more examples, see the [test cases](/test/cases).\n\n## Schema\n\nThe 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).\n\nTo use it with VS Code, see [this article](https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings).\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomuns-rpgmaker%2Fplugin-metadata","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcomuns-rpgmaker%2Fplugin-metadata","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomuns-rpgmaker%2Fplugin-metadata/lists"}