Archipelago/worlds/saving_princess/docs/en_Saving Princess.md

56 lines
2.9 KiB
Markdown
Raw Normal View History

Saving Princess: implement new game (#3238) * Saving Princess: initial commit * settings -> options Co-authored-by: Scipio Wright <scipiowright@gmail.com> * settings -> options Co-authored-by: Scipio Wright <scipiowright@gmail.com> * replace RegionData class with List[str] RegionData was only wrapping a List[str], so we can directly use List[str] * world: MultiWorld -> multiworld: MultiWorld * use world's random instead of multiworld's * use state's has_any and has_all where applicable * remove unused StartInventory import * reorder PerGameCommonOptions * fix relative AutoWorld import Co-authored-by: Scipio Wright <scipiowright@gmail.com> * clean up double spaces * local commands -> Local Commands Co-authored-by: Nicholas Saylor <79181893+nicholassaylor@users.noreply.github.com> * remove redundant which items section Co-authored-by: Nicholas Saylor <79181893+nicholassaylor@users.noreply.github.com> * game info rework * clean up item count redundancy * add game to readme and codeowners * fix get_region_entrance return type * world.multiworld.get -> world.get * add more events added events for the boss kills that open the gate, as well as for system power being restored these only apply if expanded pool is not selected * add client/autoupdater to launcher * reorder commands in game info * update docs with automated installation info * add quick links to doc * Update setup_en.md * remove standalone saving princess client * doc fixes * code improvements and redundant default removal as suggested by @Exempt-Medic this includes the removal of events from the item/location name to id, as well as checking for the player name being ASCII * add option to change launch coammnd the LaunchCommand option is filled to either the executable or wine with the necessary arguments based on Utils.is_windows * simplify valid install check * mod installer improvements now deletes possible existing files before installing the mod * add option groups and presets * add required client version * update docs about cheat items pop-ups items sent directly by the server (such as with starting inventory) now have pop-ups just like any other item * add Steam Input issue to faq * Saving Princess: BRAINOS requires all weapons * Saving Princess: Download dll and patch together Previously, gm-apclientpp.dll was downloaded from its own repo With this update, the dll is instead extracted from the same zip as the game's patch * Saving Princess: Add URI launch support * Saving Princess: goal also requires all weapons given it's past brainos * Saving Princess: update docs automatic connection support was added, docs now reflect this * Saving Princess: extend([item]) -> append(item) * Saving Princess: automatic connection validation also parses the slot, password and host:port into parameters for the game * Saving Princess: change subprocess .run to .Popen This keeps the game from freezing the launcher while it is running --------- Co-authored-by: Scipio Wright <scipiowright@gmail.com> Co-authored-by: Nicholas Saylor <79181893+nicholassaylor@users.noreply.github.com> Co-authored-by: NewSoupVi <57900059+NewSoupVi@users.noreply.github.com>
2024-12-07 10:29:27 +00:00
# Saving Princess
## Quick Links
- [Setup Guide](/tutorial/Saving%20Princess/setup/en)
- [Options Page](/games/Saving%20Princess/player-options)
- [Saving Princess Archipelago GitHub](https://github.com/LeonarthCG/saving-princess-archipelago)
## What changes have been made?
The game has had several changes made to add new features and prevent issues. The most important changes are the following:
- There is an in-game connection settings menu, autotracker and client console.
- New save files are created and used automatically for each seed and slot played.
- The game window can now be dragged and a new integer scaling option has been added.
## What items and locations get shuffled?
The chest contents and special weapons are the items and locations that get shuffled.
Additionally, there are new items to work as filler and traps, ranging from a full health and ammo restore to spawning a Ninja on top of you.
The Expanded Pool option, which is enabled by default, adds a few more items and locations:
- Completing the intro sequence, powering the generator with the Volt Laser and defeating each boss become locations.
- 4 Keys will be shuffled, which serve to open the door to the final area in place of defeating the main area bosses.
- A System Power item will be shuffled, which restores power to the final area instead of this happening when the generator is powered.
## What does another world's item look like in Saving Princess?
Some locations, such as boss kills, have no visual representation, but those that do will have the Archipelago icon.
Once the item is picked up, a textbox will inform you of the item that was found as well as the player that will be receiving it.
These textboxes will have colored backgrounds and comments about the item category.
For example, progression items will have a purple background and say "Looks plenty important!".
## When the player receives an item, what happens?
When you receive an item, a textbox will show up.
This textbox shows both which item you got and which player sent it to you.
If you send an item to yourself, however, the sending player will be omitted.
## Unique Local Commands
The following commands are only available when using the in-game console in Saving Princess:
- `/help` Returns the help listing.
- `/options` Lists currently applied options.
- `/resync` Manually triggers a resync. This also resends all found locations.
- `/unstuck` Sets save point to the first save point. Portia is then killed.
- `/deathlink [on|off]` Toggles or sets death link mode.
- `/instantsaving [on|off]` Toggles or sets instant saving.
- `/sprint {never|always|jacket}` Sets sprint mode.
- `/cliff {never|always|vanilla}` Sets Cliff's weapon upgrade condition.
- `/ace {never|always|vanilla}` Sets Ace's weapon upgrade condition.
- `/iframes n` Sets the iframe duration % multiplier to n, where 0 <= n <= 400.
- `/shake n` Sets the shake intensity % multiplier to n, where 0 <= n <= 100.