forked from p2sr/SourceAutoRecord
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
241 lines (220 loc) · 14.2 KB
/
Copy pathindex.html
File metadata and controls
241 lines (220 loc) · 14.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>SourceAutoRecord</title>
<link rel="stylesheet" type="text/css" href="style.css">
<link rel="icon" type="image/png" href="https://avatars.githubusercontent.com/u/83299896">
<meta name="description" content="SourceAutoRecord (SAR) is a plugin for Portal 2 and mods based on it, bringing lots of features and modifications into the game for speedrunners and people alike.">
<meta property="og:description" content="SourceAutoRecord (SAR) is a plugin for Portal 2 and mods based on it, bringing lots of features and modifications into the game for speedrunners and people alike.">
<meta name="twitter:description" content="SourceAutoRecord (SAR) is a plugin for Portal 2 and mods based on it, bringing lots of features and modifications into the game for speedrunners and people alike.">
<meta property="og:title" content="SourceAutoRecord">
<meta property="og:image" content="/img/sar_logo.webp">
<meta property="og:type" content="website">
<meta property="og:url" content="https://sar.portal2.sr/">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="SourceAutoRecord">
<meta name="twitter:image" content="/img/sar_logo.webp">
</head>
<body>
<nav>
<h1>SourceAutoRecord</h1>
<a href="#overview"><h3>Overview/Features</h3></a>
<a href="#installation"><h3>Installation</h3></a>
<a href="#support"><h3>Game support</h3></a>
<a href="#documentation"><h3>Documentation</h3></a>
</nav>
<hr>
<main>
<a id="overview"></a>
<img src="img/sar_logo.webp" alt="SAR Banner" id="sar-banner">
<div id="badges">
<a href="https://github.com/p2sr/SourceAutoRecord/actions?query=workflow%3ACI+branch%3Amaster" target="_blank"><img src="https://github.com/p2sr/SourceAutoRecord/workflows/CI/badge.svg" alt="CI"></a>
<a href="https://github.com/p2sr/SourceAutoRecord/actions?query=workflow%3ACD+branch%3Amaster" target="_blank"><img src="https://github.com/p2sr/SourceAutoRecord/workflows/CD/badge.svg" alt="CD"></a>
<a href="https://github.com/p2sr/SourceAutoRecord/releases/latest" target="_blank"><img src="https://img.shields.io/github/v/release/p2sr/SourceAutoRecord?label=latest%20release" alt="Latest release"></a>
<a href="https://github.com/p2sr/SourceAutoRecord/blob/master/LICENSE" target="_blank"><img src="https://img.shields.io/github/license/p2sr/SourceAutoRecord" alt="License"></a>
</div>
<h1>Overview</h1>
<p><i>SourceAutoRecord</i>, or <i>SAR</i>, is a plugin for Portal 2 and mods based on it, bringing lots of features
and modifications into the game for speedrunners and people alike. To install it, head down to the
<a href="#installation">installation instructions</a>.</p>
<h1 id="features">Features</h1>
<h3>General:</h3>
<ul>
<li>Advanced automatic demo recording.</li>
<li>Reduced loading times.</li>
<li>Configurable in-game input display.</li>
<li>Lots of useful text HUDs (position, view angles, velocity, ground frames etc.), as well as custom ones.</li>
<li>Config+, an extension of the in-game console which introduces variables, functions and more.</li>
</ul>
<h3>Speedrunning:</h3>
<ul>
<li>Accurate session timing and LiveSplit integration.</li>
<li>Built-in timer and autosplitter with complex custom rule system.</li>
<li>Auto-submission of Challenge Mode runs to the <a href="https://board.portal2.sr" target="_blank">community leaderboards.</a></li>
<li>Ghosts of other players from demos or in a <a href="https://github.com/p2sr/GhostServer" target="_blank">ghost server</a>.</li>
<li>Tools for easier segmented run creation.</li>
</ul>
<h3>TASing:</h3>
<ul>
<li>Custom <code>.p2tas</code> scripting language</li>
<li>Legitimate TAS script playback, controllable with tick advancing, skipping and pausing.</li>
<li>Automation tools (autostrafer, autojump, autoaim etc.)</li>
<li>Integration with <a href="https://code.visualstudio.com/" target="_blank">Visual Studio Code</a> through the
<a href="https://github.com/p2sr/p2tas-lang" target="_blank">p2tas-lang</a> plugin.</li>
<li>Player trace, for recording and showing the path of the player's movement.</li>
</ul>
<h3>Miscellaneous:</h3>
<ul>
<li>Freecam and cinematic camera.</li>
<li>Configurable renderer with video encoding and frame-blending.</li>
<li>In-game overhead image stitcher, which can be used to create top-down minimaps of the level.</li>
<li>Movement modifications like <a href="https://wiki.sourceruns.org/wiki/Accelerated_Back_Hopping" target="_blank">ABH</a>, air control and others.</li>
<li>Other fun cheats.</li>
</ul>
<hr class="horizontal">
<h1 id="installation">Installation</h1>
<p>To install SAR, download the latest release for your operating system, and move it to your
game folder. If you don't know where to find your game folder, you can open it through Steam by navigating to your
library and selecting Portal 2. Then, right-click the game and select <i>Properties</i>. Press <i>Local files</i>,
and <i>Browse</i>. The folder that opens is your game directory. Put the SAR file you just downloaded in here.
SAR does not currently support macOS.</p>
<br><br>
<p>NOTE: Your antivirus may flag SAR as a false positive. If this is the case, open the software
and exclude SAR (mark it as safe). This process depends on which antivirus software you use.</p>
<br><br>
<p>After you have installed SAR, launch the game and open the developer console. Enter <code>plugin_load sar</code>
to load SAR into the game.</p>
<br><br>
<p>NOTE: You will have to manually load SAR every time you launch your game. It is recommended to download
<a href="https://github.com/p2sr/srconfigs/" target="_blank">srconfigs</a>; a set of configuration
files that will automate SAR loading, as well as several other things related to speedrunning. If you are
unable to, or don't want to download srconfigs, it is recommended to have an <a href="https://wiki.portal2.sr/Autoexec" target="_blank">autoexec</a>
that loads SAR upon game launch.</p>
<br><br>
<p>In order to update SAR, you can simply use the in-game SAR console command <code>sar_update</code>.</p>
<br>
<div id="download"></div>
<br><br>
<p>You can also check the <a href="https://github.com/p2sr/SourceAutoRecord/releases" target="_blank">release page</a>
for other versions.</p>
<br><br>
<p>NOTE: Submitting a run on an older version of SAR is against the rules, and will get your run removed from
the leaderboards. It is recommended to be on the latest version of SAR unless stated otherwise in the community
<a href="https://discord.gg/hRwE4Zr" target="_blank">Discord server</a>.</p>
<hr class="horizontal">
<h1 id="support">Game support</h1>
<table>
<tr>
<th>Game</th>
<th>Windows</th>
<th>Linux</th>
</tr>
<tr>
<td><a href="https://store.steampowered.com/app/620" target="_blank">Portal 2 (Steam)</a></td>
<td>✔</td>
<td>✔</td>
</tr>
<tr>
<td><a href="https://store.steampowered.com/app/620" target="_blank">Portal 2 (4554)</a></td>
<td>✔</td>
<td>➖</td>
</tr>
<tr>
<td><a href="https://store.steampowered.com/app/280740" target="_blank">Aperture Tag</a></td>
<td>✔</td>
<td><a href="https://wiki.portal2.sr/Aperture_Tag#Linux" target="_blank">➖</a></td>
</tr>
<tr>
<td><a href="https://store.steampowered.com/app/317400" target="_blank">Portal Stories: Mel</a></td>
<td>✔</td>
<td>✔</td>
</tr>
<tr>
<td><a href="https://store.steampowered.com/app/286080" target="_blank">Thinking with Time Machine</a></td>
<td>✔</td>
<td>❌</td>
</tr>
<tr>
<td><a href="https://store.steampowered.com/app/1255980" target="_blank">Portal Reloaded</a></td>
<td>✔</td>
<td>✔</td>
</tr>
<tr>
<td><a href="https://store.steampowered.com/app/251110" target="_blank">INFRA</a></td>
<td>✔</td>
<td>➖</td>
</tr>
<tr>
<td><a href="https://store.steampowered.com/app/303210" target="_blank">The Beginner's Guide</a></td>
<td>✔</td>
<td>✔</td>
</tr>
<tr>
<td><a href="https://store.steampowered.com/app/221910" target="_blank">The Stanley Parable</a></td>
<td>✔</td>
<td>✔</td>
</tr>
<tr>
<td><a href="https://store.steampowered.com/app/3281900" target="_blank">The Cleaning Game</a></td>
<td>✔</td>
<td>➖</td>
</tr>
<tr>
<td>Divinity Chapter 2 <i>(closed beta)</i></td>
<td>✔</td>
<td>❓</td>
</tr>
</table>
<p>If you're playing a game with no Linux support, you can use Proton to run it.</p>
<hr class="horizontal">
<h1 id="documentation">Documentation</h1>
<ul>
<li><a href="https://github.com/p2sr/SourceAutoRecord/blob/master/docs/contributing.md" target="_blank">Contributing</a></li>
<li><a href="https://github.com/p2sr/SourceAutoRecord/blob/master/docs/cvars.md" target="_blank">Console Commands & Variables</a></li>
<li><a href="https://wiki.portal2.sr/SAR" target="_blank">Setup & Usage</a></li>
</ul>
</main>
<!-- Scripts -->
<script>
(async function () {
// Fetch release data from the GitHub API
const stable = (await (await fetch("https://api.github.com/repos/p2sr/SourceAutoRecord/releases/latest")).json());
// Add download buttons to page depending on OS
// FIXME: This is deprecated and MUST be updated soon. However, at the time of making this, there is not yet browser support for the new approach.
// See: https://developer.mozilla.org/en-US/docs/web/api/navigator/platform
const platform = window.navigator.platform.toLowerCase();
if (platform.includes("mac") || platform.includes("iphone") || platform.includes("ipad")) {
document.querySelector("#download").innerHTML = `
<h3>Download:</h3>\n
<p>macOS is not supported. Sorry!</p>
<br>
<h4>Not on macOS?</h4>
<a href="${stable.assets[0].browser_download_url}" class="off-os">Latest release (Windows) - ${stable.name}</a>
<a href="${stable.assets[1].browser_download_url}" class="off-os pdb" title="Makes Windows crash reports more useful for the SAR developers. If you crash, send us the report!">PDB Crash Debugger (Windows)</a>
<a href="${stable.assets[2].browser_download_url}" class="off-os">Latest release (Linux) - ${stable.name}</a>
`;
} else if (platform.includes("win")) {
document.querySelector("#download").innerHTML = `
<h3>Downloads for Windows:</h3>
<a href="${stable.assets[0].browser_download_url}" class="stable">Latest release (${stable.name})</a>
<a href="${stable.assets[1].browser_download_url}" class="stable pdb" title="Makes Windows crash reports more useful for the SAR developers. If you crash, send us the report!">PDB Crash Debugger</a>
<br><br><br>
<h4>Not on Windows?</h4>
<a href="${stable.assets[2].browser_download_url}" class="off-os">Latest release (Linux) - ${stable.name}</a>
`;
} else {
document.querySelector("#download").innerHTML = `
<h3>Downloads for Linux:</h3>
<a href="${stable.assets[2].browser_download_url}" class="stable">Latest release (${stable.name})</a>
<br><br><br>
<h4>Not on Linux?</h4>
<a href="${stable.assets[0].browser_download_url}" class="off-os">Latest release (Windows) - ${stable.name}</a>
<a href="${stable.assets[1].browser_download_url}" class="off-os pdb" title="Makes Windows crash reports more useful for the SAR developers. If you crash, send us the report!">PDB Crash Debugger (Windows)</a>
`;
}
})();
</script>
</body>
</html>