From 655967f5440a2a9a195b021d14b628b2a325732e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lilian=20J=C3=B3nsd=C3=B3ttir?= Date: Tue, 28 Jul 2020 21:48:43 -0700 Subject: [PATCH] updated readme --- README.md | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b0118a5..b3334a5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,32 @@ -# Morrowind-Door-Randomizer -A Morrowind MWSE-Lua mod to randomize the destinations of cell-change doors. +# Morrowind Door Randomizer # + +## About ## + +A Morrowind MWSE-Lua mod to randomize the destinations of cell-change doors. + +I discovered that tes3.setDestination() was a thing, so I wrote this. + +## Mod configuration menu ## + +* Percent chance to randomize doors on activate +* Enable/Disable choosing of Wilderness cells +* Enable/Disable choosing of cells without a door to place the player at +* Choose only: + * Interior cells + * Exterior cells + * Both + * Match destination cell +* Ignore list for cells +* Debug logging, to see my cool recursive functions at work + +## Requirements ## +MWSE 2.1 nightly @ [github](https://github.com/MWSE/MWSE) + +## Credits ## + +* MWSE Team for MWSE with Lua support +* Morrowind Modding Discord as always, for essentially being the MWSE docs + +## License ## + +MIT License. See LICENSE file.