docs: add basic smsm stuff to readme

and improved some things on the site and actions

Author: ThisAMJ

.github/workflows/CI.yml

@@ -4,14 +4,12 @@ on:
   push:
     branches: '**'
     tags-ignore: '**'
-    paths:
-      - 'pak01_dir/**'
-      - 'smsm/**'
+    paths-ignore:
+      - 'doc/**'
   pull_request:
     branches: '**'
-    paths:
-      - 'pak01_dir/**'
-      - 'smsm/**'
+    paths-ignore:
+      - 'doc/**'
   workflow_dispatch:
 
 jobs:

README.md

@@ -15,6 +15,43 @@
 
 A mod for speedrunning Portal 2 with minimal downtime and support for alternate gamemodes.
 
-fFor more information and installation instructions, please visit [the website].
+For more information and installation instructions, please visit [the website].
 
 [the website]: https://sm.portal2.sr/
+
+## Contributing
+
+### SMSM (Speedrun Mod Simple Modifier)
+
+SMSM is a basic plugin that Speedrun Mod uses to handle modes and settings, as
+well as some ad-hoc patches and hooks into the game.
+
+1. Fork the repository
+2. Clone your fork
+3. Create a new branch
+4. Make your changes
+5. Create a pull request
+
+#### Windows
+
+You'll need:
+
+- [Visual Studio Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)
+- Windows Universal C Runtime
+- C++ Build Tools core features
+- Windows 10 SDK (10.0.18362.0)
+- MSVC v142 - VS 2019 C++ x64/x86 build tools
+
+```batch
+msbuild -m -p:"Platform=x86" SMSM.sln
+```
+
+#### Linux
+
+You'll need:
+
+- `g++-10-multilib`
+
+```bash
+make -j$(nproc)
+```

doc/web/index.html

@@ -97,7 +97,7 @@ <h1>Credits</h1>
         <div class="p2box col-12"> 
             <div class="mode">
                 <div class="mode-header">
-                    <h1>Normal mode<!--<span id="coop-ad">(Now featuring coop!)</span>--></h1>
+                    <h1>Normal mode <span id="coop-ad">(Now featuring coop!)</span></h1>
                 </div>
                 <p>
                     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>
             <h1>Troubleshooting</h1>
             <p>
                 Keep in mind that this mod is a compilation of <b>dirty hacks</b> that this poor 2011 engine was not prepared for. 
-                In case the game crashes or bugs itself in unexplainable way, try one of these things:
+                In case the game crashes or bugs itself in an unexplainable way, try one of these things:
                 <ul>
                     <li>Launch the <b>main game</b>, then the mod.</li>
                     <li>(D3D error) Temporarily add <code>-safe</code> to the launch options in the mod's Steam properties.</li>
-                    <li>(Manifest file error) Install the mod on the <b>same drive</b> as the main game.</li>
-                    <li>If you are missing <code>smsm.dll</code>, you downloaded the mod from the wrong place. See the button above?</li>
+                    <li>(Manifest file error) Install the mod on the <b>same drive</b> as the main game,
+                        or <a target="_blank" href="https://discord.com/channels/146404426746167296/1085725696665595934/1144043513265274920" title="P2SR Discord help FAQ">edit the files.</a></li>
+                    <li>If you are missing <code>smsm.dll</code>, you downloaded the mod from the wrong place. See the big blue button above?</li>
                     <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>
                     <li>Update other extensions (like SAR), because they might be the one causing trouble.</li>
                 </ul>
@@ -235,7 +236,8 @@ <h1>Troubleshooting</h1>
                     <li>Taking a hot bath and walking in fresh air for at least 30 minutes. (environment permitting)</li> <!-- Or stay at home. -->
                     <li>Jumping from a ground-floor window.</li>
                 </ul>
-                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>.
+                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>,
+                or <a href="https://github.com/p2sr/Portal2SpeedrunMod/issues" title="GitHub issues" target="_blank">make an issue</a>.
             </p>
         </div>
     </div>

smsm/src/chaos.vcxproj

@@ -22,7 +22,7 @@
     <VCProjectVersion>15.0</VCProjectVersion>
     <ProjectGuid>{BA13479B-E6FE-4327-B16F-196BF3BE80FF}</ProjectGuid>
     <RootNamespace>chaos</RootNamespace>
-    <WindowsTargetPlatformVersion>10.0.17763.0</WindowsTargetPlatformVersion>
+    <WindowsTargetPlatformVersion>10.0.18362.0</WindowsTargetPlatformVersion>
     <ProjectName>SMSM</ProjectName>
   </PropertyGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />