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

shapez: Typing Cleanup + Small Docs Rewordings (#5189)

Browse Source 
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com>
This commit is contained in:
BlastSlimey
2025-07-28 17:01:57 +02:00
committed by GitHub
parent 4d17366662
commit ad17c7fd21
13 changed files with 144 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
worlds/shapez/docs/datapackage_settings_en.md
View File

@@ -1,14 +1,14 @@
# Guide to change maximum locations in shapez
# Guide to change the maximum amount of locations in shapez
## Where do I find the settings to increase/decrease the amount of possible locations?
The maximum values of the `goal_amount` and `shapesanity_amount` are hardcoded settings that affect the datapackage.
They are stored in a file called `options.json` inside the apworld. By changing them, you will create a custom apworld
on your local machine.
The maximum values of the `goal_amount` and `shapesanity_amount` options are hardcoded settings that affect the
datapackage. They are stored in a file called `options.json` inside the apworld. By changing them, you will create a
custom version on your local machine.
## How to change datapackage options
## How to change datapackage settings
This tutorial is for advanced users and can result in the software not working properly, if not read carefully.
This tutorial is intended for advanced users and can result in the software not working properly, if not read carefully.
Proceed at your own risk.
1. Go to `<AP installation>/lib/worlds`.
@@ -17,17 +17,17 @@ Proceed at your own risk.
4. Edit the values in this file to your desire and save the file.
- `max_shapesanity` cannot be lower than `4`, as this is the minimum amount to prevent FillErrors.
- `max_shapesanity` also cannot be higher than `75800`, as this is the maximum amount of possible shapesanity names.
Else the multiworld generation might fail.
Multiworld generation will fail if the `shapesanity_amount` options is set to a higher value.
- `max_levels_and_upgrades` cannot be lower than `27`, as this is the minimum amount for the `mam` goal to properly
work.
5. Close the zip and rename it back to `shapez.apworld`.
5. Close the zip file and rename it back to `shapez.apworld`.
## Why do I have to do this manually?
For every game in Archipelago, there must be a list of all possible locations, **regardless of player options**. When
generating a multiworld, a list of all locations of all included games will be saved in the multiworld data and sent to
all clients. The higher the amount of possible locations, the bigger the datapackage. And having ~80000 possible
locations at one point made the datapackage for shapez bigger than all other supported games combined. So to reduce the
datapackage of shapez, the locations for shapesanity are named `Shapesanity 1`, `Shapesanity 2` etc. instead of their
actual names. By creating a custom apworld, you can increase the amount of possible locations, but you will also
increase the size of the datapackage at the same time.
generating a multiworld, a list of all locations of all included games will be saved in the multiworld's data and sent
to all clients. The higher the amount of possible locations, the bigger the datapackage. And having ~80000 possible
locations at one point made the datapackage for shapez bigger than all other core-verified games combined. So, to reduce
the datapackage size of shapez, the locations for shapesanity are named `Shapesanity 1`, `Shapesanity 2` etc. instead of
their actual names. By creating a custom version of the apworld, you can increase the amount of possible locations, but
you will also increase the size of the datapackage at the same time.