Difference between revisions of "Installing SourceMod"

From AlliedModders Wiki
Jump to: navigation, search
(Remote Server: spelling)
(Removing all content from page)
Line 1: Line 1:
Installing SourceMod is very simple, and it can be added with almost no configuration changes.
 
  
=Prerequisites=
 
A GUI Web Browser to retrive Metamod and SourceMod compressed archives.
 
A tool to copy archive to your dedicated server host.
 
 
SourceMod requires [[Metamod:Source]] 1.4.3 or higher. [http://www.metamodsource.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).
 
[http://www.sourcemod.net/downloads.php Download Here]
 
 
==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.
 
 
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.
 
 
Alternatively, if you copied the tar.gz to your srcds directory, execute the following from the cstrike sub directory:
 
tar -xzf ../sourcemod-1.1.0.tar.gz
 
 
=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
 
Listing 1 plugin:
 
    [01] SourceMod (1.1.0.2489) by AlliedModders LLC</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.1.0.2489
 
    SourcePawn Engine: SourcePawn 1.1, jit-x86 (build 1.1.0-svn)
 
    SourcePawn API: v1 = 4, v2 = 2
 
    Compiled on: Sep  5 2008 02:02:12
 
    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.
 
 
 
[[Category:SourceMod Documentation]]
 

Revision as of 04:15, 15 February 2009