Difference between revisions of "Installing SourceMod"

From AlliedModders Wiki
Jump to: navigation, search
(Prerequisites)
Line 1: Line 1:
 
Installing SourceMod is very simple, and it can be added with almost no configuration changes.
 
Installing SourceMod is very simple, and it can be added with almost no configuration changes.
  
=Prerequisites=
+
=Quick Install=
 +
==Installing Metamod:Source==
 +
SourceMod runs using Metamod:Source. You will need to install Metamod in order for SourceMod to work.
 +
Install instructions on Metamod can be [http://wiki.alliedmods.net/index.php/Installing_Metamod:Source found here].
 +
 
 +
==Installing SourceMod==
 +
Once you have installed Metamod:Source, there will be an "addons" folder in your server's game root.<br>
 +
[http://www.sourcemod.net/downloads.php Download SourceMod] (make sure to pick the proper operation system). Place the content of the zip into your server's game root.
 +
You have now successfully installed SourceMod!
 +
=Detailed Install=
 +
==Prerequisites==
 
A GUI Web Browser to retrieve Metamod and SourceMod compressed archives.
 
A GUI Web Browser to retrieve Metamod and SourceMod compressed archives.
 
A tool to copy archive to your dedicated server host.
 
A tool to copy archive to your dedicated server host.
Line 9: Line 19:
 
SourceMod will run on any mod built using the Source SDK.  It also supports "The Ship," which uses the Source engine.
 
SourceMod will run on any mod built using the Source SDK.  It also supports "The Ship," which uses the Source engine.
  
=Uploading/Installing=
+
==Uploading/Installing==
==Local Server==
+
====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).
 
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]
 
[http://www.sourcemod.net/downloads.php Download Here]
  
==Remote Server==
+
====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.   
 
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:Source, <tt>dod</tt> for Day of Defeat:Source, 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.
+
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:Source, <tt>dod</tt> for Day of Defeat:Source, 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.
 
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.
Line 24: Line 34:
 
tar -xzf ../sourcemod-1.1.0.tar.gz
 
tar -xzf ../sourcemod-1.1.0.tar.gz
  
=Checking the Install=
+
==Checking the Install==
 
Your folder layout should look like:
 
Your folder layout should look like:
 
*<tt>[mod]</tt> - Your mod's folder
 
*<tt>[mod]</tt> - Your mod's folder
Line 49: Line 59:
 
     SourceMod Version: 1.1.0.2489
 
     SourceMod Version: 1.1.0.2489
 
     SourcePawn Engine: SourcePawn 1.1, jit-x86 (build 1.1.0-svn)
 
     SourcePawn Engine: SourcePawn 1.1, jit-x86 (build 1.1.0-svn)
     SourcePawn API: v1 = 4, v2 = 2
+
     SourcePawn API: v1 == 4, v2 == 2
 
     Compiled on: Sep  5 2008 02:02:12
 
     Compiled on: Sep  5 2008 02:02:12
 
     http://www.sourcemod.net/
 
     http://www.sourcemod.net/
Line 59: Line 69:
 
You should see a menu popup with all you options.
 
You should see a menu popup with all you options.
  
=Troubleshooting=
+
==Troubleshooting==
 
If the install failed, you will generally see one of four symptoms.   
 
If the install failed, you will generally see one of four symptoms.   
  
==Metamod reports NOFILE or FAILED==
+
====Metamod reports NOFILE or FAILED====
 
If "meta list" replies with something like this:
 
If "meta list" replies with something like this:
 
<pre>] meta list
 
<pre>] meta list
Line 71: Line 81:
 
<pre>meta list 1</pre>
 
<pre>meta list 1</pre>
  
==Metamod lists no plugins==
+
====Metamod lists no plugins====
 
If "meta list" replies with something like this:
 
If "meta list" replies with something like this:
 
<pre>] meta list
 
<pre>] meta list
Line 77: Line 87:
  
 
You forgot to add SourceMod to the <tt>addons/metamod/metaplugins.ini</tt> file.
 
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).
+
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==
+
====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.
 
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]]
 
[[Category:SourceMod Documentation]]

Revision as of 07:18, 27 February 2011

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

Quick Install

Installing Metamod:Source

SourceMod runs using Metamod:Source. You will need to install Metamod in order for SourceMod to work. Install instructions on Metamod can be found here.

Installing SourceMod

Once you have installed Metamod:Source, there will be an "addons" folder in your server's game root.
Download SourceMod (make sure to pick the proper operation system). Place the content of the zip into your server's game root. You have now successfully installed SourceMod!

Detailed Install

Prerequisites

A GUI Web Browser to retrieve Metamod and SourceMod compressed archives. A tool to copy archive to your dedicated server host.

SourceMod requires Metamod:Source 1.8.0 or higher. Click here to visit the Metamod:Source homepage. Instructions to install SourceMM manually can be found 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 .zip (Windows) or .tar.gz (Linux) package to your mod folder (i.e. cstrike for Counter-Strike, dod for Day of Defeat, et cetera). Download Here

Remote Server

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

Using a tool such as FTP, locate your mod folder (i.e. cstrike for Counter-Strike:Source, dod for Day of Defeat:Source, et cetera). Underneath this folder, you should have an addons folder (if not, Metamod:Source is probably not installed). From your local addons folder, upload the entire contents to your remote addons folder. When done, your remote addons folder should have a sourcemod 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:

  • [mod] - Your mod's folder
    • addons
      • metamod - Metamod:Source
      • sourcemod - 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, since most providers will automatically restart your server.

First, in your server console (not client console), type:

meta list

If the install worked, you will see something like:

] meta list
Listing 1 plugin:
    [01] SourceMod (1.1.0.2489) by AlliedModders LLC

You should then be able to use the SourceMod root console command, which can be invoked with simply:

sm

For example:

] 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/


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:

sm_admin

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:

] meta list
-Id- Name                  Version     Author           Status  
[01] -                     -           -                NOFILE  

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):

meta list 1

Metamod lists no plugins

If "meta list" replies with something like this:

] meta list
-Id- Name                  Version     Author           Status  

You forgot to add SourceMod to the addons/metamod/metaplugins.ini 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. This wiki page may provide you with clues on how to solve this problem.