Mido's House Multiworld installer - Revision history

Fenhl: added screenshots

2026-02-11T15:59:00Z

added screenshots

← Older revision		Revision as of 15:59, 11 February 2026
Line 4:		Line 4:

	== Console/emulator selection ==		== Console/emulator selection ==

			[[File:Mhmw-installer-SelectEmulator.png\|thumb]]

	On this page, you choose whether you want to install multiworld for [[EverDrive]], for [[BizHawk]], or for [[Project64]].		On this page, you choose whether you want to install multiworld for [[EverDrive]], for [[BizHawk]], or for [[Project64]].
Line 17:		Line 19:

	== Emulator location ==		== Emulator location ==

			[[File:Mhmw-installer-LocateEmulator.png\|thumb]]

	This step is skipped for EverDrive.		This step is skipped for EverDrive.
Line 29:		Line 33:

	== Emulator installation ==		== Emulator installation ==

			[[File:Mhmw-installer-InstallEmulator.png\|thumb]]

	This step is completely automated for Project64. It is skipped for EverDrive.		This step is completely automated for Project64. It is skipped for EverDrive.
Line 45:		Line 51:

	== Summary ==		== Summary ==

			[[File:Mhmw-installer-AskLaunch.png\|thumb]]

	Once everything has been installed, there's a quick explanation of how to play multiworld. In case you skipped over it, here it is again:		Once everything has been installed, there's a quick explanation of how to play multiworld. In case you skipped over it, here it is again:

Fenhl: added link to macOS install instructions

2024-11-20T09:33:56Z

added link to macOS install instructions

← Older revision		Revision as of 09:33, 20 November 2024
Line 1:		Line 1:
	This article documents the behavior of the installer for [[Mido's House Multiworld]]. ~~The installer~~ can be downloaded from [https://midos.house/mw the Mido's House Multiworld website]. It is ~~currently~~ available for Windows and Linux.		This article documents the behavior of the installer for [[Mido's House Multiworld]]. It can be downloaded from [https://midos.house/mw the Mido's House Multiworld website].

			The installer is only available for Windows and Linux. See [https://midos.house/mw/install/macos install instructions for macOS].

	== Console/emulator selection ==		== Console/emulator selection ==

Fenhl: /* Multiworld location */ updated for emulator launch button feature

2024-11-11T01:08:41Z

Multiworld location: updated for emulator launch button feature

← Older revision		Revision as of 01:08, 11 November 2024
Line 36:		Line 36:
	== Multiworld location ==		== Multiworld location ==

	This step is skipped for Project64 version 4 and for BizHawk, for which the multiworld app is automatically placed in a hidden folder and automatically opened when the emulator plugin is started. For Project64 version 3, both the emulator itself and the multiworld app must be launched manually at the start of each play session.		This step is skipped for Project64 version 4 and for BizHawk, for which the multiworld app is automatically placed in a hidden folder and automatically opened when the emulator plugin is started. For Project64 version 3, both the emulator itself and the multiworld app must be launched manually at the start of each play session (though the multiworld app will have a button to launch Project64).

	On this page, you choose where to place the multiworld app. The default location is <code>%LOCALAPPDATA%\Programs\Mido's House Multiworld.exe</code> on Windows, or <code>~/bin/mhmw</code> on Linux.		On this page, you choose where to place the multiworld app. The default location is <code>%LOCALAPPDATA%\Programs\Mido's House Multiworld.exe</code> on Windows, or <code>~/bin/mhmw</code> on Linux.

Fenhl: updated for EverDrive support, some corrections for Linux

2024-04-29T06:01:16Z

updated for EverDrive support, some corrections for Linux

← Older revision		Revision as of 06:01, 29 April 2024
Line 1:		Line 1:
	This article documents the behavior of the installer for [[Mido's House Multiworld]]. The installer can be downloaded from [https://midos.house/mw the Mido's House Multiworld website]. It is currently available for Windows and Linux.		This article documents the behavior of the installer for [[Mido's House Multiworld]]. The installer can be downloaded from [https://midos.house/mw the Mido's House Multiworld website]. It is currently available for Windows and Linux.

	== ~~Emulator~~ selection ==		== Console/emulator selection ==

	On this page, you choose whether you want to install multiworld for [[BizHawk]] or for [[Project64]]. The installer supports both installing multiworld for an existing copy of the selected emulator, as well as installing a new copy of the emulator itself. The choice between these two modes is made on the next page.		On this page, you choose whether you want to install multiworld for [[EverDrive]], for [[BizHawk]], or for [[Project64]].

	~~If there is only one supported emulator (which~~ is currently the ~~case~~ on ~~Linux, where only~~ [[~~BizHawk~~]~~] is supported)~~, ~~this page is skipped and~~ the ~~supported~~ emulator is ~~selected automatically~~.		* For EverDrive, the installer will display a warning since EverDrive support is currently experimental and requires [https://ootrandomizer.com/generatorDev?version=devFenhl_ Fenhl's branch of the randomizer]. Progress on stabilizing EverDrive support is tracked in [https://github.com/midoshouse/ootr-multiworld/issues/23 this Mido's House Multiworld issue] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2042 this randomizer issue].
			* For emulators, the installer supports both installing multiworld for an existing copy of the selected emulator, as well as installing a new copy of the emulator itself. The choice between these two modes is made on the next page.

	== Admin permissions ==		== Admin permissions ==

	On Windows, installing multiworld for [[Project64]] requires administrator permissions. The installer will display a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt to reopen itself as administrator. The original installer window will remain open and display a message asking you to use the new instance instead.		On Windows, installing multiworld for [[Project64]] requires administrator permissions. The installer will display a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt to reopen itself as administrator. The original installer window will remain open and display a message asking you to use the new instance instead.

			On Linux, installing [[BizHawk]] requires root permissions. The installer will use [https://en.wikipedia.org/wiki/Zenity Zenity] to prompt for your password in order to use [https://en.wikipedia.org/wiki/APT_(software) APT] to install [https://en.wikipedia.org/wiki/Mono_(software) Mono]. If Zenity and/or APT are not available, the installer will skip this step and you should install Mono manually.

	== Emulator location ==		== Emulator location ==

			This step is skipped for EverDrive.

	On this page, you choose whether to install multiworld for an existing copy of the selected emulator or to install the emulator as well. You can select the emulator installation folder, either to locate an existing emulator installed at an unusual location or to customize where to install it. The selected path should be the folder containing the emulator, not the emulator executable itself.		On this page, you choose whether to install multiworld for an existing copy of the selected emulator or to install the emulator as well. You can select the emulator installation folder, either to locate an existing emulator installed at an unusual location or to customize where to install it. The selected path should be the folder containing the emulator, not the emulator executable itself.
Line 17:		Line 22:
	== Emulator update ==		== Emulator update ==

	This step is currently only implemented for BizHawk, it is skipped for Project64. You can check [https://www.pj64-emu.com/ the Project64 website] for updates if you'd like.		This step is currently only implemented for BizHawk, it is skipped for EverDrive and Project64. You can check [https://www.pj64-emu.com/ the Project64 website] for updates if you'd like.

	Each version of Mido's House Multiworld only works with exactly one version of BizHawk. If the installer detects an older version of BizHawk, it will offer to automatically update it. Note that updating BizHawk can sometimes break the emulator settings. In this case, the new BizHawk version will display an error message saying “It appears your config file (config.ini) is corrupted” when it's opened. '''<span style="color:red">DO NOT close or click OK on the error message!</span>''' Make a backup of the file <code>config.ini</code> in your BizHawk folder first. It can be used with a “diff” tool to salvage your settings. See [https://github.com/TASEmulators/BizHawk/issues/2094 BizHawk issue #2094] for details.		Each version of Mido's House Multiworld only works with exactly one version of BizHawk. If the installer detects an older version of BizHawk, it will offer to automatically update it. Note that updating BizHawk can sometimes break the emulator settings. In this case, the new BizHawk version will display an error message saying “It appears your config file (config.ini) is corrupted” when it's opened. '''<span style="color:red">DO NOT close or click OK on the error message!</span>''' Make a backup of the file <code>config.ini</code> in your BizHawk folder first. It can be used with a “diff” tool to salvage your settings. See [https://github.com/TASEmulators/BizHawk/issues/2094 BizHawk issue #2094] for details.
Line 23:		Line 28:
	== Emulator installation ==		== Emulator installation ==

	This step is completely automated for Project64.		This step is completely automated for Project64. It is skipped for EverDrive.

	If BizHawk is being installed on Windows, there will be a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt, and then the [https://github.com/TASEmulators/BizHawk-Prereqs BizHawk-Prereqs] installer will pop up and you will need to click through it.		If BizHawk is being installed on Windows, there will be a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt, and then the [https://github.com/TASEmulators/BizHawk-Prereqs BizHawk-Prereqs] installer will pop up and you will need to click through it.
Line 33:		Line 38:
	This step is skipped for Project64 version 4 and for BizHawk, for which the multiworld app is automatically placed in a hidden folder and automatically opened when the emulator plugin is started. For Project64 version 3, both the emulator itself and the multiworld app must be launched manually at the start of each play session.		This step is skipped for Project64 version 4 and for BizHawk, for which the multiworld app is automatically placed in a hidden folder and automatically opened when the emulator plugin is started. For Project64 version 3, both the emulator itself and the multiworld app must be launched manually at the start of each play session.

	On this page, you choose where to place the multiworld app. The default location is <code>%LOCALAPPDATA%\Programs</code>.		On this page, you choose where to place the multiworld app. The default location is <code>%LOCALAPPDATA%\Programs\Mido's House Multiworld.exe</code> on Windows, or <code>~/bin/mhmw</code> on Linux.

	~~There~~ is also an option to create a desktop shortcut. Regardless of whether this is selected, the app will be added to the program list in the Start menu (this is not the same as a Start menu shortcut, which must be created manually if desired).		On Windows, there is also an option to create a desktop shortcut. Regardless of whether this is selected, the app will be added to the program list in the Start menu (this is not the same as a Start menu shortcut, which must be created manually if desired).

	== Summary ==		== Summary ==
Line 41:		Line 46:
	Once everything has been installed, there's a quick explanation of how to play multiworld. In case you skipped over it, here it is again:		Once everything has been installed, there's a quick explanation of how to play multiworld. In case you skipped over it, here it is again:

			* '''EverDrive:''' Open the “Mido's House Multiworld” app and follow its instructions.
	* '''BizHawk:''' In BizHawk, select Tools → External Tool → Mido's House Multiworld.		* '''BizHawk:''' In BizHawk, select Tools → External Tool → Mido's House Multiworld.
	* '''Project64 version 3:''' Open the “Mido's House Multiworld” app and follow its instructions.		* '''Project64 version 3:''' Open the “Mido's House Multiworld” app and follow its instructions.
	* '''Project64 version 4:''' In Project64, select Debugger → Scripts → ootrmw.js and click Run.		* '''Project64 version 4:''' In Project64, select Debugger → Scripts → ootrmw.js and click Run.

	Finally, the installer will offer to open the emulator right now.		Finally, the installer will offer to open the multiworld app and the emulator (if any) right now.

Fenhl: /* Multiworld location */ updated for changes in version 15.1.0

2024-01-30T18:09:40Z

Multiworld location: updated for changes in version 15.1.0

← Older revision		Revision as of 18:09, 30 January 2024
Line 31:		Line 31:
	== Multiworld location ==		== Multiworld location ==

	This step is skipped for Project64 version 4 and for BizHawk, for which the multiworld app is automatically placed in a hidden folder and automatically opened when the emulator plugin is started.		This step is skipped for Project64 version 4 and for BizHawk, for which the multiworld app is automatically placed in a hidden folder and automatically opened when the emulator plugin is started. For Project64 version 3, both the emulator itself and the multiworld app must be launched manually at the start of each play session.

	On this page, you choose where to place the multiworld app~~. For Project64 version 3, both the emulator itself and the multiworld app must be launched manually at the start of each play session, so you should place the app somewhere you'll find it again later~~. The default location is ~~a folder named~~ <code>~~bin~~</code> in the ~~user folder~~.		On this page, you choose where to place the multiworld app. The default location is <code>%LOCALAPPDATA%\Programs</code>.

			There is also an option to create a desktop shortcut. Regardless of whether this is selected, the app will be added to the program list in the Start menu (this is not the same as a Start menu shortcut, which must be created manually if desired).

	== Summary ==		== Summary ==

Fenhl: added supported operating systems to lede

2024-01-28T10:28:05Z

added supported operating systems to lede

← Older revision		Revision as of 10:28, 28 January 2024
Line 1:		Line 1:
	This article documents the behavior of the installer for [[Mido's House Multiworld]]. The installer can be downloaded from [https://midos.house/mw the Mido's House Multiworld website].		This article documents the behavior of the installer for [[Mido's House Multiworld]]. The installer can be downloaded from [https://midos.house/mw the Mido's House Multiworld website]. It is currently available for Windows and Linux.

	== Emulator selection ==		== Emulator selection ==

Fenhl: /* Emulator update */ clarified BizHawk update error message instructions

2024-01-09T22:37:11Z

Emulator update: clarified BizHawk update error message instructions

← Older revision		Revision as of 22:37, 9 January 2024
Line 19:		Line 19:
	This step is currently only implemented for BizHawk, it is skipped for Project64. You can check [https://www.pj64-emu.com/ the Project64 website] for updates if you'd like.		This step is currently only implemented for BizHawk, it is skipped for Project64. You can check [https://www.pj64-emu.com/ the Project64 website] for updates if you'd like.

	Each version of Mido's House Multiworld only works with exactly one version of BizHawk. If the installer detects an older version of BizHawk, it will offer to automatically update it. Note that updating BizHawk can sometimes break the emulator settings. In this case, the new BizHawk version will display an error message saying “It appears your config file (config.ini) is corrupted” when it's opened. '''<span style="color:red">DO NOT close or click OK!</span>''' Make a backup of the file <code>config.ini</code> in your BizHawk folder first. It can be used with a “diff” tool to salvage your settings. See [https://github.com/TASEmulators/BizHawk/issues/2094 BizHawk issue #2094] for details.		Each version of Mido's House Multiworld only works with exactly one version of BizHawk. If the installer detects an older version of BizHawk, it will offer to automatically update it. Note that updating BizHawk can sometimes break the emulator settings. In this case, the new BizHawk version will display an error message saying “It appears your config file (config.ini) is corrupted” when it's opened. '''<span style="color:red">DO NOT close or click OK on the error message!</span>''' Make a backup of the file <code>config.ini</code> in your BizHawk folder first. It can be used with a “diff” tool to salvage your settings. See [https://github.com/TASEmulators/BizHawk/issues/2094 BizHawk issue #2094] for details.

	== Emulator installation ==		== Emulator installation ==

Fenhl: Created page with "This article documents the behavior of the installer for Mido's House Multiworld. The installer can be downloaded from [https://midos.house/mw the Mido's House Multiworld website]. == Emulator selection == On this page, you choose whether you want to install multiworld for BizHawk or for Project64. The installer supports both installing multiworld for an existing copy of the selected emulator, as well as installing a new copy of the emulator itself. The cho..."

2024-01-09T22:34:52Z

Created page with "This article documents the behavior of the installer for Mido's House Multiworld. The installer can be downloaded from [https://midos.house/mw the Mido's House Multiworld website]. == Emulator selection == On this page, you choose whether you want to install multiworld for BizHawk or for Project64. The installer supports both installing multiworld for an existing copy of the selected emulator, as well as installing a new copy of the emulator itself. The cho..."

New page

This article documents the behavior of the installer for [[Mido's House Multiworld]]. The installer can be downloaded from [https://midos.house/mw the Mido's House Multiworld website].

== Emulator selection ==

On this page, you choose whether you want to install multiworld for [[BizHawk]] or for [[Project64]]. The installer supports both installing multiworld for an existing copy of the selected emulator, as well as installing a new copy of the emulator itself. The choice between these two modes is made on the next page.

If there is only one supported emulator (which is currently the case on Linux, where only [[BizHawk]] is supported), this page is skipped and the supported emulator is selected automatically.

== Admin permissions ==

On Windows, installing multiworld for [[Project64]] requires administrator permissions. The installer will display a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt to reopen itself as administrator. The original installer window will remain open and display a message asking you to use the new instance instead.

== Emulator location ==

On this page, you choose whether to install multiworld for an existing copy of the selected emulator or to install the emulator as well. You can select the emulator installation folder, either to locate an existing emulator installed at an unusual location or to customize where to install it. The selected path should be the folder containing the emulator, not the emulator executable itself.

== Emulator update ==

This step is currently only implemented for BizHawk, it is skipped for Project64. You can check [https://www.pj64-emu.com/ the Project64 website] for updates if you'd like.

Each version of Mido's House Multiworld only works with exactly one version of BizHawk. If the installer detects an older version of BizHawk, it will offer to automatically update it. Note that updating BizHawk can sometimes break the emulator settings. In this case, the new BizHawk version will display an error message saying “It appears your config file (config.ini) is corrupted” when it's opened. '''<span style="color:red">DO NOT close or click OK!</span>''' Make a backup of the file <code>config.ini</code> in your BizHawk folder first. It can be used with a “diff” tool to salvage your settings. See [https://github.com/TASEmulators/BizHawk/issues/2094 BizHawk issue #2094] for details.

== Emulator installation ==

This step is completely automated for Project64.

If BizHawk is being installed on Windows, there will be a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt, and then the [https://github.com/TASEmulators/BizHawk-Prereqs BizHawk-Prereqs] installer will pop up and you will need to click through it.

If BizHawk is being installed on Linux, the multiworld installer will attempt to use <code>zenity</code> and <code>apt</code> to install [https://www.mono-project.com/ Mono]. On Ubuntu, both of these programs are installed by default. If you're on a different distribution, you may have to manually install <code>mono-complete</code> or similar.

== Multiworld location ==

This step is skipped for Project64 version 4 and for BizHawk, for which the multiworld app is automatically placed in a hidden folder and automatically opened when the emulator plugin is started.

On this page, you choose where to place the multiworld app. For Project64 version 3, both the emulator itself and the multiworld app must be launched manually at the start of each play session, so you should place the app somewhere you'll find it again later. The default location is a folder named <code>bin</code> in the user folder.

== Summary ==

Once everything has been installed, there's a quick explanation of how to play multiworld. In case you skipped over it, here it is again:

* '''BizHawk:''' In BizHawk, select Tools → External Tool → Mido's House Multiworld.
* '''Project64 version 3:''' Open the “Mido's House Multiworld” app and follow its instructions.
* '''Project64 version 4:''' In Project64, select Debugger → Scripts → ootrmw.js and click Run.

Finally, the installer will offer to open the emulator right now.