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

Merge branch 'main' into breaking_changes

Browse Source 
# Conflicts:
#	BaseClasses.py
#	Fill.py
#	MultiClient.py
#	MultiServer.py
#	Utils.py
#	test/dungeons/TestDungeon.py
#	test/inverted/TestInverted.py
#	test/inverted_minor_glitches/TestInvertedMinor.py
#	test/inverted_owg/TestInvertedOWG.py
#	test/minor_glitches/TestMinor.py
#	test/owg/TestVanillaOWG.py
#	test/vanilla/TestVanilla.py
#	worlds/alttp/ItemPool.py
#	worlds/alttp/Main.py
#	worlds/alttp/Rom.py
This commit is contained in:
Fabian Dill
2021-01-30 23:29:32 +01:00
parent c604dfe509 24e8fb54ad
commit a646594f08
33 changed files with 1391 additions and 671 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
WebHostLib/static/assets/tutorial/zelda3/plando_en.md
View File

@@ -2,10 +2,11 @@
## Configuration
1. Plando features have to be enabled first, before they can be used (opt-in).
2. To do so, go to your installation directory (Windows default: C:\ProgramData\BerserkerMultiWorld),
then open the host.yaml file therein with a text editor.
3. In it, you're looking for the option key "plando_options",
to enable all plando modules you can set the value to "bosses, items, texts, connections"
2. To do so, go to your installation directory (Windows default: `C:\ProgramData\BerserkerMultiWorld`),
then open the host.yaml file with a text editor.
3. In it, you're looking for the option key `plando_options`. To enable all plando modules you can set the
value to
`bosses, items, texts, connections`
## Modules
@@ -19,20 +20,21 @@
- Instructions are separated by a semicolon
- Available Instructions:
- Direct Placement:
- Example: "Eastern Palace-Trinexx"
- Example: `Eastern Palace-Trinexx`
- Takes a particular Arena and particular boss, then places that boss into that arena
- Ganons Tower has 3 placements, "Ganons Tower Top", "Ganons Tower Middle" and "Ganons Tower Bottom"
- Ganons Tower has 3 placements, `Ganons Tower Top`, `Ganons Tower Middle` and `Ganons Tower Bottom`
- Boss Placement:
- Example: "Trinexx"
- Example: `Trinexx`
- Takes a particular boss and places that boss in any remaining slots in which this boss can function.
- In this example, it would fill Desert Palace, but not Tower of Hera.
- Boss Shuffle:
- Example: "simple"
- Runs a particular boss shuffle mode to finish construction instead of vanilla placement, typically used as a last instruction.
- Example: `simple`
- Runs a particular boss shuffle mode to finish construction instead of vanilla placement, typically used as
a last instruction.
- [Available Bosses](https://github.com/Berserker66/MultiWorld-Utilities/blob/65fa39df95c90c9b66141aee8b16b7e560d00819/Bosses.py#L135)
- [Available Arenas](https://github.com/Berserker66/MultiWorld-Utilities/blob/65fa39df95c90c9b66141aee8b16b7e560d00819/Bosses.py#L186)
#### Examples:
#### Examples
```yaml
boss_shuffle:
Turtle Rock-Trinexx;basic: 1
@@ -62,10 +64,10 @@ boss_shuffle:
- can be true, to target any other player's world
- can be false, to target own world and is the default
- can be null, to target a random world
- force is either "silent", "true" or "false".
- "true" means the item has to be placed, or the generator aborts with an exception.
- "false" means the generator logs a warning if the placement can't be done.
- "silent" means that this entry is entirely ignored if the placement fails and is the default.
- force is either `silent`, `true` or `false`.
- `true` means the item has to be placed, or the generator aborts with an exception.
- `false` means the generator logs a warning if the placement can't be done.
- `silent` means that this entry is entirely ignored if the placement fails and is the default.
- Single Placement
- place a single item at a single location
- item denotes the Item to place
@@ -75,20 +77,22 @@ boss_shuffle:
- items denotes the items to use, can be given a number to have multiple of that item
- locations lists the possible locations those items can be placed in
- placements are picked randomly, not sorted in any way
- Warning: Placing non-Dungeon Prizes on Prize locations and
Prizes on non-Prize locations will break the game in various ways.
- [Available Items](https://github.com/Berserker66/MultiWorld-Utilities/blob/3b5ba161dea223b96e9b1fc890e03469d9c6eb59/Items.py#L26)
- [Available Locations](https://github.com/Berserker66/MultiWorld-Utilities/blob/3b5ba161dea223b96e9b1fc890e03469d9c6eb59/Regions.py#L418)
#### Examples
```yaml
plando_items:
- item:
- item: # 1
Lamp: 1
Fire Rod: 1
location: Link's House
from_pool: true
world: true
percentage: 50
- items:
- items: # 2
Progressive Sword: 4
Progressive Bow: 1
Progressive Bow (Alt): 1
@@ -104,21 +108,30 @@ plando_items:
- Turtle Rock - Big Chest
- Palace of Darkness - Big Chest
world: false
- items: # 3
Red Pendant: 1
Green Pendant: 1
Blue Pendant: 1
locations:
- Desert Palace - Prize
- Eastern Palace - Prize
- Tower of Hera - Prize
from_pool: true
```
The first example has a 50% chance to occur, which if it does places either the Lamp or Fire Rod in one's own
1. has a 50% chance to occur, which if it does places either the Lamp or Fire Rod in one's own
Link's House and removes the picked item from the item pool.
The second example always triggers and places the Swords and Bows into one's own Big Chests
2. Always triggers and places the Swords and Bows into one's own Big Chests
3. Locks Pendants to The Light World and therefore Crystals to dark world
### Texts
- This module is disabled by default.
- Has the options "text", "at" and "percentage"
- Has the options `text`, `at`, and `percentage`
- percentage is the percentage chance for this text to be placed, can be omitted entirely for 100%
- text is the text to be placed.
- can be weighted.
- \n is a newline.
- @ is the entered player's name.
- `\n` is a newline.
- `@` is the entered player's name.
- Warning: Text Mapper does not support full unicode.
- [Alphabet](https://github.com/Berserker66/MultiWorld-Utilities/blob/65fa39df95c90c9b66141aee8b16b7e560d00819/Text.py#L756)
- at is the location within the game to attach the text to.
@@ -135,19 +148,18 @@ plando_texts:
percentage: 50
```
![Uncle Example](https://cdn.discordapp.com/attachments/731214280439103580/794953870903083058/unknown.png)
This has a 50% chance to trigger at all, if it does,
it throws a coin between "uncle_leaving_text" and "uncle_dying_sewer", then places the text
"This is a plando.\nYou've been warned." at that location.
This has a 50% chance to trigger at all. If it does, it throws a coin between `uncle_leaving_text` and
`uncle_dying_sewer`, then places the text "This is a plando. You've been warned." at that location.
### Connections
- This module is disabled by default.
- Has the options "percentage", "entrance", "exit" and "direction".
- Has the options `percentage`, `entrance`, `exit` and `direction`.
- All options support subweights
- percentage is the percentage chance for this to be connected, can be omitted entirely for 100%
- Any Door has 4 total directions, as a door can be unlinked like in insanity ER
- entrance is the overworld door
- exit is the underworld exit
- direction can be "both", "entrance" or "exit"
- direction can be `both`, `entrance` or `exit`
- doors can be found in [this file](https://github.com/Berserker66/MultiWorld-Utilities/blob/main/EntranceShuffle.py)
@@ -166,4 +178,4 @@ The first block connects the overworld entrance that normally leads to Link's Ho
to put you into the HC West Wing instead, exiting from within there will put you at the Overworld exiting Link's House.
Without the second block, you'd still exit from within Link's House to outside Link's House and the left side
Balcony Entrance would still lead into HC West Wing
Balcony Entrance would still lead into HC West Wing

4
WebHostLib/static/assets/weightedSettings.js
View File

@@ -215,7 +215,9 @@ const buildUI = (settings, spriteData) => {
const spriteOptionsDescription = document.createElement('span');
spriteOptionsDescription.className = 'description-span';
spriteOptionsDescription.innerText = "Choose an alternate sprite to play the game with.";
spriteOptionsDescription.innerHTML = 'Choose an alternate sprite to play the game with. Additional randomization ' +
'options are documented in the ' +
'<a href="https://github.com/Berserker66/MultiWorld-Utilities/blob/main/playerSettings.yaml#L374">settings file</a>.';
spriteOptionsWrapper.appendChild(spriteOptionsDescription);
const spriteOptionsTable = document.createElement('table');

10
WebHostLib/static/static/playerSettings.json
View File

@@ -48,6 +48,10 @@
{
"name": "Triforce Hunt + Ganon",
"value": "ganon_triforce_hunt"
},
{
"name": "Ice Rod Hunt",
"value": "ice_rod_hunt"
}
]
},
@@ -479,7 +483,7 @@
},
{
"name": "Inventory",
"value": "i"
"value": "f"
},
{
"name": "Prices",
@@ -491,11 +495,11 @@
},
{
"name": "Inventory and Prices",
"value": "ip"
"value": "fp"
},
{
"name": "Inventory, Prices, and Upgrades",
"value": "ipu"
"value": "fpu"
}
]
}

166
WebHostLib/static/static/weightedSettings.json
View File

@@ -72,6 +72,26 @@
}
}
},
"restrict_dungeon_item_on_boss": {
"keyString": "restrict_dungeon_item_on_boss",
"friendlyName": "Dungeon Item on Boss",
"description": "Defeating a dungeon bosses always awards a dungeon item.",
"inputType": "range",
"subOptions": {
"on": {
"keyString": "restrict_dungeon_item_on_boss.on",
"friendlyName": "On",
"description": "Dungeon bosses will always drop a dungeon item.",
"defaultValue": 0
},
"off": {
"keyString": "restrict_dungeon_item_on_boss.off",
"friendlyName": "Off",
"description": "Dungeon bosses may not drop a dungeon item.",
"defaultValue": 0
}
}
},
"map_shuffle": {
"keyString": "map_shuffle",
"friendlyName": "Map Shuffle",
@@ -377,6 +397,12 @@
"friendlyName": "Local Triforce hunt /w Ganon",
"description": "Same as Local Triforce Hunt, but you need to defeat Ganon in his lair instead of talking with Murahadala.",
"defaultValue": 0
},
"ice_rod_hunt": {
"keyString": "goals.ice_rod_hunt",
"friendlyName": "Ice Rod Hunt",
"description": "Look for the Ice Rod within your 215 available checks, then go kill Trinexx at Turtle rock.",
"defaultValue": 0
}
}
},
@@ -944,6 +970,70 @@
}
}
},
"misery_mire_medallion": {
"keyString": "misery_mire_medallion",
"friendlyName": "Misery Mire Medallion",
"description": "Determines the medallion required to access Misery Mire",
"inputType": "range",
"subOptions": {
"random": {
"keyString": "misery_mire_medallion.random",
"friendlyName": "Random",
"description": "Choose the medallion randomly.",
"defaultValue": 50
},
"quake": {
"keyString": "misery_mire_medallion.quake",
"friendlyName": "Quake",
"description": "Quake will be required ot enter Misery Mire.",
"defaultValue": 0
},
"bombos": {
"keyString": "misery_mire_medallion.bombos",
"friendlyName": "Bombos",
"description": "Bombos will be required ot enter Misery Mire.",
"defaultValue": 0
},
"ether": {
"keyString": "misery_mire_medallion.ether",
"friendlyName": "Ether",
"description": "Ether will be required ot enter Misery Mire.",
"defaultValue": 0
}
}
},
"turtle_rock_medallion": {
"keyString": "turtle_rock_medallion",
"friendlyName": "Turtle Rock Medallion",
"description": "Determines the medallion required to access Turtle Rock",
"inputType": "range",
"subOptions": {
"random": {
"keyString": "turtle_rock_medallion.random",
"friendlyName": "Random",
"description": "Choose the medallion randomly.",
"defaultValue": 50
},
"quake": {
"keyString": "turtle_rock_medallion.quake",
"friendlyName": "Quake",
"description": "Quake will be required ot enter Turtle Rock.",
"defaultValue": 0
},
"bombos": {
"keyString": "turtle_rock_medallion.bombos",
"friendlyName": "Bombos",
"description": "Bombos will be required ot enter Turtle Rock.",
"defaultValue": 0
},
"ether": {
"keyString": "turtle_rock_medallion.ether",
"friendlyName": "Ether",
"description": "Ether will be required ot enter Turtle Rock.",
"defaultValue": 0
}
}
},
"bush_shuffle": {
"keyString": "bush_shuffle",
"friendlyName": "Bush Shuffle",
@@ -1092,10 +1182,16 @@
"description": "Shop contents are left unchanged.",
"defaultValue": 50
},
"i": {
"keyString": "shop_shuffle.i",
"friendlyName": "Inventory Shuffle",
"description": "Randomizes the inventories of shops.",
"g": {
"keyString": "shop_shuffle.g",
"friendlyName": "Pool Shuffle",
"description": "Shuffles the inventory of shops.",
"defaultValue": 0
},
"f": {
"keyString": "shop_shuffle.f",
"friendlyName": "Random Shuffle",
"description": "Randomly generate an inventory for each shop from a pool of non-progression items.",
"defaultValue": 0
},
"p": {
@@ -1110,16 +1206,66 @@
"description": "Shuffles capacity upgrades throughout the game world.",
"defaultValue": 0
},
"ip": {
"keyString": "shop_shuffle.ip",
"friendlyName": "Inventory & Prices",
"gp": {
"keyString": "shop_shuffle.gp",
"friendlyName": "Pool & Prices",
"description": "Shuffles the inventory and randomizes the prices of items in shops.",
"defaultValue": 0
},
"uip": {
"keyString": "shop_shuffle.uip",
"fp": {
"keyString": "shop_shuffle.fp",
"friendlyName": "Full Shuffle",
"description": "Shuffles the inventory and randomizes the prices of items in shops. Also distributes capacity upgrades throughout the world.",
"description": "Randomizes the inventory and prices of shops.",
"defaultValue": 0
},
"ufp": {
"keyString": "shop_shuffle.ufp",
"friendlyName": "Full Shuffle & Capacity",
"description": "Randomizes the inventory and prices in shops, and distributes capacity upgrades throughout the world.",
"defaultValue": 0
},
"wfp": {
"keyString": "shop_shuffle.wfp",
"friendlyName": "Full Shuffle & Potion Shop",
"description": "Randomizes the inventory prices of shops, and shuffles items in the potion shop.",
"defaultValue": 0
},
"ufpw": {
"keyString": "shop_shuffle.ufpw",
"friendlyName": "Randomize Everything",
"description": "Randomizes the inventory and prices in shops, distributes capacity upgrades throughout the world, and shuffles items in the potion shop.",
"defaultValue": 0
}
}
},
"shop_shuffle_slots": {
"keyString": "shop_shuffle_slots",
"friendlyName": "Pay (Rupees) to Win",
"description": "Move items from the general item pool into shops for purchase.",
"inputType": "range",
"subOptions": {
"0": {
"keyString": "shop_shuffle_slots.0",
"friendlyName": "Off",
"description": "No items are moved",
"defaultValue": 50
},
"1": {
"keyString": "shop_shuffle_slots.10",
"friendlyName": "Level 1",
"description": "10 Items are moved into shops.",
"defaultValue": 0
},
"2": {
"keyString": "shop_shuffle_slots.20",
"friendlyName": "Level 2",
"description": "20 Items are moved into shops.",
"defaultValue": 0
},
"3": {
"keyString": "shop_shuffle_slots.30",
"friendlyName": "Level 3",
"description": "30 Items are moved into shops.",
"defaultValue": 0
}
}

91
WebHostLib/static/static/weightedSettings.yaml
View File

@@ -96,6 +96,7 @@ goals:
local_triforce_hunt: 0 # Collect 20 of 30 Triforce pieces spread throughout your world, then turn them in to Murahadala in front of Hyrule Castle
ganon_triforce_hunt: 0 # Collect 20 of 30 Triforce pieces spread throughout the worlds, then kill Ganon
local_ganon_triforce_hunt: 0 # Collect 20 of 30 Triforce pieces spread throughout your world, then kill Ganon
ice_rod_hunt: 0 # You start with everything needed to 216 the seed. Find the Ice rod, then kill Trinexx at Turtle rock.
triforce_pieces_mode: #Determine how to calculate the extra available triforce pieces.
extra: 0 # available = triforce_pieces_extra + triforce_pieces_required
percentage: 0 # available = (triforce_pieces_percentage /100) * triforce_pieces_required
@@ -107,7 +108,7 @@ triforce_pieces_extra: # Set to how many extra triforces pieces are available to
10: 50
15: 0
20: 0
triforce_pieces_percentage: # Set to how many extra triforces pieces according to a percentage of the required ones, are available to collect in the world.
triforce_pieces_percentage: # Set to how many triforce pieces according to a percentage of the required ones, are available to collect in the world.
# Format "pieces: chance"
100: 0 #No extra
150: 50 #Half the required will be added as extra
@@ -173,6 +174,19 @@ item_functionality:
progression_balancing:
on: 50 # A system to reduce BK, as in times during which you can't do anything by moving your items into an earlier access sphere to make it likely you have stuff to do
off: 0 # Turn this off if you don't mind a longer multiworld, or can glitch around missing items.
tile_shuffle: # Randomize the tile layouts in flying tile rooms
on: 0
off: 50
misery_mire_medallion: # required medallion to open Misery Mire front entrance
random: 50
ether: 0
bombos: 0
quake: 0
turtle_rock_medallion: # required medallion to open Turtle Rock front entrance
random: 50
ether: 0
bombos: 0
quake: 0
### Enemizer Section ###
boss_shuffle:
none: 50 # Vanilla bosses
@@ -186,9 +200,6 @@ enemy_shuffle: # Randomize enemy placement
killable_thieves: # Make thieves killable
on: 0 # Usually turned on together with enemy_shuffle to make annoying thief placement more manageable
off: 50
tile_shuffle: # Randomize the tile layouts in flying tile rooms
on: 0
off: 50
bush_shuffle: # Randomize the chance that bushes have enemies and the enemies under said bush
on: 0
off: 50
@@ -211,14 +222,26 @@ beemizer: # Remove items from the global item pool and replace them with single
2: 0 # 60% of the non-essential item pool is replaced with bee traps, of which 20% could be single bees
3: 0 # 100% of the non-essential item pool is replaced with bee traps, of which 50% could be single bees
4: 0 # 100% of the non-essential item pool is replaced with bee traps
### Shop Settings ###
shop_shuffle_slots: # Maximum amount of shop slots to be filled with regular item pool items (such as Moon Pearl)
0: 50
10: 0
20: 0
30: 0
shop_shuffle:
none: 50
i: 0 # Shuffle the inventories of the shops around
g: 0 # Generate new default inventories for overworld/underworld shops, and unique shops
f: 0 # Generate new default inventories for every shop independently
p: 0 # Randomize the prices of the items in shop inventories
u: 0 # Shuffle capacity upgrades into the item pool (and allow them to traverse the multiworld)
ip: 0 # Shuffle inventories and randomize prices
uip: 0 # Shuffle inventories, randomize prices and shuffle capacity upgrades into the item pool
w: 0 # Consider witch's hut like any other shop and shuffle/randomize it too
gp: 0 # Shuffle inventories and randomize prices
fp: 0 # Randomize items in every shop and their prices
ufp: 0 # Randomize items and prices in every shop, and include capacity upgrades in item pool
wfp: 0 # Randomize items and prices in every shop, and include potion shop inventory in shuffle
ufpw: 0 # Randomize items and prices in every shop, shuffle potion shop inventory, and include capacity upgrades
# You can add more combos
### End of Shop Section ###
shuffle_prizes: # aka drops
none: 0 # do not shuffle prize packs
g: 50 # shuffle "general" price packs, as in enemy, tree pull, dig etc.
@@ -295,6 +318,7 @@ linked_options:
hard: 1
expert: 1
percentage: 0 # Set this to the percentage chance you want enemizer
### door rando only options ###
door_shuffle: # Only available if the host uses the doors branch, it is ignored otherwise
vanilla: 50 # Everything should be like in vanilla
basic: 0 # Dungeons are shuffled within themselves
@@ -308,41 +332,20 @@ key_drop_shuffle: # Only available if the host uses the doors branch, it is igno
on: 0 # Enables the small keys dropped by enemies or under pots, and the big key dropped by the Ball & Chain guard to be shuffled into the pool. This extends the number of checks to 249.
off: 50
experimental: # Only available if the host uses the doors branch, it is ignored otherwise
on: 0 # Enables experimental features. Currently, this is just the dungeon keys in chest counter.
on: 0 # Enables experimental features.
off: 50
debug: # Only available if the host uses the doors branch, it is ignored otherwise
on: 0 # Enables debugging features. Currently, these are the Item collection counter. (overwrites total triforce pieces) and Castle Gate closed indicator.
off: 50
### end of door rando only options ###
rom:
random_sprite_on_event: # An alternative to specifying randomonhit / randomonexit / etc... in sprite down below.
enabled: # If enabled, sprite down below is ignored completely, (although it may become the sprite pool)
on: 0
off: 1
on_hit: # Random sprite on hit. Being hit by things that cause 0 damage still counts.
on: 0
off: 1
on_enter: # Random sprite on underworld entry. Note that entering hobo counts.
on: 0
off: 1
on_exit: # Random sprite on underworld exit. Exiting hobo does not count.
on: 0
off: 1
on_slash: # Random sprite on sword slash. Note, it still counts if you attempt to slash while swordless.
on: 0
off: 1
on_item: # Random sprite on getting an item. Anything that causes you to hold an item above your head counts.
on: 0
off: 1
on_bonk: # Random sprite on bonk.
on: 0
off: 1
#sprite_pool: # When specified, limits the pool of sprites used for randomon-event to the specified pool. Uncomment to use this.
# - link
# - pride link
# - penguin link
# - random # You can specify random multiple times for however many potentially unique random sprites you want in your pool.
sprite: # Enter the name of your preferred sprite and weight it appropriately
random: 0 # Choose a sprite at random
random: 0
Link: 50 # To add other sprites: open the gui/Creator, go to adjust, select a sprite and write down the name the gui calls it
disablemusic: # If "on", all in-game music will be disabled
on: 0
@@ -371,8 +374,8 @@ rom:
off: 0
ow_palettes: # Change the colors of the overworld
default: 50 # No changes
random: 0 # Shuffle the colors
blackout: 0 # Never use this
random: 0 # Shuffle the colors, with harmony in mind
blackout: 0 # everything black / blind mode
grayscale: 0
negative: 0
classic: 0
@@ -381,8 +384,8 @@ rom:
puke: 0
uw_palettes: # Change the colors of caves and dungeons
default: 50 # No changes
random: 0 # Shuffle the colors
blackout: 0 # Never use this
random: 0 # Shuffle the colors, with harmony in mind
blackout: 0 # everything black / blind mode
grayscale: 0
negative: 0
classic: 0
@@ -391,8 +394,8 @@ rom:
puke: 0
hud_palettes: # Change the colors of the hud
default: 50 # No changes
random: 0 # Shuffle the colors
blackout: 0 # Never use this
random: 0 # Shuffle the colors, with harmony in mind
blackout: 0 # everything black / blind mode
grayscale: 0
negative: 0
classic: 0
@@ -401,8 +404,18 @@ rom:
puke: 0
sword_palettes: # Change the colors of swords
default: 50 # No changes
random: 0 # Shuffle the colors
blackout: 0 # Never use this
random: 0 # Shuffle the colors, with harmony in mind
blackout: 0 # everything black / blind mode
grayscale: 0
negative: 0
classic: 0
dizzy: 0
sick: 0
puke: 0
shield_palettes: # Change the colors of shields
default: 50 # No changes
random: 0 # Shuffle the colors, with harmony in mind
blackout: 0 # everything black / blind mode
grayscale: 0
negative: 0
classic: 0

5
WebHostLib/static/styles/tutorial.css
View File

@@ -16,6 +16,11 @@ html{
color: #eeffeb;
}
#tutorial-wrapper img{
max-width: 100%;
border-radius: 6px;
}
#tutorial-wrapper p{
margin-top: 0;
}