diff --git a/README.md b/README.md index f3bb1fe3..d6b459cb 100644 --- a/README.md +++ b/README.md @@ -25,21 +25,22 @@ This is a very new mode of LTTPR so the tools and info is very limited. - There - In Mixed OW Tile Swap, Smith and Stumpy have issues when their tiles are swapped. Progression cannot be found on them when these tiles are swapped - Screens that loop on itself and also have free-standing items, the sprites are duplicated and can cause item duplication - When OWG are performed to enter mega-tile screens (large OW screens), there is a small chance that an incorrect VRAM reference value causes the map graphics to offset in increments of 16 pixels -- There may be an issue with progression being front-loaded in the seed in some scenarios, due to an unsophisticated shuffle algorithm that could make varying-sized parts of each world unreachable # Feedback and Bug Reports All feedback and dev conversation happens in the #ow-rando channel on the [ALTTP Randomizer discord](https://discordapp.com/invite/alttprandomizer). -# Installation from source +# Installation from Source See these instructions. https://github.com/codemann8/ALttPDoorRandomizer/blob/OverworldShuffle/docs/BUILDING.md -When installing platform specific dependencies, don't forget to run the appropriate command from the bottom of the page! Those will install missing pip dependencies. +This program requires all python dependencies that are necessary to run Aerinon's Door Randomizer plus an additional 'sortedcontainers' package. Try running ```pip install sortedcontainers``` on the command line to install the dependency. -Running the MultiServer and MultiClient for multiworld should run resources/ci/common/local_install.py for those dependencies as well. +Alternatively, run ```resources/ci/common/local_install.py``` to install all the missing dependencies as well. + +# Running the Program To use the CLI, run ```DungeonRandomizer.py```.