Update readme

This commit is contained in:
Fabian Dill 2020-06-19 03:35:21 +02:00 committed by GitHub
parent 7af8a1b5aa
commit e82c4d7bf7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 7 deletions

View File

@ -1,33 +1,35 @@
Berserker's Multiworld
======================
This is a complete fork of Bonta's Multiworld V31.
It is a drop-in replacement with everything from Bonta's Multiworld included.
You can find a guide here: https://docs.google.com/document/d/1r7qs1-MK7YbFf2d-mEUeTy2wHykIf1ALG9pLtVvUbSw/edit#
Or use the Wiki button at the top
A Multiworld implementation for the Legend of Zelda: A Link to the Past Randomizer
For setup and instructions there's a [Wiki](https://github.com/Berserker66/MultiWorld-Utilities/wiki)
Downloads can be found at [Releases](https://github.com/Berserker66/MultiWorld-Utilities/releases), including compiled windows binaries.
Additions/Changes
Additions/Changes compared to Bonta's V31
-----------------
Project
* Available in precompiled form and guided setup for Windows 64Bit on [Releases](https://github.com/Berserker66/MultiWorld-Utilities/releases) page.
* Compatible with Python 3.7 and 3.8. Potentially future versions as well.
* Compatible with Python 3.7 and 3.8. Forward Checks for Python 4.0 are done.
* Update modules if they are too old, preventing a crash when trying to connect among potential other issues
* Autoinstall missing modules
* Allow newer versions of modules than specified, as they will *usually* not break compatibility
* Support for V31 extendedmsu
* Uses "V32" MSU
* Has support for binary patching to allow legal distribution of multiworld rom files
* Various performance improvements (over 100% faster in most cases)
* Various fixes
* Overworld Glitches Logic
* Newer Entrance Randomizer Logic, allowing more potential item and boss locations
* completely redesigned command interface, with `!help` and `/help`
* New Goal: local triforce hunt - limits triforce pieces to your own world so it is your own goal to accomplish
MultiMystery.py
* Allows you to generate a Multiworld with individual player mystery weights. Since weights can also be set to 100%, this also allows for individual settings for each player in a regular multiworld.
Basis is a .yaml file that sets these weights. You can find an [easy.yaml](https://github.com/Berserker66/MultiWorld-Utilities/blob/master/easy.yaml) in this project folder to get started.
* Additional instructions are at the start of the file. Open with a text editor.
* Configuration options in the host.yaml file.
* Allows a new Mode called "Meta-Mystery", allowing certain mystery settings to apply to all players.
* For example, everyone gets the same but random goal.
MultiServer.py
* Supports automatic port-forwarding, can be enabled in host.yaml
@ -35,6 +37,7 @@ Basis is a .yaml file that sets these weights. You can find an [easy.yaml](https
* /forfeit Playername now works when the player is not currently connected
* Added `/hint` and `!hint`, configuration in host.yaml and description in help
* various commands, like /send and /hint use "fuzzy text matching", no longer requiring you to enter a location, player name or item name perfectly
* Some item groups also exist, so `/hint Bottles` lists all bottle varieties
Mystery.py
* Defaults to generating a non-race ROM (Bonta's only makes race ROMs at this time)
@ -47,8 +50,12 @@ If a race ROM is desired, pass --create-race as argument to it
* Option for "glitch_boots", allowing to run glitched modes without automatic boots
* Supports new Meta-Mystery mode. Read [meta.yaml](https://github.com/Berserker66/MultiWorld-Utilities/blob/master/meta.yaml) for details.
* Added `dungeonssimple` and `dungeonsfull` ER modes
* Option for local items
* Option for linked options
* Added 'l' to dungeon_items to have a local-world keysanity
MultiClient.py
* Has a Webbrowser based UI now
* Awaits a QUsb2Snes connection when started, latching on when available
* completely redesigned command interface, with `!help` and `/help`
* Running it with a patch file will patch out the multiworld rom and then automatically connect to the host that created the multiworld