Een handleiding over het compileren van SourceMod-plugins.
SourceMod-plugins zijn custom scripts of addons die zijn gemaakt om de functionaliteit van gameservers die op de Source engine draaien uit te breiden en aan te passen.
De programmeertaal die hoort bij de broncode van SourceMod-plugins is SourcePawn. De bestandsextensie van SourcePawn is sp.
Het compileren van SourceMod-plugins is vrij eenvoudig en wordt hieronder uitgelegd.
SourceMod downloaden
Raadpleeg de volgende handleiding over het downloaden en uitpakken van SourceMod. Je hoeft SourceMod niet op je server te installeren om plugins te bouwen.
https://moddingcommunity.com/blog/how-to-install-update-sourcemod-metamod/
Ga na het uitpakken van de SourceMod-bestanden naar de map addons/sourcemod/scripting op Linux (of de map addons\sourcemod\scripting op Windows).
SourceMod-plugins compileren
Het compileren van SourceMod-plugins is doorgaans vrij eenvoudig, zeker op Windows.
Windows
Windows Verkenner
Als je snel plugins wilt compileren, kun je het broncodebestand van de plugin met drag and drop op het uitvoerbare bestand compile.exe in de map scripting slepen. Er opent een Command Prompt-venster waarin je de output van de build ziet. Als de build is geslaagd, vind je de gebouwde plugins in de map compiled. Gebouwde SourceMod-plugins hebben doorgaans de bestandsextensie smx.
Hoewel deze methode snel en eenvoudig is, biedt de hieronder uitgelegde methode via de command line meer opties die je kunt instellen.
Command line
Als je plugins wilt compileren via de command line met Command Prompt of PowerShell, moet je eerst een terminal openen en naar de scripting-map navigeren.
Vervolgens gebruik je de uitvoerbare bestanden spcomp.exe of spcomp64.exe (voor 64-bit-ondersteuning) om de plugins te compileren.
Hier is een basiscommando dat een plugin compileert.
.\spcomp.exe <Plugin File Name With Extension>
Als we bijvoorbeeld de meegeleverde basechat-plugin willen compileren, gebruiken we het volgende commando.
.\spcomp.exe basechat.sp
Linux
Om SourceMod-plugins via een Linux-terminal te compileren, kun je een vergelijkbaar proces volgen als de hierboven uitgelegde command line-methode op Windows. Je moet daarvoor de uitvoerbare bestanden spcomp of spcomp64 (voor 64-bit-ondersteuning) gebruiken om de plugins te compileren.
Hier is een basiscommando dat een plugin compileert.
./spcomp <Plugin File Name With Extension>
Als we bijvoorbeeld de meegeleverde basechat-plugin willen compileren, gebruiken we het volgende commando.
./spcomp basechat.sp
Als de build is geslaagd, zie je het nieuwe gebouwde pluginbestand in dezelfde map als de broncode (scripting/).
Extra command line-opties
Zoals hierboven vermeld kun je bij het compileren via de command line extra opties instellen. Hieronder staat de output van het helpmenu met een lijst van flags en argumenten die je kunt instellen.
SourcePawn Compiler 1.11.0.6969
Copyright (c) 1997-2006 ITB CompuPhase
Copyright (c) 2004-2021 AlliedModders LLC
Usage: ./spcomp [options] <filename> [filename...]
optional arguments:
--show-stats Show compiler statistics on exit.
-D Active directory path
--active-dir=ACTIVE_DIR
-e Error file path
--error-file=ERROR_FILE
-E, --warnings-as-errors Treat warnings as errors
-h, --show-includes Show included file paths
-z
--compress-level=COMPRESS_LEVEL
Compression level, default 9 (0=none, 1=worst,
9=best)
-t, --tabsize=TABSIZE TAB indent size (in character positions,
default=8)
-v, --verbose=VERBOSE Verbosity level; 0=quiet, 1=normal, 2=verbose
-p, --prefix=PREFIX Set name of "prefix" file
-o, --output=OUTPUT Set base name of (P-code) output file
-O, --opt-level=OPT_LEVEL
Deprecated; has no effect
-i, --include=INCLUDE Path for include files
-w, --warning=WARNING Disable a specific warning by its number.
-;, --require-semicolons Require a semicolon to end each statement.
--syntax-only Perform a dry-run (No file output) on the input
--use-stderr Use stderr instead of stdout for error messages.
--no-verify Disable opcode verification (for debugging).
sym=val Define constant "sym" with value "val".
sym= Define constant "sym" with value 0.
Als we bijvoorbeeld op Linux willen dat de succesvol gebouwde basechat-plugin in de map compiled/ terechtkomt, gebruiken we het volgende commando (of de volgende commando's).
# Make sure compiled directory is made.
mkdir -p compiled
# Output: compiled/basechat.smx
./spcomp -o compiled/basechat basechat.sp
Include-bestanden
Er zijn veel gepubliceerde SourceMod-plugins die include-bestanden met de bestandsextensie inc bevatten. Deze bestanden moeten in de map include/ worden geplaatst. Anders zullen de plugins waarschijnlijk niet compileren.
Daarnaast kun je bij het compileren via de command line de flag -i gebruiken om mappen buiten de standaard include-map mee te nemen.
Conclusie
Dat was het! Je zou nu alle methoden moeten kennen om SourceMod-plugins te compileren.
Heb je vragen of feedback over deze handleiding? Reageer dan hier op het bijbehorende forumtopic! Deze handleiding wordt na verloop van tijd verder uitgewerkt en verbeterd.
Word lid van onze Discord-server!