Admin Commands (SourceMod)

2007-10-21T18:01:34Z

Gh0stalker: /* Basic Commands */

This page lists all of the major admin commands in SourceMod.

'''Chat Triggers''': Remember that commands do not have to be entered through the console; they can be entered via chat triggers. For example, saying "!ban bail" in chat will execute the same command as "sm_ban" and forward the output to chat. You can also use "/" instead of "!" to suppress your command from being shown to users.

'''Targetting Players''': There are a number of ways to target players:
<ul>
<li>name - The player will be targeted by a partial name match (multiple matches will report back an error).</li>
<li>#userid - If userid is numeric, the player will be targeted by their userid (found via the "users" command).</li>
<li>#name - If name is non-numeric, the player will be targeted by an exact name match.</li>
</ul>

=Basic Commands=
These commands are found in the "basecommands" plugin.

:{|
|- class="t2th"
| Command
| Format
| Access
| Description
|- class="t2td"
| sm_admin
|
| admin
| Displays the [[Admin Menu (SourceMod)|admin menu]].
|- class="t2td"
| sm_kick
| <nowiki><#userid|name></nowiki> [reason]
| kick
| Kicks a player.
|- class="t2td"
| sm_map
| <map>
| map
| Changes the current map.
|- class="t2td"
| sm_rcon
| <argstring>
| rcon
| Executes the argument string via rcon.
|- class="t2td"
| sm_cvar
| <cvar> [value]
| cvar
| Retrieves or changes a cvar value. Protected cvars can only be accessed with rcon access, and sv_cheats can only be accessed with cheat access.
|- class="t2td"
| sm_execcfg
| <filename>
| config
| Executes a config file (path not needed, but extension is).
|- class="t2td"
| sm_reloadadmins
|
| config
| Refreshes the Admin cache from admin.cfg (Unknown if admin_simple.ini is refreshed, anyone confirm?)
|- class="t2td"
| sm_who
| <nowiki>[#userid|name]</nowiki>
| admin
| Lists all users and their access rights, or a specific user's access rights.
|- class="t2td"
| sm_ban
| <nowiki><#userid|name> <minutes|0> </nowiki>[reason]
| ban
| Bans a client.
|- class="t2td"
| sm_unban
| <steamid>
| unban
| Unbans a Steam ID.
|- class="t2td"
| sm_addban
| <time> <steamid> [reason]
| rcon
| Adds a Steam ID to Source's ban list.
|- class="t2td"
| sm_banip
| <time> <ip|#userid|name> [reason]
| rcon for ip, ban for player
| Adds an IP address to Source's ban list.
|}

[[Category:SourceMod Documentation]]

Installing SourceMod

2007-10-21T17:47:40Z

Gh0stalker: /* Checking the Install */

Installing SourceMod is very simple, and it can be added with almost no configuration changes.

=Prerequisites=
SourceMod requires [[SourceMM|Metamod:Source]] 1.4.2 or higher. [http://www.sourcemm.net/ Click here] to visit the Metamod:Source homepage. Instructions to install SourceMM muanually can be found [http://wiki.alliedmods.net/index.php/Installing_SourceMM here].

SourceMod will run on any mod built using the Source SDK. It also supports "The Ship," which uses the Source engine.

=Uploading/Installing=
==Local Server==
To install SourceMod locally, simply extract the <tt>.zip</tt> (Windows) or <tt>.tar.gz</tt> (Linux) package to your mod folder (i.e. <tt>cstrike</tt> for Counter-Strike, <tt>dod</tt> for Day of Defeat, et cetera).

Next, open the <tt>addons/metamod/metaplugins.ini</tt> file with your favorite text editor (for example, notepad). Add this line:
<pre>addons/sourcemod/bin/sourcemod_mm</pre>

Save and exit.

==Remote Server==
To install SourceMod remotely, first extract the <tt>.zip</tt> (Windows) or <tt>.tar.gz</tt> (Linux) package to your local computer (for example, your Desktop). You will see an <tt>addons</tt> folder.

Using a tool such as [http://www.google.com/search?q=FTP FTP], locate your mod folder (i.e. <tt>cstrike</tt> for Counter-Strike, <tt>dod</tt> for Day of Defeat, et cetera). Underneath this folder, you should have an <tt>addons</tt> folder (if not, Metamod:Source is probably not installed). From your local <tt>addons</tt> folder, upload the entire contents to your remote <tt>addons</tt> folder. When done, your remote <tt>addons</tt> folder should have a <tt>sourcemod</tt> folder.

Next, copy the <tt>addons/metamod/metaplugins.ini</tt> file from FTP onto your computer. Open it up with your favorite text editor (for example, notepad, or wordpad if you run into problems), and add the following line:
<pre>addons/sourcemod/bin/sourcemod_mm</pre>

When done, save and exit. Then, copy the file back to your server, overwriting the original <tt>addons/metamod/metaplugins.ini</tt> file.

If you have trouble with these steps, you need to get acquainted with FTP and server management. However, you can also ask your server provider for help. Some providers also have web interfaces for managing your server.

=Checking the Install=
Your folder layout should look like:
*<tt>[mod]</tt> - Your mod's folder
**<tt>addons</tt>
***<tt>metamod</tt> - Metamod:Source
***<tt>sourcemod</tt> - SourceMod

Once SourceMod is uploaded/copied and configured with Metamod:Source, restart your server completely. If it is local, shut it down and restart it. If it is remote, you may need to ask your server provider for help. However, it is often safe to issue a "quit" command via [[rcon]], and most providers will automatically restart your server.

First, in your [[server console]] (not client console), type:
<pre>meta list</pre>

If the install worked, you will see something like:
<pre>] meta list
-Id- Name Version Author Status
[01] SourceMod 1.0.0.571 AlliedModders, RUN </pre>

You should then be able to use the SourceMod root console command, which can be invoked with simply:
<pre>sm</pre>

For example:
<pre>] sm version
SourceMod Version Information:
SourceMod Version: 1.0.0.571
JIT Version: JIT (x86), 1.0.0.431
JIT Settings: Generic 80486
http://www.sourcemod.net/
</pre>

Lastly, assuming you have already setup your administration user, you can test the in game menu by joining the server, and in the client console type the following:
<pre>sm_admin</pre>
You should see a menu popup with all you options.

=Troubleshooting=
If the install failed, you will generally see one of four symptoms.

==Metamod reports NOFILE or FAILED==
If "meta list" replies with something like this:
<pre>] meta list
-Id- Name Version Author Status
[01] - - - NOFILE </pre>

Most likely, either the files are not located in the correct place, or the file could not be loaded. For more information, use the following command (except use the correct list number):
<pre>meta list 1</pre>

==Metamod lists no plugins==
If "meta list" replies with something like this:
<pre>] meta list
-Id- Name Version Author Status </pre>

You forgot to add SourceMod to the <tt>addons/metamod/metaplugins.ini</tt> file.
Or if that doesn't fix your problem, make sure you are using the correct build of Sourcemod (zip = windows, tar = linux).

==Metamod says nothing==
If "meta list" has no reply at all, Metamod:Source is not properly installed. [http://wiki.alliedmods.net/index.php/Installing_SourceMM This wiki page] may provide you with clues on how to solve this problem.

=Support=
See [[SourceMod Support]].

[[Category:SourceMod Documentation]]

AlliedModders Wiki - User contributions [en]

Admin Commands (SourceMod)

Installing SourceMod