AlliedModders Wiki - User contributions [en]

Public Commands (SourceMod)

2009-03-19T22:38:11Z

BarkerJr: wikilink

The following commands are available to players on SourceMod servers using the provided [[Base Plugins (SourceMod)|base plugin]] set.

Note that <tt>rockthevote.smx</tt> is not enabled by default.

:{| cellpadding="6"
|- class="t2th"
| Command
| Plugin
| Format
| Description
|- class="t2td"
| currentmap
| basetriggers.smx
|
| Displays the name of the current map.
|- class="t2td"
| ff
| basetriggers.smx
|
| Displays whether friendly fire is on or off.
|- class="t2td"
| nextmap
| nextmap.smx
|
| Shows the next map in the mapcycle to the user.
|- class="t2td"
| nominate
| rockthevote.smx
| <map>
| Nominates a map for rtv.
|- class="t2td"
| rtv OR rockthevote
| rockthevote.smx
|
| Starts a rockthevote vote.
|- class="t2td"
| thetime
| basetriggers.smx
|
| Displays the current time of the server.
|- class="t2td"
| timeleft
| basetriggers.smx
|
| Displays the time left in the map cycle.
|- class="t2td"
| sm_settings
| clientprefs.smx
|
| Displays the client settings menu.
|- class="t2td"
| sm_cookies
| clientprefs.smx
| <name> [value]
| With no arguments displays the list of available cookies, specify a name to show or change it's value.
|}

[[Category:SourceMod Documentation]]

Base Plugins (SourceMod)

2009-03-07T02:29:53Z

BarkerJr: /* Default Plugins */ add playercommands and sounds

__FORCETOC__
The following is a full list of [[SourceMod]]'s base plugins and the purpose of each one.

Plugins with a bold name are safe to be used in [[War_Mode_(SourceMod)|War Mode]], as they do not contain anything that could be considered abusive or unfair.

=Default Plugins=
{| style="width:600px;" cellpadding="5"
|- class="t2th"
|Plugin
|Purpose
|- class="t2td"
| '''admin-flatfile'''
| Loads admins from the admin configuration files.
|- class="t2td"
| '''adminhelp'''
| Provides the sm_help command (lists other commands and their syntax).
|- class="t2td"
| '''adminmenu'''
| Provides the admin menu API and core features.
|- class="t2td"
| antiflood
| Prevents clients from spamming messagemode/chat.
|- class="t2td"
| '''basebans'''
| Provides basic banning commands and menu options.
|- class="t2td"
| basechat
| Provides commands and menu options for managing player's abilities to use voice chat or say chat.
|- class="t2td"
| basecomm
| Provides functionality for tweaking how players can communicate (in comparison to sv_alltalk).
|- class="t2td"
| '''basecommands'''
| Provides basic administrative commands unrelated to player abuse (for example, map changing, kicking, and cvar changing).
|- class="t2td"
| basetriggers
| Provides automated responses to phrases such as "nextmap", "thetime", and "timeleft".
|- class="t2td"
| basevotes
| Provides basic voting commands, such as map voting.
|- class="t2td"
| '''clientprefs'''
| Adds a console based (sm_cookies) and menu based (sm_settings) inteface for clients to access their settings.
|- class="t2td"
| funcommands
| Provides "fun" commands, like slapping.
|- class="t2td"
| funvotes
| Provides votes based on basefuncommands.
|- class="t2td"
| '''nextmap'''
| Allows admins or other plugins to dynamically alter or retrieve the effective mapcycle.
|- class="t2td"
| playercommands
| Adds commands sm_slap, sm_slay, and sm_rename
|- class="t2td"
| reservedslots
| Allows the server to have slots that are reserved for administrators (or privileged people), to ensure prioritized entry.
|- class="t2td"
| sounds
| Adds command sm_play
|}

=Extra Plugins=
The following plugins are in the <tt>addons/sourcemod/plugins/disabled</tt> folder by default, and must be moved out of that folder to be enabled.

If a plugin has cvars, you can load it once to generate its config file in <tt>cfg/sourcemod</tt>.

{| style="width:600px;" cellpadding="5"
|- class="t2th"
|Plugin File
|Purpose
|- class="t2td"
| '''admin-sql-prefetch'''
| Loads admins from an SQL database as a big lump every mapchange. If enabled, <tt>admin-sql-threaded</tt> must be disabled; see [[SQL_Admins_(SourceMod)|SQL Admins]].
|- class="t2td"
| '''admin-sql-threaded'''
| Loads admins from an SQL database dynamically as each admin connects. If enabled, <tt>admin-sql-prefetch</tt> must be disabled; see [[SQL_Admins_(SourceMod)|SQL Admins]].
|- class="t2td"
| mapchooser
| Provides an automated system for players to vote for map changes. If enabled, <tt>randomcycle</tt> should be disabled. Cvars are generated in <tt>mapchooser.cfg</tt>.
|- class="t2td"
| randomcycle
| Randomizes the map cycle. If enabled, <tt>mapchooser</tt> should be disabled. Cvars are generated in <tt>randomcycle.cfg</tt>.
|- class="t2td"
| rockthevote
| Provides a player-initiated system for players to vote for map changes. Cvars are generated in <tt>rtv.cfg</tt>.
|}

[[Category:SourceMod Documentation]]

Base Plugins (SourceMod)

2008-04-06T12:22:21Z

BarkerJr: /* Default Plugins */ renamed plugins

__FORCETOC__
The following is a full list of [[SourceMod]]'s base plugins and the purpose of each one.

Plugins with a bold name are safe to be used in [[War_Mode_(SourceMod)|War Mode]], as they do not contain anything that could be considered abusive or unfair.

=Default Plugins=
{| style="width:600px;" cellpadding="5"
|- class="t2th"
|Plugin
|Purpose
|- class="t2td"
| '''admin-flatfile'''
| Loads admins from the admin configuration files.
|- class="t2td"
| '''adminhelp'''
| Provides the sm_help command (lists other commands and their syntax).
|- class="t2td"
| '''adminmenu'''
| Provides the admin menu API and core features.
|- class="t2td"
| antiflood
| Prevents clients from spamming messagemode/chat.
|- class="t2td"
| '''basebans'''
| Provides basic banning commands and menu options.
|- class="t2td"
| basechat
| Provides commands and menu options for managing player's abilities to use voice chat or say chat.
|- class="t2td"
| basecomm
| Provides functionality for tweaking how players can communicate (in comparison to sv_alltalk).
|- class="t2td"
| '''basecommands'''
| Provides basic administrative commands unrelated to player abuse (for example, map changing, kicking, and cvar changing).
|- class="t2td"
| basetriggers
| Provides automated responses to phrases such as "nextmap", "thetime", and "timeleft".
|- class="t2td"
| basevotes
| Provides basic voting commands, such as map voting.
|- class="t2td"
| funcommands
| Provides "fun" commands, like slapping.
|- class="t2td"
| funvotes
| Provides votes based on basefuncommands.
|- class="t2td"
| '''nextmap'''
| Allows admins or other plugins to dynamically alter or retrieve the effective mapcycle.
|- class="t2td"
| reservedslots
| Allows the server to have slots that are reserved for administrators (or privileged people), to ensure prioritized entry.
|}

=Extra Plugins=
The following plugins are in the <tt>addons/sourcemod/plugins/disabled</tt> folder by default, and must be moved out of that folder to be enabled.

If a plugin has cvars, you can load it once to generate its config file in <tt>cfg/sourcemod</tt>.

{| style="width:600px;" cellpadding="5"
|- class="t2th"
|Plugin File
|Purpose
|- class="t2td"
| '''admin-sql-prefetch'''
| Loads admins from an SQL database as a big lump every mapchange. If enabled, <tt>admin-sql-threaded</tt> must be disabled; see [[SQL_Admin_(SourceMod)|SQL Admins]].
|- class="t2td"
| '''admin-sql-threaded'''
| Loads admins from an SQL database dynamically as each admin connects. If enabled, <tt>admin-sql-prefetch</tt> must be disabled; see [[SQL_Admin_(SourceMod)|SQL Admins]].
|- class="t2td"
| mapchooser
| Provides an automated system for players to vote for map changes. If enabled, <tt>rockthevote</tt> and <tt>randomcycle</tt> should be disabled. Cvars are generated in <tt>plugin.mapchooser.cfg</tt>.
|- class="t2td"
| randomcycle
| Randomizes the map cycle. If enabled, <tt>mapchooser</tt> and <tt>rockthevote</tt> should be disabled. Cvars are generated in <tt>plugin.randomcycle.cfg</tt>.
|- class="t2td"
| rockthevote
| Provides a player-initiated system for players to vote for map changes. If enabled, <tt>mapchooser</tt> and <tt>randomcycle</tt> should be disabled. Cvars are generated in <tt>plugin.rtv.cfg</tt>.
|}

[[Category:SourceMod Documentation]]

Installing SourceMod

2008-04-05T23:12:03Z

BarkerJr: /* Prerequisites */ up to 1.4.3; unredirect

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

=Prerequisites=
SourceMod requires [[Metamod:Source]] 1.4.3 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_Metamod:Source 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]]