Skip to content

Commit a723f38

Browse files
committed
Add ToC and update.
1 parent 4ff3351 commit a723f38

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@ The programming language associated with SourceMod plugin's source code is [Sour
77
Compiling SourceMod plugins is quite easy and will be explained below.
88

99
## Table Of Contents
10+
* [Downloading SourceMod](#downloading-sourcemod)
11+
* [Compiling SourceMod Plugins](#compiling-sourcemod-plugins)
12+
* [Windows](#windows)
13+
* [Windows File Explorer](#windows-file-explorer)
14+
* [Command Line](#command-line)
15+
* [Linux](#linux)
16+
* [Additional Command Line Options](#additional-command-line-options)
17+
* [Include Files](#include-files)
18+
* [Conclusion](#conclusion)
1019

1120
## Downloading SourceMod
1221
Refer to the following guide on how to download and extract SourceMod. You do **not** need to install SourceMod onto your server to build plugins.
@@ -15,8 +24,9 @@ https://forum.moddingcommunity.com/t/how-to-install-update-metamod-sourcemod/60
1524

1625
After extracting the SourceMod files, go to the `addons/sourcemod/scripting` directory on Linux (or `addons\sourcemod\scripting` folder on Windows).
1726

18-
## Building SourceMod Plugins
19-
Building SourceMod plugins is usually quite easy, especially on Windows.
27+
## Compiling SourceMod Plugins
28+
Compiling SourceMod plugins is usually quite easy, especially on Windows.
29+
2030
### Windows
2131
#### Windows File Explorer
2232
If you want to quickly compile plugins, you can drag and drop the plugin's source code file into the `compile.exe` executable located in the `scripting` folder. A Command Prompt window will open and you'll see the output of the build. If the build was successful, you'll see the built plugins inside of the `compiled` folder. Built SourceMod plugins typically have the `smx` file extension.
@@ -59,7 +69,7 @@ For example, if we want to compile the included `basechat` plugin, we'd use the
5969

6070
If the build was successful, you'll see the new built plugin file in the same directory as the source code (`scripting/`).
6171

62-
## Additional CLI Options
72+
## Additional Command Line Options
6373
As stated above, compiling plugins through the command line allows you to set additional options. Here is the help menu output which provides a list of flags and arguments you may set.
6474

6575
```
@@ -105,7 +115,7 @@ For example, on Linux, if want the successfully built `basechat` plugin to go in
105115
mkdir -p compiled
106116

107117
# Output: compiled/basechat.smx
108-
./spcomp -o compiled/basechat
118+
./spcomp -o compiled/basechat basechat.sp
109119
```
110120

111121
## Include Files

0 commit comments

Comments
 (0)