Files
alttpr-python/README.md
2019-12-23 13:56:47 -07:00

56 lines
1.5 KiB
Markdown

# ALttPDoorRandomizer
This is a door randomizer for _The Legend of Zelda: A Link to the Past_ for the SNES
based on the Entrance Randomizer found at [KevinCathcart's Github Project.](https://github.com/KevinCathcart/ALttPEntranceRandomizer)
See https://alttpr.com/ for more details on the normal randomizer.
# Known Issues
[List of Known Issues and Their Status](https://docs.google.com/document/d/1Bk-m-QRvH5iF60ndptKYgyaV7P93D3TiG8xmdxp_bdQ/edit?usp=sharing)
# Feedback and Bug Reports
Please just DM me on discord for now. I (Aerinon) can be found at the [ALTTP Randomizer discord](https://discordapp.com/invite/alttprandomizer).
# Installation
Clone this repository and then run ```DungeonRandomizer.py``` (requires Python 3).
Alternatively, run ```Gui.py``` for a simple graphical user interface. (WIP)
# Settings
Only extra settings are found here. All entrance randomizer settings are supported. See their [readme](https://github.com/KevinCathcart/ALttPEntranceRandomizer/blob/master/README.md)
## Door Shuffle
### Basic
Doors are shuffled only within a single dungeon.
### Crossed
Doors are shuffled between dungeons as well.
### Vanilla
Doors are not shuffled.
### Experimental
Used for development testing. This will be removed in a future version. Use at your own risk. Might play like a plando.
# Command Line Options
```
-h, --help
```
Show the help message and exit.
```
--door_shuffle
```
For specifying the door shuffle you want as above. (default: basic)