README.md

Install

Download source code from github and go to project directory run this command:

npm install

Or install by npm directly:

npm install https://github.com/moonyoulove/rpgmaker-plugin-conflict-finder.git --global

Or download single executable app from release page.

Config

Go to project directory, rename .env.example to .env and fill it on demand.

If using executable binary, put .env in the same directory.

EDITOR=
COLOR=

EDITOR used to open the conflict plugin in a text editor. Value can be sublime, atom, vscode, vscodium etc. Details can be found here, but the editor must be set in environment variables to work.

COLOR used to customize the main color of the interface, which can be a color name or hex. For details, see here.

Usage

Use this command in project directory:

node ./cli.js [options]

Or use use this command in anywhere(when installing globally):

rpgmaker-plugin-conflict-finder [options]

Or use single executable app:

./conflict-finder [options]

• On Windows:

  .\conflict-finder.exe [options] 
  

  You can also double-click to open.

Options

Options:
  --project <path>  rpg maker mv/mz project path
  --no-unicode      disable full unicode support for CJK to avoid lag when data is large
  --theme <color>   theme color support color name or hex (default: "cyan")
  --editor <name>   text editor to open conflict plugins
  -h, --help        display help for command

Programming

import { ConflictOutput, findConflict, getOrder } from "rpgmaker-plugin-conflict-finder";
const options = {
    projectPath: "path/to/project",
    fullUnicode: true, // default: true
    themeColor: "#ffffff", // default: cyan
    textEditor: "vscode"
};
const conflicts = findConflict(options.projectPath);
const output = new ConflictOutput(conflicts, options.projectPath, options.fullUnicode, options.themeColor, options.textEditor);
output.show();

TODO