diff --git a/README.md b/README.md index fdc7a55..73335c1 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ # Endless Void -This repository contains the project file of the Endless Void level editor for Void Stranger, the UndertaleModTool script to merge it into the game (merger.csx), -scripts to add and remove game assets from the project (located in the assetscripts folder), and patches applied to the game on-merge (/patches). -Very much a work-in-progress. Will eventually send data to a [Voyager](https://github.com/hexfae/voyager) server. +Endless Void is a fully functional level editor for Void Stranger. + +You can create your own levels with it, and upload them to a server (a [Voyager](https://github.com/hexfae/voyager) instance). + +This repository contains its project file, the UndertaleModTool script used to merge it into the game (merger.csx), +UndertaleModTool scripts to add and remove game assets from the project (located in the assetscripts folder), and patches applied to the game on-merge (/patches). The project is set up like this, as opposed to just a plain UndertaleModTool mod, for several reasons: - Much faster iteration @@ -14,9 +17,11 @@ The project is set up like this, as opposed to just a plain UndertaleModTool mod - The project file was generated by GameMaker 2022.9.1.51 and should stay at that version, as Void Stranger was compiled with a 2022.9.X runtime. - Indices of objects, sprites, sounds, etc. become mismatched when merging with Void Stranger, so references to them are always obtained with `asset_get_index()`. This does not apply to animation curves, as Void Stranger never uses them, and so their indicies are not offset. +- Semicolons are lightly and inconsistently sprinkled throughout, because of muscle memory, but GameMaker does not enforce them... +- It's uh, pretty good, occasionally. # Compiling - Run the `copier.csx` script on Void Stranger's data.win from the assetscripts folder to copy all the required Void Stranger assets into the project - From this point you can compile and run the editor on its own - To merge it into the game, compile and copy the data.win of the editor and run the `merger.csx` script on Void Stranger's data.win, and save it when it's done -- Make sure to replace the directories at the top of the scripts with your own \ No newline at end of file +- Make sure to replace the directories at the top of the scripts with your own