Releases: ManualForArchipelago/Manual
Releases · ManualForArchipelago/Manual
Unstable - 20240312
Breaking Change
- Item creation was happening in the wrong step (
generate_basic), so it was moved to the propercreate_itemsstep.
This change will break thegenerate_basichooks, since they have changed tocreate_itemhooks.
This unstable release also contains the following changes:
- The ability to negate a
yaml_optionin category.json - The ability to use hook functions directly in
requiresstrings for dynamic checking - The ability to require a percentage of an item's total count instead of an exact count
- Adding JSON schemas for Manual's current configurations
- Better validation for improperly configured
starting_itemsblocks - Better validation for
place_itemandplace_item_categoryon locations - Fixed pseudo-counts HALF and ALL for requires, and made them account for disabled items
- Fix for validation causing performance delays in the loading of the client
- Fix deprecations, including new options dataclass, that came with the 0.4.4 release of AP
- Better handling of unknown locations and items in the Manual client, in the case of an outdated apworld
Stable - 20240121
This stable release contains all of the changes from the previous unstable as well as a few extra changes. The extra changes are:
- Changed filler generation to be in its own function for reuse by hooks
- Added examples of common use cases for hooks
- Fixed a bug where filler_item_name should be optional
The included changes from the previous unstable are:
- The Manual client is now included in the Manual apworld releases, and can be used from the Launcher like other embedded clients
- Location/region requirements can now use
ALLorHALF(case insensitive) in the place of item counts;HALFrounds down - You can now specify
dont_place_itemanddont_place_item_categoryon locations to forbid the placement of those during generation, similar to howplace_itemandplace_item_categorywork - You can now include a
categories.jsonfile in your Manual apworld data that dictates category visibility in the client and allows the definition of YAML options to exclude categories of items/locations from generation - You can also customize the logic of category-based YAML options with hooks
- The Manual client now shows a pseudo-category for locations that have hinted items
- You can now specify that items are
localorearly(or both), to be added to AP local items, early items, or local early items - You can now specify a
filler_trapsoption in your Manual YAML for what percentage of filler should be traps instead - Manual now creates AP item groups and location groups for its categories, to allow using features of item groups and location groups
- Added two new hooks:
Data.after_load_category_fileandHelpers.before_is_category_enabled.
To update your apworld to be current with this stable template, you can either import the apworld to the Builder and export it again, or you can manually swap out the files by copying over all of the .py files and the hooks folder from the stable template.
Unstable - 20231215
This unstable release contains the following changes:
- The Manual client is now included in the Manual apworld releases, and can be used from the Launcher like other embedded clients
- Location/region requirements can now use
ALLorHALF(case insensitive) in the place of item counts;HALFrounds down - You can now specify
dont_place_itemanddont_place_item_categoryon locations to forbid the placement of those during generation, similar to howplace_itemandplace_item_categorywork - You can now include a
categories.jsonfile in your Manual apworld data that dictates category visibility in the client and allows the definition of YAML options to exclude categories of items/locations from generation - You can also customize the logic of category-based YAML options with hooks
- The Manual client now shows a pseudo-category for locations that have hinted items
- You can now specify that items are
localorearly(or both), to be added to AP local items, early items, or local early items - You can now specify a
filler_trapsoption in your Manual YAML for what percentage of filler should be traps instead - Manual now creates AP item groups and location groups for its categories, to allow using features of item groups and location groups
Upgrade Notes:
This release adds two new hooks: Data.after_load_category_file and Helpers.before_is_category_enabled.