morgan/Grinch-AP
1
0
Fork 0
mirror of https://github.com/MarioSpore/Grinch-AP.git synced 2025-10-21 20:21:32 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
265ee7098afdb9186755eb8673cdc39ff37ada7f
Grinch-AP/worlds/zillion/docs/setup_en.md
Doug Hoskisson 265ee7098a New Game: Zillion (#1081) 
* Option RangeWithSpecialMax

* amendment to typing in web options

* compare string with number

* lots of work on zillion

* fix zillion fill logic

* fix a few more issues in zillion fill logic

* can make zillion patch and use it

* put multi items in zillion rom

* work on ZillionClient

* logging and auth in client

* work on sending and receiving items

* implement item_handling flag

* fix locations ids to NuktiServer package

* use rewrite of zri

* cache logic rule data for performance

* use new id maps

* fix some problems with the big recent merge

* ZillionClient: use new context manager for Memory class

* fix ItemClassification for Zillion items
and some debug statements for asserts,
documentation on running scripts for manual testing
type correction in CommonContext

* fix some issues in client, start on docs, put rescue and item ram addresses in slot data

* use new location name system
fix item locations getting out of sync in progression balancing

* zillion client can read slot name from game

* zillion: new item names

* remove extra unneeded import

* newer options (room gen and starting cards)

* update comment in zillion patch

* zillion non static regions

* change some logging, update some comments

* allow ZillionClient to exit in certain situations

* todo note to fix options doc strings

* don't force auto forfeit

* rework validation of floppy requirement and item counts
and fix race condition in generate_output

* reorganize Zillion component structure
with System class

* documentation updates for Zillion

* attempt inno_setup.iss

* remove todo comment for something done

* update comment

* rework item count zillion options
and some small cleanups

* fix location check count

* data package version 1

* Zillion can pass unit tests without rom

* fix freeze if closing ZillionClient while it's waiting for server login

* specify commit hash for zilliandomizer package

* some changes to options validation

* Zillion doors saved on multiworld server

* add missing function in inno_setup
and name of vanilla continues in options

* rework zillion sync task and context

* Apply documentation suggestions from SoldierofOrder

Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com>

* update zillion package

* workaround for asyncio udp bug

There is a bug in Python in Windows
https://github.com/python/cpython/issues/91227
that makes it so if I look for RetroArch before it's ready, it breaks the asyncio udp transport system.

As a workaround, we don't look for RetroArch until the user asks for it with /sms

* a few of the smaller suggestions from review

* logic only looks at my locations
instead of all the multiworld locations

* some adjustments from pull request discussion
and some unit tests

* patch webhost changes from pull request discussion

* zillion logic tests

* better vblr test

* test interaction of character rescue items with logic

* move unit tests to new worlds folder

* comment improvements

* fix minor logic issue
and add memory read timeout

* capitalization in option display names
Opa-Opa is a proper noun

* redirect zz stdout to debug

* fix option validation bug making unbeatable seeds

* remove line that does nothing

* attach logic cache to world

Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com>
Co-authored-by: Doug Hoskisson <doughoskisson@novuslabs.com>
2022-10-20 19:41:11 +02:00

5.7 KiB
Raw Blame History

Zillion Setup Guide

Required Software

  • Archipelago. Make sure to check the box for Zillion Client - Zillion Patch Setup

  • RetroArch 1.10.3 or newer from: RetroArch Website.

  • Your legally obtained Zillion ROM file, named Zillion (UE) [!].sms

Installation Procedures

RetroArch

RetroArch 1.9.x will not work, as it is older than 1.10.3.

  1. Enter the RetroArch main menu screen.
  2. Go to Main Menu --> Online Updater --> Core Downloader. Scroll down and install "Sega - MS/GG (SMS Plus GX)".
  3. Go to Settings --> User Interface. Set "Show Advanced Settings" to ON.
  4. Go to Settings --> Network. Set "Network Commands" to ON. (It is found below Request Device 16.) Leave the default Network Command Port at 55355.

Screenshot of Network Commands setting

Linux Setup

Put your Zillion ROM file in the Archipelago directory in your home directory.

Windows Setup

  1. During the installation of Archipelago, install the Zillion Client. If you did not do this, or you are on an older version, you may run the installer again to install the Zillion Client.
  2. During setup, you will be asked to locate your base ROM file. This is the Zillion ROM file mentioned above in Required Software.

Play

Create a Config (.yaml) File

What is a config file and why do I need one?

See the guide on setting up a basic YAML at the Archipelago setup guide: Basic Multiworld Setup Guide

Where do I get a config file?

The player settings page on the website allows you to configure your personal settings and export a config file from them.

Verifying your config file

If you would like to validate your config file to make sure it works, you may do so on the YAML Validator page.

Generating a Single-Player Game

  1. Navigate to the player settings page, configure your options, and click the "Generate Game" button.
  2. A "Seed Info" page will appear.
  3. Click the "Create New Room" link.
  4. A server page will appear. Download your patch file from this page.
  5. Patch your ROM file.
    • Linux
      • In the launcher, choose "Open Patch" and select your patch file.
    • Windows
      • Double-click on your patch file. The Zillion Client will launch automatically, and create your ROM in the location of the patch file.
  6. Open the ROM in RetroArch using the core "SMS Plus GX".
    • For a single player game, any emulator (or a Sega Master System) can be used, but there are additional features with RetroArch and the Zillion Client.
      • If you press reset or restore a save state and return to the surface in the game, the Zillion Client will keep open all the doors that you have opened.

Joining a MultiWorld Game

  1. Provide your config (yaml) file to the host and obtain your patch file.
    • When you join a multiworld game, you will be asked to provide your config file to whoever is hosting. Once that is done, the host will provide you with either a link to download your patch file, or with a zip file containing everyone's patch files. Your patch file should have a .apzl extension.
      • If you activate the "room generation" option in your config (yaml), you might want to tell your host that the generation will take longer than normal. It takes approximately 20 seconds longer for each Zillion player that enables this option.
  2. Create your ROM.
    • Linux
      • In the Archipelago Launcher, choose "Open Patch" and select your .apzl patch file.
    • Windows
      • Put your patch file on your desktop or somewhere convenient, and double click it.
    • This should automatically launch the client, and will also create your ROM in the same place as your patch file.
  3. Connect to the client.
    • Use RetroArch to open the ROM that was generated.
    • Be sure to select the SMS Plus GX core. This core will allow external tools to read RAM data.
  4. Connect to the Archipelago Server.
    • The patch file which launched your client should have automatically connected you to the AP Server. There are a few reasons this may not happen however, including if the game is hosted on the website but was generated elsewhere. If the client window shows "Server Status: Not Connected", simply ask the host for the address of the server, and copy/paste it into the "Server" input field then press enter.
    • The client will attempt to reconnect to the new server address, and should momentarily show "Server Status: Connected".
  5. Play the game.
    • When the client shows both Game and Server as connected, you're ready to begin playing. Congratulations on successfully joining a multiworld game!

Hosting a MultiWorld game

The recommended way to host a game is to use our hosting service. The process is relatively simple:

  1. Collect config files from your players.
  2. Create a zip file containing your players' config files.
  3. Upload that zip file to the Generation page.
  4. Wait a moment while the seed is generated.
  5. When the seed is generated, a "Seed Info" page will appear.
  6. Click "Create New Room". This will take you to the server page. Provide the link to this page to your players, so they may download their patch files from there.
  7. Note that a link to a MultiWorld Tracker is at the top of the room page. The tracker shows the progress of all players in the game. Any observers may also be given the link to this page.
  8. Once all players have joined, you may begin playing.