Skip to content

Commit fb541e3

Browse files
committed
docs: move readme info to website
1 parent 013d574 commit fb541e3

File tree

2 files changed

+18
-64
lines changed

2 files changed

+18
-64
lines changed

README.md

Lines changed: 10 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,20 @@
11
# Portal 2 Speedrun Mod
22

3-
[![CI](https://github.com/p2sr/Portal2SpeedrunMod/actions/workflows/CI.yml/badge.svg)](https://github.com/p2sr/Portal2SpeedrunMod/actions/workflows/CI.yml)
4-
5-
A mod for speedrunning Portal 2 with minimal downtime and support for alternate gamemodes.
6-
7-
## Installation
8-
9-
0. Note: for now, this mod is for Windows and Linux users only. Sorry, Mac users :/ Also, make sure you have original game (Portal 2, duh) installed on Steam.
10-
1. Download newest release archive from [releases tab](https://github.com/p2sr/Portal2SpeedrunMod/releases). Do **NOT** download the repository: it contains uncompiled version of plugin and resource files, so it most likely won't work (if even launch) properly.
11-
2. Unzip `Portal 2 Speedrun Mod` folder into `sourcemods` directory (its default location is `Steam/steamapps/sourcemods/`).
12-
3. Restart Steam by going to the top left under Steam then selecting Exit.
13-
4. A new game, called "Portal 2 Speedrun Mod" should appear in your library.
14-
15-
## Currently implemented modes
16-
17-
### Singleplayer Speedrun Mod
18-
19-
- Most of the game's downtime is removed or shortened (like elevators, doors etc.)
20-
- Most of cutscenes were removed or shortened (like Tube Ride, Core etc.)
21-
- A full list of every change can be found [here](https://github.com/p2sr/Portal2SpeedrunMod/blob/master/doc/SingleplayerSRM.md).
3+
<div align="center">
224

23-
### Cooperative Speedrun Mod
5+
[![Speedrun Mod Homepage](doc/web/img/logo_readme.png)](https://sm.portal2.sr/)
246

25-
- Most of the game's downtime is removed or shortened
26-
- The player is no longer forced to perform taunts
7+
</div>
278

28-
### Celeste Mode
9+
<div align="center">
2910

30-
- Everything from Singleplayer Speedrun Mod.
31-
- Celeste-like movement added on top of Portal 2 movement (dash, wave dash, wallclimb and many more).
32-
- Container Ride, Portal Carousel, Portal Gun, Smooth Jazz and PotatOS have been modified to fit Celeste movement into the gameplay.
33-
- Over 100 difficult to find berries!
34-
35-
### Fog%
36-
37-
- Everything from Singleplayer Speedrun Mod.
38-
- Dense fog makes you unable to see further than 128 units.
39-
- If you don't move for 20 seconds, you can see through fog until you move again.
40-
41-
### Reverse Mod
42-
43-
- Start in Finale 4 and make your way back to Container Ride
44-
- Unsolve puzzles along the way
45-
46-
### Odyssey Mod
47-
48-
- Everything from Singleplayer Speedrun Mod.
49-
- Super Mario Odyssey movement added on top of Portal 2 movement
50-
- Control objects at the drop of a hat
51-
- Over 280 difficult to find Moons!
11+
[![CI](https://github.com/p2sr/Portal2SpeedrunMod/actions/workflows/CI.yml/badge.svg)](https://github.com/p2sr/Portal2SpeedrunMod/actions/workflows/CI.yml)
12+
[![Pages](https://github.com/p2sr/Portal2SpeedrunMod/actions/workflows/Pages.yaml/badge.svg)](https://github.com/p2sr/Portal2SpeedrunMod/actions/workflows/Pages.yaml)
5213

53-
### The Floor is Lava
14+
</div>
5415

55-
- Touching the floor damages you
16+
A mod for speedrunning Portal 2 with minimal downtime and support for alternate gamemodes.
5617

57-
## Credits
18+
fFor more information and installation instructions, please visit [the website].
5819

59-
- Krzyhau - main developer.
60-
- Blenderiste09 - Chapter 9 scripting.
61-
- BigDaniel - constantly motivating me to finish this mod.
62-
- NeKz - **HUGE** help with Speedrun Mod Simple Modifier plugin.
63-
- Can't Even, Rex, Spidda and many others - beta testing.
64-
- PortalRunner - Various different mode contributions
65-
- Betsruner - Beta testing, maintenance, and content additions
66-
- AMJ - Maintenance, and content additions
67-
- Nanoman2525 - Cooperative Speedrun Mod
68-
- Valve - Making the greatest puzzle game
20+
[the website]: https://sm.portal2.sr/

doc/web/index.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ <h1>You don't have to go THAT slowly!</h1>
5858
<b>game-changing modes</b>, giving a fresh experience of your favourite test chambers, allowing you to enjoy them in a new unique way.
5959
</p>
6060

61-
<h1>Special thanks</h1>
61+
<h1>Credits</h1>
6262
<p>
6363
This project wouldn't be possible without the help of these individuals:
6464
<ul>
@@ -78,6 +78,7 @@ <h1>Special thanks</h1>
7878
<li><b>PH-MLK</b> - Laser Over Goo crash debugging.</li>
7979
<li><b>BreweryJake</b></li>
8080
<li><b>Rex</b></li>
81+
<li><b>Spidda</b></li>
8182
<li>Turkey, Façade, Oatsy, Soulfur - Coop testing.</li>
8283
<li>..and a bunch of other people we forgot to credit (sorry :/)</li>
8384
</ul>
@@ -220,15 +221,16 @@ <h1>Troubleshooting</h1>
220221
In case the game crashes or bugs itself in unexplainable way, try one of these things:
221222
<ul>
222223
<li>Launch the <b>main game</b>, then the mod.</li>
223-
<li>(D3D Error) Temporarily add <code>-safe</code> to the launch options in the mod's Steam properties</li>
224+
<li>(D3D error) Temporarily add <code>-safe</code> to the launch options in the mod's Steam properties.</li>
224225
<li>(Manifest file error) Install the mod on the <b>same drive</b> as the main game.</li>
225-
<li>Disable any other extensions (like <a target="_blank" href="https://sar.portal2.sr">SAR</a>, for instance) because they might not like each other</li>
226-
<li>Update other extensions (like SAR), because they might be the one causing trouble</li>
226+
<li>If you are missing <code>smsm.dll</code>, you downloaded the mod from the wrong place. See the button above?</li>
227+
<li>Disable any other extensions (like <a target="_blank" href="https://sar.portal2.sr">SAR</a>, for instance) because they might not like each other.</li>
228+
<li>Update other extensions (like SAR), because they might be the one causing trouble.</li>
227229
</ul>
228230
<hr>
229231
<ul>
230-
<li>Taking a hot bath and walking in fresh air for at least 30 minutes (environment permitting)</li> <!-- Or stay at home. -->
231-
<li>Jumping from a ground-floor window</li>
232+
<li>Taking a hot bath and walking in fresh air for at least 30 minutes. (environment permitting)</li> <!-- Or stay at home. -->
233+
<li>Jumping from a ground-floor window.</li>
232234
</ul>
233235
If none of these things work, seek help in the <a href="https://discordapp.com/invite/hRwE4Zr" title="P2SR Discord server" target="_blank">P2SR Discord server</a>.
234236
</p>

0 commit comments

Comments
 (0)