Initial commit.

.gitignore

@@ -0,0 +1,3 @@
+.idea
+*~
+release.zip

Makefile

@@ -0,0 +1,17 @@
+.PHONY: demo
+all: concat docs demo
+concat:	src/*.js
+	cat src/Plugin.js > Transitions.js
+	printf "\r\n\r\n" >> Transitions.js
+	cat src/Base.js >> Transitions.js
+	printf "\r\n\r\n" >> Transitions.js
+	find src/* \( ! -name Plugin.js -a ! -name Base.js \) -exec cat '{}' >> Transitions.js \; -exec printf "\r\n\r\n" >> Transitions.js \;
+docs: src/*.js jsdoc-conf.json
+	jsdoc -c jsdoc-conf.json
+demo: .PHONY
+	cp Transitions.js demo/js/plugins/Transitions.js
+	zip -r release.zip demo
+clean:
+	rm -f Transitions.js
+	rm -rf docs
+	rm -rf release.zip

README.md

@@ -0,0 +1,65 @@
+Transitions Plugin for RPG Maker MV
+===================================
+
+This JavaScript plugin for [RPG Maker MV](http://www.rpgmakerweb.com/products/programs/rpg-maker-mv) replaces the default fading behaviour with a transition system.
+
+Transitions can be configured independently, by using plugin commands, for:
+- scene to scene transitions,
+- in-Event fades,
+- player's transfers,
+- battles.
+
+Other than the basic transition (which imitates the default fading), the following transitions are implemented:
+
+- Cut: the screen is cut in two slices, sliding side by side
+
+![Cut battle transition](screenshots/battlecut.gif)
+
+![Cut fade transition](screenshots/fadecut.gif)
+
+![Cut transfer transition](screenshots/transfercut.gif)
+
+- Melt: the screen melts down
+
+![Melt transfer transition](screenshots/transfermelt.gif)
+
+- Iris: the screen opens like a camera's iris
+
+![Iris transfer transition](screenshots/transferiris.gif)
+
+
+Instructions
+------------
+
+Download the [latest release](releases/latest) (alternatively compile your own using the Makefile) and load the plugin.
+
+At any time invoke the plugin with `SetTransfer mode transition`, with `mode` one of:
+- `battle`: transition before each encounter,
+- `transfer`: transition on player transfer,
+- `fade`: transition invoked from events,
+- `base`: transition between scenes;
+
+...and `transition` one of:
+- `base`,
+- `cut`,
+- `iris`,
+- `melt`.
+
+For example, to change the battle transition to `melt` you can call:
+
+    SetTransition battle melt
+
+A demo can be downloaded in the release section, or played online [here](https://strontiumaluminate.altervista.org/transitions/).
+
+Adding new transitions
+----------------------
+
+You can add new transitions by extending the `Transition_Base` class (see the [documentation](https://HashakGik.github/Transitions-RMMV) and adding the line:
+
+    my.transitions['class'] = "my.Transition_class";
+
+where the hash key is the string used in the plugin calls and the value is the class name.
+
+**Important**: the class name must start with `Transition_`, in order to be correctly parsed.
+
+Finally, you can recompile the entire script or load your transition as a separate plugin.