Skip to content

Commit 849ed06

Browse files
committed
docs: add basic smsm stuff to readme
and improved some things on the site and actions
1 parent 67c3a7b commit 849ed06

File tree

4 files changed

+50
-13
lines changed

4 files changed

+50
-13
lines changed

.github/workflows/CI.yml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,12 @@ on:
44
push:
55
branches: '**'
66
tags-ignore: '**'
7-
paths:
8-
- 'pak01_dir/**'
9-
- 'smsm/**'
7+
paths-ignore:
8+
- 'doc/**'
109
pull_request:
1110
branches: '**'
12-
paths:
13-
- 'pak01_dir/**'
14-
- 'smsm/**'
11+
paths-ignore:
12+
- 'doc/**'
1513
workflow_dispatch:
1614

1715
jobs:

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,43 @@
1515

1616
A mod for speedrunning Portal 2 with minimal downtime and support for alternate gamemodes.
1717

18-
fFor more information and installation instructions, please visit [the website].
18+
For more information and installation instructions, please visit [the website].
1919

2020
[the website]: https://sm.portal2.sr/
21+
22+
## Contributing
23+
24+
### SMSM (Speedrun Mod Simple Modifier)
25+
26+
SMSM is a basic plugin that Speedrun Mod uses to handle modes and settings, as
27+
well as some ad-hoc patches and hooks into the game.
28+
29+
1. Fork the repository
30+
2. Clone your fork
31+
3. Create a new branch
32+
4. Make your changes
33+
5. Create a pull request
34+
35+
#### Windows
36+
37+
You'll need:
38+
39+
- [Visual Studio Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)
40+
- Windows Universal C Runtime
41+
- C++ Build Tools core features
42+
- Windows 10 SDK (10.0.18362.0)
43+
- MSVC v142 - VS 2019 C++ x64/x86 build tools
44+
45+
```batch
46+
msbuild -m -p:"Platform=x86" SMSM.sln
47+
```
48+
49+
#### Linux
50+
51+
You'll need:
52+
53+
- `g++-10-multilib`
54+
55+
```bash
56+
make -j$(nproc)
57+
```

doc/web/index.html

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h1>Credits</h1>
9797
<div class="p2box col-12">
9898
<div class="mode">
9999
<div class="mode-header">
100-
<h1>Normal mode<!--<span id="coop-ad">(Now featuring coop!)</span>--></h1>
100+
<h1>Normal mode <span id="coop-ad">(Now featuring coop!)</span></h1>
101101
</div>
102102
<p>
103103
The main and original mode of Speedrun Mod. It's also a base for all the other modes.
@@ -221,12 +221,13 @@ <h1>Installation guide</h1>
221221
<h1>Troubleshooting</h1>
222222
<p>
223223
Keep in mind that this mod is a compilation of <b>dirty hacks</b> that this poor 2011 engine was not prepared for.
224-
In case the game crashes or bugs itself in unexplainable way, try one of these things:
224+
In case the game crashes or bugs itself in an unexplainable way, try one of these things:
225225
<ul>
226226
<li>Launch the <b>main game</b>, then the mod.</li>
227227
<li>(D3D error) Temporarily add <code>-safe</code> to the launch options in the mod's Steam properties.</li>
228-
<li>(Manifest file error) Install the mod on the <b>same drive</b> as the main game.</li>
229-
<li>If you are missing <code>smsm.dll</code>, you downloaded the mod from the wrong place. See the button above?</li>
228+
<li>(Manifest file error) Install the mod on the <b>same drive</b> as the main game,
229+
or <a target="_blank" href="https://discord.com/channels/146404426746167296/1085725696665595934/1144043513265274920" title="P2SR Discord help FAQ">edit the files.</a></li>
230+
<li>If you are missing <code>smsm.dll</code>, you downloaded the mod from the wrong place. See the big blue button above?</li>
230231
<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>
231232
<li>Update other extensions (like SAR), because they might be the one causing trouble.</li>
232233
</ul>
@@ -235,7 +236,8 @@ <h1>Troubleshooting</h1>
235236
<li>Taking a hot bath and walking in fresh air for at least 30 minutes. (environment permitting)</li> <!-- Or stay at home. -->
236237
<li>Jumping from a ground-floor window.</li>
237238
</ul>
238-
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>.
239+
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>,
240+
or <a href="https://github.com/p2sr/Portal2SpeedrunMod/issues" title="GitHub issues" target="_blank">make an issue</a>.
239241
</p>
240242
</div>
241243
</div>

smsm/src/chaos.vcxproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<VCProjectVersion>15.0</VCProjectVersion>
2323
<ProjectGuid>{BA13479B-E6FE-4327-B16F-196BF3BE80FF}</ProjectGuid>
2424
<RootNamespace>chaos</RootNamespace>
25-
<WindowsTargetPlatformVersion>10.0.17763.0</WindowsTargetPlatformVersion>
25+
<WindowsTargetPlatformVersion>10.0.18362.0</WindowsTargetPlatformVersion>
2626
<ProjectName>SMSM</ProjectName>
2727
</PropertyGroup>
2828
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />

0 commit comments

Comments
 (0)