8ddb49f071
* MMBN3: Press program now has proper color index when received remotely * Initial commit of OSRS untangled from MMBN3 branch * Fixes some broken region connections * Removes some locations * Rearranges locations to fill in slots left by removed locations * Adds starting area rando * Moves Oak and Willow trees to resource regions * Fixes various PEP8 violations * Refactor of regions * Fixes variable capture issue with region rules * Partial completion of brutal grind logic * Finishes can_reach_skill function * Adds skill requirements to location rules, fixes regions rules * Adds documentation for OSRS * Removes match statement * Updates Data Version to test mode to prevent item name caching * Fixes starting spawn logic for east varrock * Fixes river lum crossing logic to not assume you can phase across water * Prevents equipping items when you haven't unlocked them * Changes canoe logic to not require huge levels * Skeletoning out some data I'll need for variable task system * Adds csvs and parser for logic * Adds Items parsing * Fixes the spawning logic to not default to Chunksanity when you didn't pick it * Begins adding generation rules for data-driven logic * Moves region handling and location creating to different methods * Adds logic limits to Options * Begun the location generation has * Randomly generates tasks for each skill until populated * Mopping up improper names, adding custom logic, and fixes location rolling * Drastically cleans up the location rolling loop * Modifies generation to properly use local variables and pass unit tests * Game is now generating, but rules don't seem to work * Lambda capture, my old nemesis. We meet again * Fixes issue with Corsair Cove item requirement causing logic loop * Okay one more fix, another variable capture * On second thought lets not have skull sceptre tasks. 'Tis a silly place * Removes QP from item pool (they're events not items) * Removes Stronghold floor tasks, no varbit to track them * Loads CSV with pkutil so it can be used in apworld * Fixes logic of skill tasks and adds QP requirements to long grinds * Fixes pathing in pkgutil call * Better handling for empty task categories, no longer throws errors * Fixes order for progressive tasks, removes un-checkable spider task * Fixes logic issues related to stew and the Blurite caves * Fixes issues generating causing tests to sporadically fail * Adds missing task that caused off-by-one error * Updates to new Options API * Updates generation to function properly with the Universal Tracker (Thanks Faris) * Replaces runtime CSV parsing with pre-made python files generated from CSVs * Switches to self.random and uses random.choice instead of doing it manually * Fixes to typing, variable names, iterators, and continue conditions * Replaces Name classes with Enums * Fixes parse error on region special rules * Skill requirements check now returns an accessrule instead of being one that checks options * Updates documentation and setup guide * Adjusts maximum numbers for combat and general tasks * Fixes region names so dictionary lookup works for chunksanity * Update worlds/osrs/docs/en_Old School Runescape.md Co-authored-by: Nicholas Saylor <79181893+nicholassaylor@users.noreply.github.com> * Update worlds/osrs/docs/en_Old School Runescape.md Co-authored-by: Nicholas Saylor <79181893+nicholassaylor@users.noreply.github.com> * Updates readme.md and codeowners doc * Removes erroneous East Varrock -> Al Kharid connection * Changes to canoe logic to account for woodcutting level options * Fixes embarassing typo on 'Edgeville' * Moves Logic CSVs to separate repository, addresses suggested changes on PR * Fixes logic error in east/west lumbridge regions. Fixes incorrect List typing in main * Removes task types with weight 0 from the list of rollable tasks * Missed another place that the task type had to be removed if 0 weight * Prevents adding an empty task weight if levels are too restrictive for tasks to be added * Removes giant blank space in error message * Adds player name to error for not having enough available tasks --------- Co-authored-by: Nicholas Saylor <79181893+nicholassaylor@users.noreply.github.com>
58 lines
3.5 KiB
Markdown
58 lines
3.5 KiB
Markdown
# Setup Guide for Old School Runescape
|
|
|
|
## Required Software
|
|
|
|
- [RuneLite](https://runelite.net/)
|
|
- If the account being used has been migrated to a Jagex Account, the [Jagex Launcher](https://www.jagex.com/en-GB/launcher)
|
|
will also be necessary to run RuneLite
|
|
|
|
## Configuring your YAML file
|
|
|
|
### What is a YAML file and why do I need one?
|
|
|
|
Your YAML file contains a set of configuration options which provide the generator with information about how it should
|
|
generate your game. Each player of a multiworld will provide their own YAML file. This setup allows each player to enjoy
|
|
an experience customized for their taste, and different players in the same multiworld can all have different options.
|
|
|
|
### Where do I get a YAML file?
|
|
|
|
You can customize your settings by visiting the
|
|
[Old School Runescape Player Options Page](/games/Old%20School%20Runescape/player-options).
|
|
|
|
## Joining a MultiWorld Game
|
|
|
|
### Install the RuneLite Plugins
|
|
Open RuneLite and click on the wrench icon on the right side. From there, click on the plug icon to access the
|
|
Plugin Hub. You will need to install the [Archipelago Plugin](https://github.com/digiholic/osrs-archipelago)
|
|
and [Region Locker Plugin](https://github.com/slaytostay/region-locker). The Region Locker plugin
|
|
will include three plugins; only the `Region Locker` plugin itself is required. The `Region Locker GPU` plugin can be
|
|
used to display locked chunks in gray, but is incompatible with other GPU plugins such as 117's HD OSRS and can be
|
|
disabled.
|
|
|
|
### Create a new OSRS Account
|
|
The OSRS Randomizer assumes you are playing on a newly created f2p Ironman account. As such, you will need to [create a
|
|
new Runescape account](https://secure.runescape.com/m=account-creation/create_account?theme=oldschool).
|
|
|
|
If you already have a [Jagex Account](https://www.jagex.com/en-GB/accounts) you can add up to 20 characters on
|
|
one account through the Jagex Launcher. Note that there is currently no way to _remove_ characters
|
|
from a Jagex Account, as such, you might want to create a separate account to hold your Archipelago
|
|
characters if you intend to use your main Jagex account for more characters in the future.
|
|
|
|
**Protip**: In order to avoid having to remember random email addresses for many accounts, take advantage of an email
|
|
alias, a feature supported by most email providers. Any text after a `+` in your email address will redirect to your
|
|
normal address, but the email will be recognized by the Jagex login as a new email address. For example, if your email
|
|
were `Archipelago@gmail.com`, entering `Archipelago+OSRSRandomizer@gmail.com` would cause the confirmation email to
|
|
be sent to your primary address, but the alias can be used to create a new account. One recommendation would be to
|
|
include the date of generation in the account, such as `Archipelago+APYYMMDD@gmail.com` for easy memorability.
|
|
|
|
After creating an account, you may run through Tutorial Island without connecting; the randomizer has no
|
|
effect on the Tutorial.
|
|
|
|
### Connect to the Multiserver
|
|
In the Archipelago Plugin, enter your server information. The `Auto Reconnect on Login For` field should remain blank;
|
|
it will be populated by the character name you first connect with, and it will reconnect to the AP server whenever that
|
|
character logs in. Open the Archipelago panel on the right-hand side to connect to the multiworld while logged in to
|
|
a game world to associate this character to the randomizer.
|
|
|
|
For further information about how to connect to the server in the RuneLite plugin,
|
|
please see the [Archipelago Plugin](https://github.com/digiholic/osrs-archipelago) instructions. |