https://github.com/comuns-rpgmaker/schach-fog-of-war
"Fog of war" plugin for immersive dungeons.
https://github.com/comuns-rpgmaker/schach-fog-of-war
Last synced: about 2 months ago
JSON representation
"Fog of war" plugin for immersive dungeons.
- Host: GitHub
- URL: https://github.com/comuns-rpgmaker/schach-fog-of-war
- Owner: comuns-rpgmaker
- License: zlib
- Created: 2022-07-09T22:48:07.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T01:47:27.000Z (over 2 years ago)
- Last Synced: 2025-01-30T16:16:45.843Z (4 months ago)
- Language: TypeScript
- Size: 387 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Schach - Fog of war
This plugin creates a "fog of war" effect on annotated maps.
To enable the effect on a map, add the following tag to the map's notes:
```
[FoW]
```
By default, the player is the only source of "light" that clears the fog.
Events may be annotated to clear the fog, too, by adding the following comment on their command list (once per page;
different pages may have different ranges):
```
[FoW light source (range = N)]
```
Where "N" should be replaced by the radius of the light in tiles.
# Installation
The [Releases](https://github.com/comuns-rpgmaker/schach-fog-of-war/releases) page contains downloadable `.js` files for the plugin.
Refer to the [official plugin installation guide](https://www.rpgmakerweb.com/blog/using-plugins-in-mz) for further information.
## Building from source
This plugin is built with [Node](https://nodejs.org/en/), so make sure you have it installed before continuing.
To build the project, run:
npm ci
npm run build
This will output a file named `schach-fog-of-war.js` on the `dist/js/plugins`
directory and a file named `schach-fog-of-war.debug.js` on `../../js/plugins`.
The relative path is intenteded to be used such that you can clone the plugin
repository into the `js` folder of a RMMZ project and test it easily.
We recommend using [VS Code](https://code.visualstudio.com/) to build and edit
sources, and ready-made settings for building and debugging the
plugin on it are provided.
## License
See [LICENSE](./LICENSE).