- May 14, 2012
- Reaction score
- First Language
- Primarily Uses
Knight Editor is an extension of Yanfly's Grid-Free Doodads plugin that is designed for use with mouse point-and-click controls. Yanfly's plugin is very useful for parallax mapping, but sometimes editing maps with keyboard-controlled menus can feel a bit sluggish. That's where this plugin comes in!
To use this plugin, you must do the following:
- Install Yanfly's Grid Free Doodads plugin in your project, as per the plugin instructions. Make sure it works correctly before continuing.
- Download the Knight Editor plugin files.
- Copy the KNT_Editor.js plugin into your plugins folder.
- Copy the gui folder that comes with this plugin into your project's img folder.
- Copy the pixi-filters.js file that comes with this plugin into your project's /js/libs folder. This should be the same folder that contains your project's other pixi files.
- Replace your project's index.htmlfile with the one that comes with this plugin.
- Alternatively, if you'd like to keep your current index.html file, insert the following line inside the <body></body> tag of your index file, after all other pixi-___.js files:
- Place this plugin below Yanfly's plugin in your load order and configure the plugin parameters to your liking.
- Load your project in play-test mode, and press F10 to verify the plugin is working.
Note that I cannot redistribute Yanfly's own plugin under their terms, so the sample project only has a placeholder YEP_GridFreeDoodads.js file. Please get a copy of the plugin from Yanfly's website and replace the one inside the sample project to run it.
Features & Usage Instructions
Knight Editor retains most of the features you're used to from Yanfly's plugin, while adding a few new details. To place doodads:
- Press the F10 key to bring up the editor UI
- Click on a doodad folder at the bottom right of the screen
- Click on the image of one of the loaded doodads to select it
- ..and left-click anywhere on the map to place it! It's that simple
- To unselect a doodad, right-click anywhere on the map
- Doodad Selection
If there are more doodads than fit in the visible space in either the Doodad Folder or Doodad Selection windows, you can scroll the contents by using the mouse wheel.
- The Doodad Edit Panel
Click on an already placed doodad to bring up its properties panel and further modify it. You can also edit the properties of new doodads as you're placing them.
- Selection Highlights
The Editor will highlight your currently selected doodad to make it easier to distinguish from other similar doodads placed on the map. However, sometimes the effect can interfere with the doodad's appearance in ways that make it hard to edit or hard to look at. To address this, the editor has several different ways of highlighting your current selection. You can choose which one is used in the plugin parameters.
- Additional Configuration
- Import (Hotkey: I)
- Save (Hotkey: Ctrl + S)
If you forget whether your map has any unsaved edits, you can check the save indicator at the bottom of the screen. There will be an asterisk(*) shown next to the Doodad tab on the toolbar.
- Minimize (Hotkey: N)
- Undo (Hotkey: Ctrl + Z)
- Delete All
- Region Toggle (Hotkey: R)
- Revert Settings (Hotkey: Backspace)
- Copy (Hotkey: C)
- Delete (Hotkey: Del)
- Map Scroll (Hotkeys: W A S D)
- Change Layer (Hotkey: Mouse Wheel)
- Change Scale (Hotkey: Z X)
- Rotate (Hotkey: Q E)
- Change Opacity (Hotkey: Number Keys)
- Toggle Grid Lock Mode (Hotkey: G)
These are all summarized in the plugin description, so look there if you forget!
This can almost be used in the same way you use Yanfly's original plugin. However, there are a few additional restrictions:
- Subfolders are not supported. All doodads must be in a folder of the form 'doodads/category/doodad.png'. So, 'doodads/Plants/Tree1.png' is OK, but 'doodads/Plants/Trees/Tree1.png' is not. In this case, please move the Tree folder, so it's directly under 'doodads/'.
- Hue has been replaced entirely by Tone for color changes. If you load a map with existing doodads that have Hue changes, they will be lost . In that case, please re-adjust colors using the Tone sliders instead. This was done because adjusting Hue is significantly slower than adjusting Tone for sprites, and I want to avoid supporting features that can lead to laggy maps.
This plugin may be freely used in any free or commercial project. You are free to modify this plugin, as long you credit the original author when doing so. Redistribution is not prohibited, but it's best avoided as you may end up sharing a copy that is out of date. Instead, I recommend sharing the plugin by linking to its Gitlab page.
If you use this plugin to develop your project, credits are appreciated but not required.
The 'Grid Free Doodads' plugin was originally written by Yanfly:
Icons used under the free licence from:
pixi-filters is provided under the MIT license:
As of version 1.1, Yanfly's 'Extended Doodad Pack 1' plugin is supported. Make sure to include it before the Knight Editor in your load order.
This plugin was made with MV version 1.6.1, so I can't guarantee compatibility with any older versions. I don't use older MV versions, so I don't have any plans of adding support for them.
Other than that, there shouldn't be any major compatibility issues. Let me know if you have any problems.