Skip to content

About

Portal 2 Mod for use with Archipelago

Resources

Stars

19 stars

Watchers

0 watching

Forks

Latest commit

 

History

123 Commits

Folders and files

Repository files navigation

Portal 2 Archipelago Mod

Version 0.8.2

Stable In Development

This is a Portal 2 mod designed for use with Archipelago, a multi-game collaborative randomiser.

This must be used with the Portal 2 APWorld and Client version released with the mod.


*Cough cough*

Cave Johnson here.

We have a BIG problem on our hands. I'm gonna bet most of you here already know about the whole multiverse thing. Remember - "infinite earths, with an infinite number of Apertures"?

Well, some of those outer-world Apertures had decided they've had enough of our borrowing, and began stealing testing elements right back from us! AND replacing them with all sorts of weird junk that not even my father would be able to decipher!

Anyway, we're bankrupt. Again. Even more so now than before. But there's no reason to panic! The lab boys and I have been bashing our heads against the wall for a while, but we've found a way to bring it back under control.

That's where you come in. We're going to send a rescue squad through the multiverse to get our precious buttons and cubes back! ...Oh, and my coffee mug. If you see that, bring that back too.

Now, we do need at least a few thousand people back here to manage the place, and one lucky son of a gun to oversee the return of the testing apparatus, so we can't send out everyone.

But if YOU want to be part of the Archipelago Exploration Unit, sign the relevant papers at the reception, then jump into that gaping hole in reality by the water cooler.

Seriously, though, we'll need everyone we can get on this. And fast. Before we have a repeat of what happened wi...

[ ▮▮▮▮ AUDIO LOST ▮▮▮▮ ]


How does Portal 2 work in Archipelago

You play through a randomised chapters completing maps. Initially the puzzle elements (e.g. Upgraded Portal Gun, Weighted Storage Cube) will be unavailable and you will gain them as you play gaining the ability to complete more levels that require these puzzle elements.

Locations

The base locations in the game are completing maps, some of these maps are test chambers and some are locations in aperture laboratories, basically each new loading zone in the game is a separate map. Additional optional locations include:

  • "Cutscene" maps, those that require no input from the player (removed by default)
  • Breaking Wheatley Monitors in Chapter 8 (and one in Chapter 9)
  • Custom buttons in Ratman Dens

Items

Items are test chamber elements e.g. Floor Button, Gels, PotatOS.

The junk filler items include Moon Dust, Slice of Cake and Lemon.

Traps are also in the game and can be set and adjusted in the yaml options.

The Goal

At the moment the only goal is to finish the final level in Chapter 9 (Chapter 9 is not randomised)

Using the Mod

Installation

To use this mod you must first have a copy of Portal 2 downloaded in your Steam library.

  1. Download and install Steam, and download and install Portal 2.
  2. Download the latest Zip archive release of the Portal 2 mod
  3. Extract the top-level folder from the Zip file
  4. Place the Portal2Archipelago folder in the sourcemods Steam folder.
    • On Windows, this may be found at:
      • C:\Program Files (x86)\Steam\steamapps\sourcemods
    • On Linux, this may be found at:
      • ~/.local/share/Steam/steamapps/sourcemods/

The folder structure should look like this:

sourcemods
|   
└─── Portal2Archipelago
    |  GameInfo.txt
    |   ...
    └─── cfg
    └─── ...
  1. Open Steam, and you should see a new game named "Portal 2 Archipelago Mod" in your game library.

Note

If the game does not appear in your Steam game library, please exit (completely closing) Steam and re-launch Steam.

  1. We need to change the properties of the game in order to connect to the Archipelago Portal 2 APWorld client. Right-click the "Portal 2 Archipelago Mod" game in your Library, and select the "Properties..." menu option.
  2. In the dialog that appears, navigate to the "General" menu item, then in the right pane of the dialog navigate to "Launch Options". In the text input:
    • On Windows, put:
      • -netconport 3000
    • On Linux, put:
      • -tools -netconport 3000

Tip

If on Linux, and you cannot get the game to open as expected, you may need to run the game using Proton, following the Windows install steps.

  1. Download and install the portal2.apworld file into the Archipelago launcher using the "Install APWorld" option

Running

  1. Launch the sourcemod (Portal 2 Archipelago Mod) from steam
  2. Open the "Portal 2 Client" from the Archipelago launcher
  3. Input the multiworld server address into the "Server" field at the top of the new window and press connect
  4. Input your slot name into the command field and press enter
  5. When you join a game the client may ask you to select a file with a prompt
    • Simply locate the Portal2Archipelago mod location and find a file called extras.txt in the scripts folder and select that file. For Windows that may looks something like C:/.../Steam/steamapps/sourcemods/Portal2Archipelago/scripts/extras.txt
  6. Now you can select the maps tab in the Portal 2 Text Client and pick any maps you wish to play from there Portal 2 Text Client Menu

Note

The Tracker tab will not appear if you don't have Universal Tracker installed, so don't worry if it isn't there

Portal 2 Client Commands

/check_connection - Displays if the client is able to communicate with Portal 2

/deathlink - Toggles deathlink

/refresh_menu - Refreshes the menu if it is displaying incorrect information - especially useful after a reconnect

/needed {location_name} - Displays information about the item requirements for in logic check completion

FAQ

Why do checks not send/ items are usable in game even if I don't have them unlocked?

This could be due to a few different issues:

  1. You are not using the Portal 2 Client from the Archipelago Launcher. The custom client must be open at all times while playing the game
  2. Your Portal 2 Archipelago Mod has not got the -netconport launch option set. You can check using the /check_connection command in the client. See step 7 of Installation to set the launch option.

Why does my map menu not show any of the maps and just says "Connect to game to load levels"?

You most likely didn't select the correct extras.txt file when joining a game for the first time.

  • Open host.yaml using the "Open host.yaml" button in the Archipelago Client
  • Go down to portal2 and see if the menu_file points to the mods extras.txt file as seen in step 4 of Running

If you selected another file in the mod e.g. GameInfo.txt the game will not run correctly as the file has probably already been overwritten by the client so you will have to replace that file with an original copy or reinstall the mod from scratch.

There is a very small chance that for people running another server on their machine the 3000 port is already in use. In this case you can change the default_port setting in host.yaml to another unused port and the -netconport 3000 to the same port as in host.yaml.

Acknowledgements

Mod Creators

Portal 2 Mod

  • GlassToadstool - Lead Developer
  • Clone Fighter - Loading Screens, Logo Graphics, and Cave Johnson Speech
  • LimeDreaming - Custom Font and Models
  • JD - Icon Graphics
  • Kit Lemonfoot - Documenting Gels for Split

APWorld

  • GlassToadstool - Lead Developer
  • Proplayen - Initial Logic Design
  • Kaito Kid - Assistance
  • studkid - Initial UT Support
  • Charged_Neon - Documentation
  • James - Major Bug Fixing and UT updates
  • Tenebrosful - Intergrated UT into the client

Initial Testers

22TwentyTwo, ahhh reptar, Bfbfan26, buzzman5001, ChaiMint, Default Miserable, Fewffwa, Fox, Grenhunterr, Kit Lemonfoot, Knux, MarioXTurn, miketizzle411, Pigmaster100, Rya, Scrungip

About

Portal 2 Mod for use with Archipelago

Resources

Stars

19 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages