Difference between revisions of "Welcome"

From P2SR Wiki

m (Grammar)
m
 
(30 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__
 
 
{{P2_Infobox|Welcome|p2_background.jpg|
 
{{P2_Infobox|Welcome|p2_background.jpg|
 
*''Speedrun.com'' [https://www.speedrun.com/portal_2/resources Resources]
 
*''Speedrun.com'' [https://www.speedrun.com/portal_2/resources Resources]
*''iVerb'' [https://board.iverb.me/about About]
+
*''CM Boards'' [https://board.portal2.sr/about About]
 
*''Source Auto Record'' [[SAR]] Wiki Page
 
*''Source Auto Record'' [[SAR]] Wiki Page
 
}}
 
}}
  
 
=Overview=
 
=Overview=
A guide to try and link together all you need to get Portal 2 Speedruns up and running.  
+
A guide to link together all the downloads and resources you need to get Portal 2 speedruns up and running.
 +
 
  
 
=Setup=
 
=Setup=
 +
{{P2_Video|url=https://www.youtube.com/watch?v=ykBHtRd8Oyg|desc=Setup Guide For Portal 2}}
 
Setting up Portal 2 for speedruns isn't too difficult, but there are a few things you should get quickly familiar with.  
 
Setting up Portal 2 for speedruns isn't too difficult, but there are a few things you should get quickly familiar with.  
  
*If you're playing Single Player, [[SAR]] is ''highly'' recommended.
+
*Portal 2 speedruns are done on the current Steam version of the game, no downgrading is needed.
*Livesplit is also used for single player full game runs, and can be linked with SAR for accurate timing.
+
*Using [[SAR]] is ''highly'' recommended (See below for information).
*For coop, we use [https://www.speedrun.com/tools/SourceLiveTimer_15_02_2017_eu55l.zip Source Live Timer] and demos to time runs.
+
*LiveSplit can also be used for runs, and can be linked with SAR for accurate timing and pausing during loads.
  
 
==Source Auto Record (SAR)==
 
==Source Auto Record (SAR)==
 +
Portal 2 speedrunners use [[SAR]] to time runs and to add quality of life commands to the game to make speedrunning less of a hassle. This includes adding commands to accurately time your runs, lowering loading times and making demo recording easier.
  
Portal 2 Speedrunners use [[SAR]] to time single player runs and to add quality of life commands to the game to make speedrunning less of a hassle. This includes commands to accurately time your runs, lower loading times and make demo recording easier.
+
You can download the latest version of SAR at [https://github.com/p2sr/SourceAutoRecord/releases SAR's GitHub Page]. It is also recommended you download the <code>sar.pdb</code> file, as it expands crash logs to give more information, if Portal 2 were to ever crash.
 
 
The wiki page for [[SAR]] here gives...
 
*Links to the most up-to-date version of [[SAR]]
 
*How to install [[SAR]] and link it with [https://livesplit.org/downloads/ Livesplit]  
 
*A large list of helpful commands and how to use them.
 
*A link to the entire list of SAR [https://github.com/Blenderiste09/SourceAutoRecord/blob/pre-release/doc/cvars.md cvars].
 
 
 
==Demos==
 
  
[[Demo]]s in Portal 2 are often used as a means of proof for runs. They're a lightweight recording method that take up virtually no system resources, and are easy to submit for runs.
+
Installing SAR and the PDB is as easy as placing it in your Portal 2 install, <code>(steam installation)\steamapps\common\Portal 2</code>. Make sure it's <code>sar.dll</code> (with file extensions visible), not <code>sar (1).dll</code> or <code>sar.dll.dll</code>!
  
The wiki page on [[Demo]]s gives information on:
+
The wiki page for [[SAR]] gives more information on many of SAR's features and commands, as well as customizing the plugin to your liking.
*Demos
 
*Methods of recording (traditional and with [[SAR]])
 
*Saving locations
 
*Rendering
 
  
==Full Game Single Player Setup==
+
==srconfigs==
{{P2_Video|url=https://www.youtube.com/watch?v=TMuXUffubwY|time=0|desc=Basic Setup Guide For Full Game}}
+
[https://github.com/p2sr/srconfigs srconfigs] is a set of configuration files designed to take advantage of many of SAR's features, and automatically set up Portal 2 for speedrunning.
  
===Container Ride Save===
+
To install srconfigs:
 +
# Head to the [https://s.portal2.sr/srconfigs srconfigs Releases page], and download the newest ZIP.
 +
# Open up the configs folder in your Portal 2 install (<code>(steam installation)\steamapps\common\Portal 2\portal2\cfg</code>).
 +
# Open up the srconfigs ZIP, open the srconfigs folder inside of that, and then place all of the folders and CFG files inside of the cfg folder, so that file paths look like <code>Portal 2\portal2\cfg\autoexec.cfg</code>, <code>Portal 2\portal2\cfg\extra.cfg</code>, <code>Portal 2\portal2\cfg\mtriggers\mtriggers.cfg</code>, etc.
 +
# Inside Portal 2, bind your scrollwheel to +scrollup and +scrolldown, you can do this by typing <code>bind mwheelup +scrollup</code> and <code>bind mwheeldown +scrolldown</code> into console.
  
The save file and demo file for the container ride save can be found on the [resources page of speedrun.com https://www.speedrun.com/portal_2/resources]. To add the save, you must place it in <code>(steam installation)\steamapps\common\Portal 2\portal2\SAVE\(numbers)</code> where <code>(steam installation)</code> is where your portal 2 game is installed and <code>(numbers)</code> is a string of numbers that represents your steam ID.
+
The [https://github.com/p2sr/srconfigs/blob/master/README.md README] file on the srconfigs GitHub page goes in depth with binds, customizations, and more to customize Portal 2 to how you like, and is highly recommended to read over.
  
The demo file does not need to go here, it can be used for timing the demos of your run, or if you want to render out your run for others to see, but is not needed for gameplay.
+
==Vault Save==
 +
Vault Save is a save file that many speedrunners use to skip the 5 minute long cutscene at the start of Portal 2's Singleplayer campaign. It is fully allowed, and recommended for runner's sanities.
  
===Full Game Demo Recording===
+
To install Vault Save:
 +
# Head to the [https://www.speedrun.com/portal_2/resources resources page of Speedrun.com], and download the Vault Save.
 +
# Open the ZIP file you downloaded, and place the <code>.sav</code> file into <code>Portal 2\portal2\SAVE\(numbers)</code>, where (numbers) is a string of numbers that represents your Steam ID.
 +
# The associated <code>.dem</code> file does not need to go into the aforementioned folder. It can be used for timing the demos of your speedrun, if need be, but it is not needed for gameplay.
  
Recording demos is as simple as typing <code>record demoname</code> in console (''demoname'' can be replaced by any name). <code>sar_auto_record</code> is used in full game runs, and allows demo recording to continue automatically between level transitions / deaths / loads.  
+
==Configuring SAR with LiveSplit==
 +
[https://livesplit.org LiveSplit] can be used to show the sections in a speedrun, for Portal 2 these are the 62 maps, and can display information like personal bests, segment bests, time save, and more.
  
*If you are using the '''container ride save''', you must start recording before your crosshair appears (which happens once the container has broken through the wall)
+
To use SAR with LiveSplit:
*If you're ''not'' using the '''container ride save'''. Be sure to pause your game before the wakeup animation is completed, and start recording a demo
+
# Download LiveSplit from the [https://livesplit.org/downloads site's downloads page], and extract the ZIP file into the directory where you wish to install LiveSplit.
*To end a run, stop recording demos once you've shot the moon at the end of the game using the console command <code>stop</code>
+
# Head to the [https://www.speedrun.com/portal_2/resources resources page of Speedrun.com], and download the splits file for the category you plan to run. <code>Portal 2 Blank Splits (w/ Subsplits)</code> for Singleplayer, and the <code>Coop AMC, AC, or Any% Splits</code> for one of the Coop categories. Ensure to extract the ZIP file you download.
 +
# Open up the Splits file with LiveSplit. You can do this by opening LiveSplit and going to <code>Right click > Open Splits > From File</code> and select the <code>.lss</code> file you downloaded and extracted.
 +
# To get SAR connected to LiveSplit, head to <code>Right click > Edit Splits</code>, and select the ACTIVATE button where it says "Game Time and Auto Splitting are available. (By NeKz and mlugg)".
  
 +
==Starting a Speedrun==
 +
With srconfigs installed, the only thing you need to do to start a speedrun is to run the command <code>do_reset</code> into the Developer Console. Demos will automatically start recording, the timer will be automatically reset, and the Vault Save will automatically load.
  
==Coop All Main Chambers / All Chambers Setup==
+
It should be noted that srconfigs can also load this save's predecessor, Container Ride Save (CRS) if you run <code>svar_set sp_use_save 1</code> in the in-game console.
 
 
===Timing in Coop===
 
[[SAR]] and Live Split are inaccurate for coop speedruns. Currently, the only accurate timing method for coop is done through Blue (the server host's) demos. We use [https://www.speedrun.com/tools/SourceLiveTimer_15_02_2017_eu55l.zip Source Live Timer] to time these demos after they're created. The download includes three files, <code>Newtonsoft.Json.dll</code> file, a <code>SourceLiveTimer.exe</code> file, and a readme. Here is a copy of the readme instructions for Source Live Timer.
 
 
 
How to use:
 
 
 
*1. Right click the tool to open the context menu.
 
*2. Click "Demo Directory" and select the appropriate demos folder (For Portal 2: /Steam/SteamApps/common/Portal 2/portal2).
 
*3. Start your run and start recording demos, the timer should identify that a demo is recording and will state its name next to "Current Demo".
 
*4. After completing or failing a run, click "Reset".
 
*5. Don't forget to save the splits before closing the tool.
 
 
 
For more of the basics of Coop runs in Portal 2, check out our [[Coop Run]]s page
 
 
 
=Binds / Config=
 
 
 
==Enabling Developer Console==
 
 
 
Commands and certain binds can only be entered from the developer console. To enable the developer console, follow this path
 
 
 
'''Options -> Keyboard/Mouse -> Allow Developer Console'''
 
 
 
To open the console, use the <code>`/~</code> key, at the upper-left-hand corner of your keyboard.
 
 
 
==Basic Binds==
 
Bind follow a simple formula: <code>bind key command</code>
 
Many binds can be reassigned in the <code>Keyboard/Mouse</code> options menu. However, there are many things that can only be done using console binds.
 
 
 
All Portal 2 speedrunners bind the <code>+jump</code> action to their mouse wheel (either up or down) in order to jump as soon as they hit the ground, without needing to precisely time their inputs.
 
This can be done using either
 
 
 
*<code>bind mwheelup +jump</code>
 
*<code>bind mwheeldown +jump</code>
 
 
 
For precise aiming, a sensitivity bind can be useful (ex: [[Secret Panel]]).
 
*<code>bind key "sensitivity value"</code> (Example: <code>bind q "sensitivity 1"</code>)
 
 
 
'''Coop taunts''' can be important for coop runs.
 
*<code>bind key taunt</code> - Used for air taunts, will not bring up taunt menu on the ground.
 
*<code>bind key +mouse_menu_taunt</code> - Brings up bot taunt menu.
 
 
 
For seeing the '''partner view''', the key is often bound to <code>w</code>, so that it can be kept up constantly.
 
*<code>bind w "+forward; +remote_view"</code> - makes <code>w</code> move you forward, and brings up the partner view.
 
 
 
===Bind Rules===
 
<pre style="color:red">NOTE: Assigning multiple action commands to a single key is banned (Exceptions are made for +remote_view)</pre>
 
Read more on the [https://docs.google.com/document/d/1xzN3vX4en2UCDeB3HPd_3D2zLaVkNsVtiNFyM0qlEXs Challenge Mode Rules] or the [https://www.speedrun.com/Portal_2 Full Game Rules]
 
 
 
==Execs==
 
In the source engine, [[.cfg Files]] are used as a way to save commands in a file, and run all those commands at once by running it through the game.  
 
 
 
Plugins must be loaded and unloaded at startup and shutdown of Portal 2. This means that any [[SAR]] commands you use will be reset to defaults upon exiting the game. We highly recommend reading up on [[.cfg Files]], [[autoexec]]s and [[Alias]]es.
 
 
 
An example autoexec for fullgame would consist of these commands:
 
 
 
*<code>sar_speedrun_autostart 0</code> - Prevents immediate start when loading into the level
 
*<code>sar_autorecord 1</code> - Will continue demo recordings after death and through level transitions
 
*<code>sar_speedrun_offset 16868</code>  - Offset for your timer to work with the containerridesave
 
*<code>sar_speedrun_time_pauses 0</code> - Timer will not continue while paused (Be sure to look into rules about pause abuse)
 
*<code>cl_showpos 1</code> - Shows your player's look angle, and position and velocity (Used for Secret Panel, Column Blocker, and Three Gels)
 
*<code>sar_speedrun_reset</code> - Resets your run
 
 
 
  
 
=Gameplay=
 
=Gameplay=
 +
Here's a short guide to start you with learning basic movement and routes for Portal 2. For any questions about gameplay, head to the <code>#gameplay-help</code> channel on our [https://discord.gg/p2sr Discord server].
  
 
==Bunnyhopping==
 
==Bunnyhopping==
 +
{{P2_Video|url=https://www.youtube.com/watch?v=lAgFkSNw2pw|desc=Bunnyhopping Tutorial}}
 
The core movement method of Portal 2 is Bunnyhopping. Useful resources and help for bunnyhopping can be found here on our wiki. [[Bunnyhopping help]] provides videos and information on not only bunnyhopping, but also how to go about getting help improving your hops from other runners.
 
The core movement method of Portal 2 is Bunnyhopping. Useful resources and help for bunnyhopping can be found here on our wiki. [[Bunnyhopping help]] provides videos and information on not only bunnyhopping, but also how to go about getting help improving your hops from other runners.
  
Line 126: Line 69:
 
One of the most useful glitches/exploits in Portal 2 is the [[Reportal]].  
 
One of the most useful glitches/exploits in Portal 2 is the [[Reportal]].  
  
A newer, and more powerful varient, the [[Super-Reportal]] is becoming more widely used and popular now in the game. It operates in a similar way, but involves a method of getting the player stuck, and chaining multiple reportals.
+
A newer, and more powerful variant, the [[Reportal#Super Reportal|Super Reportal]] is becoming more widely used and popular now in the game. It operates in a similar way, but involves a method of getting the player stuck, and chaining multiple reportals.
  
 
==Learning Routes==
 
==Learning Routes==
 +
YouTube Playlists:
 +
* [https://www.youtube.com/playlist?list=PLIGHJbDLEQ_D7td1BRGdlHjLRMZ_S0nYh Full Game Singleplayer Tutorial]
 +
* [https://www.youtube.com/playlist?list=PLWahd0AHISYOJuUhxUUUl6OlQ2JkEX_iF Airhead's Full Game Co-op Tutorial]
 +
* [https://www.youtube.com/playlist?list=PLPzgoQCR7eDYoJyg7D2ul5sf3JG_J_dzb Unity's Singleplayer Challenge Mode Tutorials]
 +
* [https://www.youtube.com/playlist?list=PLPzgoQCR7eDYtmiRDWvOhLdOQQz7hJNnq Unity's Co-op Challenge Mode Tutorials]
 +
* [https://www.youtube.com/playlist?list=PLIGHJbDLEQ_DUXkgXb9AN7pcW9xQgoyMS Rattle's Portal Stories: Mel Tutorial]
  
[https://youtu.be/ZjQJmEPy50Y?list=PLc4Y8DtiFCXDcrbhmmnObxw7n7GoiTIwn This playlist] includes all of Can't Even's full game tutorial videos. It's currently the most up-to-date resources for all of the maps in the game.
+
For much more detailed information on maps, check out the wiki's [[List of Singleplayer maps]] and [[List of Co-op maps]] check to see if the chamber you need help on has information on it. Many of the pages are still a work-in-progress, but it is by-far the most in-depth information available on these chambers.
 
 
For much more detailed information on maps, check out the wiki's [[List of Singleplayer maps]] and [[List_of_Co-op_maps]] check to see if the chamber you need help on has information on it. Many of the pages are still a work-in-progress, but it is by-far the most in-depth information available on these chambers.
 
  
 
[[Category:Help]]
 
[[Category:Help]]

Latest revision as of 21:08, 20 September 2024

P2 background.jpg

Welcome


Overview

A guide to link together all the downloads and resources you need to get Portal 2 speedruns up and running.


Setup

Setup Guide For Portal 2

Setting up Portal 2 for speedruns isn't too difficult, but there are a few things you should get quickly familiar with.

  • Portal 2 speedruns are done on the current Steam version of the game, no downgrading is needed.
  • Using SAR is highly recommended (See below for information).
  • LiveSplit can also be used for runs, and can be linked with SAR for accurate timing and pausing during loads.

Source Auto Record (SAR)

Portal 2 speedrunners use SAR to time runs and to add quality of life commands to the game to make speedrunning less of a hassle. This includes adding commands to accurately time your runs, lowering loading times and making demo recording easier.

You can download the latest version of SAR at SAR's GitHub Page. It is also recommended you download the sar.pdb file, as it expands crash logs to give more information, if Portal 2 were to ever crash.

Installing SAR and the PDB is as easy as placing it in your Portal 2 install, (steam installation)\steamapps\common\Portal 2. Make sure it's sar.dll (with file extensions visible), not sar (1).dll or sar.dll.dll!

The wiki page for SAR gives more information on many of SAR's features and commands, as well as customizing the plugin to your liking.

srconfigs

srconfigs is a set of configuration files designed to take advantage of many of SAR's features, and automatically set up Portal 2 for speedrunning.

To install srconfigs:

  1. Head to the srconfigs Releases page, and download the newest ZIP.
  2. Open up the configs folder in your Portal 2 install ((steam installation)\steamapps\common\Portal 2\portal2\cfg).
  3. Open up the srconfigs ZIP, open the srconfigs folder inside of that, and then place all of the folders and CFG files inside of the cfg folder, so that file paths look like Portal 2\portal2\cfg\autoexec.cfg, Portal 2\portal2\cfg\extra.cfg, Portal 2\portal2\cfg\mtriggers\mtriggers.cfg, etc.
  4. Inside Portal 2, bind your scrollwheel to +scrollup and +scrolldown, you can do this by typing bind mwheelup +scrollup and bind mwheeldown +scrolldown into console.

The README file on the srconfigs GitHub page goes in depth with binds, customizations, and more to customize Portal 2 to how you like, and is highly recommended to read over.

Vault Save

Vault Save is a save file that many speedrunners use to skip the 5 minute long cutscene at the start of Portal 2's Singleplayer campaign. It is fully allowed, and recommended for runner's sanities.

To install Vault Save:

  1. Head to the resources page of Speedrun.com, and download the Vault Save.
  2. Open the ZIP file you downloaded, and place the .sav file into Portal 2\portal2\SAVE\(numbers), where (numbers) is a string of numbers that represents your Steam ID.
  3. The associated .dem file does not need to go into the aforementioned folder. It can be used for timing the demos of your speedrun, if need be, but it is not needed for gameplay.

Configuring SAR with LiveSplit

LiveSplit can be used to show the sections in a speedrun, for Portal 2 these are the 62 maps, and can display information like personal bests, segment bests, time save, and more.

To use SAR with LiveSplit:

  1. Download LiveSplit from the site's downloads page, and extract the ZIP file into the directory where you wish to install LiveSplit.
  2. Head to the resources page of Speedrun.com, and download the splits file for the category you plan to run. Portal 2 Blank Splits (w/ Subsplits) for Singleplayer, and the Coop AMC, AC, or Any% Splits for one of the Coop categories. Ensure to extract the ZIP file you download.
  3. Open up the Splits file with LiveSplit. You can do this by opening LiveSplit and going to Right click > Open Splits > From File and select the .lss file you downloaded and extracted.
  4. To get SAR connected to LiveSplit, head to Right click > Edit Splits, and select the ACTIVATE button where it says "Game Time and Auto Splitting are available. (By NeKz and mlugg)".

Starting a Speedrun

With srconfigs installed, the only thing you need to do to start a speedrun is to run the command do_reset into the Developer Console. Demos will automatically start recording, the timer will be automatically reset, and the Vault Save will automatically load.

It should be noted that srconfigs can also load this save's predecessor, Container Ride Save (CRS) if you run svar_set sp_use_save 1 in the in-game console.

Gameplay

Here's a short guide to start you with learning basic movement and routes for Portal 2. For any questions about gameplay, head to the #gameplay-help channel on our Discord server.

Bunnyhopping

Bunnyhopping Tutorial

The core movement method of Portal 2 is Bunnyhopping. Useful resources and help for bunnyhopping can be found here on our wiki. Bunnyhopping help provides videos and information on not only bunnyhopping, but also how to go about getting help improving your hops from other runners.

Reportals

One of the most useful glitches/exploits in Portal 2 is the Reportal.

A newer, and more powerful variant, the Super Reportal is becoming more widely used and popular now in the game. It operates in a similar way, but involves a method of getting the player stuck, and chaining multiple reportals.

Learning Routes

YouTube Playlists:

For much more detailed information on maps, check out the wiki's List of Singleplayer maps and List of Co-op maps check to see if the chamber you need help on has information on it. Many of the pages are still a work-in-progress, but it is by-far the most in-depth information available on these chambers.