Skip to content

Latest commit

 

History

History
157 lines (103 loc) · 8.17 KB

SETUP.md

File metadata and controls

157 lines (103 loc) · 8.17 KB

Saving Princess Setup Guide

Installation Procedures

Automated Installation

These instructions have only been tested on Windows and Ubuntu.

Once everything is set up, it is recommended to continue launching the game through this method, as it will check for any updates to the mod and automatically apply them.

  1. Purchase and download Saving Princess
  2. Download and install the latest Archipelago release
  3. Launch ArchipelagoLauncher and click on "Saving Princess Client"
    • You will probably need to scroll down on the Clients column to see it
  4. Follow the prompts
    • On Linux, you will need one of either Wine or 7z for the automated installation

When launching the game, Windows machines will simply run the executable. For any other OS, the launcher defaults to trying to run the game through Wine. You can change this by modifying the launch_command in options.yaml or host.yaml, under the saving_princess_settings section.

Manual Windows Installation

Required software:

Steps:

  1. Extract all files from Saving Princess.exe, as if it were a .7z file
    • Feel free to rename Saving Princess.exe to Saving Princess.exe.7z if needed
    • If installed through the itch app, you can find the installation directory from the game's page, pressing the cog button, then "Manage" and finally "Open folder in explorer"
  2. Extract all files from saving_princess_archipelago.zip into the same directory as the files extracted in the previous step
    • This should include, at least, saving_princess_basepatch.bsdiff4 and gm-apclientpp.dll
  3. If you don't have original_data.win, copy data.win and rename its copy to original_data.win
    • By keeping an unmodified copy of data.win, you will have an easier time updating in the future
  4. Apply the saving_princess_basepatch.bsdiff4 patch using your patching software
  5. To launch the game, run Saving Princess v0_8.exe

Manual Linux Installation

These instructions have only been tested on Ubuntu.

The game does run mostly well through Wine, so it is possible to play on Linux, although there are some minor sprite displacement and sound issues from time to time.

You can follow the instructions for Windows with very few changes:

  • Using the p7zip-full package to decompress the file.
7z e 'Saving Princess.exe'
  • And the bsdiff package for patching.
bspatch original_data.win data.win saving_princess_basepatch.bsdiff4

Configuring your YAML file

Where do I get a YAML file?

You can find the template in the releases tab of my Archipelago fork and manually configure it with your favorite text editor after downloading it.

You can also generate the template through the "Generate Template Options" button of the Archipelago Launcher if you have the Saving Princess APWorld.

Joining a MultiWorld Game

Set up the connection details

After launching the game, enter the Archipelago options menu through the in-game button with the Archipelago icon. From here, enter the different menus and type in the following details in their respective fields:

  • server:port (e.g. archipelago.gg:38281)
    • If hosting on the website, this detail will be shown in your created room.
  • slot name (e.g. Player)
    • This is your player name, which you chose along with your player options.
  • password (e.g. 123456)
    • If the room does not have a password, it can be left empty.

This configuration persists through launches and even updates.

Connect to the Archipelago Server

To start a connection attempt, simply press on "CONNECT!".

Once connected, the button will become one of either "NEW GAME" or "CONTINUE". The game automatically keeps a save file for each seed and slot combination, so you do not need to manually move or delete save files.

All that's left is pressing on the button again to start playing. If you are waiting for a countdown, press "NEW GAME" when the countdown finishes.

Manual Installation Troubleshooting

Can't we just get the patched data.win? / Can I send my friend a patched data.win?

data.win contains all of the code and almost all the assets for the game, patched or unpatched, so sharing this file in any way would be the same as sending someone the game itself.

That is to say, do not do that.

When trying to run bspatch, nothing happens / I don't know which of the files to use to patch my game / I don't know how to use bspatch

bspatch is a command line interface tool, meaning you need to run it from the command line.

Here's a list of instructions for those unfamiliar with how to use such a tool:

  1. Make sure to extract all the files included in the bspatch.zip file to the location of data.win and Saving Princess v0_8.exe.
  2. Copy saving_princess_basepatch.bsdiff4 and gm-apclientpp.dll to the folder you extracted the files to, as well.
  3. Rename data.win to original_data.win.
  4. Now, run the Prompt shortcut. You will see the terminal appear.
  5. On the terminal, copy and paste the following text and press enter 
    bspatch original_data.win data.win saving_princess_basepatch.bsdiff4
    • The program may need administrator privileges to run.
  6. This should have generated a new file, called data.win.
  7. And that's it! The game should now be patched.

The game starts but there is no Archipelago options button

Please make sure you are running the Saving Princess v0_8.exe located in the folder which contains the patched data.win file.

Note that this is not Saving Princess.exe, but rather one of the files found inside of it, as explained in the installation section of this same document.

The game starts with an error screen

Please make sure that gm-apclientpp.dll, which is included in the saving_princess_archipelago.zip download, has been placed in the game's directory.

Gameplay Questions

What happens if I lose connection?

If a disconnection occurs, you will see the HUD connection indicator go grey. From here, the game will automatically try to reconnect. You can tell it succeeded if the indicator regains its color.

If the game is unable to reconnect, save and restart.

Although you can keep playing while disconnected, you won't get any items until you reconnect, not even items found in your own game. Once reconnected, however, all of your progress will sync up.

I got an item, but it did not say who sent it to me

Items sent to you by yourself do not list the sender.

Additionally, if you get an item while already having the max for that item (for example, you have 9 ammo and get sent a Clip Extension), no message will be shown at all.

I pressed the release/collect button, but nothing happened

It is likely that you do not have release or collect permissions, or that there is nothing to release or collect. Another option is that your connection was interrupted.

If you would still like to use release or collect, refer to this section of the server commands page.

You may use the in-game console to execute the commands, if your slot has permissions to do so.

I am trying to configure my controller, but the menu keeps closing itself

Steam Input will make your controller behave as a keyboard and mouse even while not playing any Steam games.

To fix this, simply close Steam while playing Saving Princess.

Another option is to disable Steam Input under Steam -> Settings -> Controller -> External Gamepad Settings