Managing your Sourcemod installation
In the hopes of reducing some noise in most plugins threads, i've started writing this little guide. It is directed at sourcemod beginners and explains the basic about managing your sourcemod installation.
1. Getting Familiar 1.1 Server console 1.2 Directory Layout 1.3 Adding yourself as an admin 1.4 Try to disable/enable a plugin 2. Installing Plugins 2.1 The basics 2.2 Dependencies 2.3 How to test if your plugin is installed correctly? 2.4 Helping the developer 3. Extensions 3.1 The basics 3.2 Installing an extension 3.3 Troubleshooting extension issues |
Getting Familiar
1.1 Server Console
You've just installed sourcemod and made sure that it's working. For that you did the instructions in the Checking the Install chapter and issued some first commands in the server console. Get more familiar with the console, either directly or preferably via rcon (e.g. by using HLSW). Try at least these commands:
|
Getting Familiar
1.2 Directory Layout
Also get to know the directory layout sourcemod is using, this means:
|
Getting Familiar
1.3 Adding yourself as an admin
To make things easier from now on, you should add yourself as an root-admin. There are several ways to manage access rights on your server. In this step we do it quick and dirty, but you might want to read the chapter about Adding Admins and Adding Groups, then create a group for system administrators and add yourself to it. We are using the simple approach and just add one line to the admins_simple.cfg file in your sourcemod/configs/ directory: Code:
"yoursteamid" "99:z" |
Getting Familiar
1.4 Try to disable and enable a plugin
If you've read the subsection about the directory layout you should already know how to do this. And if you read the subsection about the server console you also know how to test if it worked. But lets explain this again. We want to enable the mapchooser plugin:
|
Installing Plugins
2.1 The basics
For simple plugins that come only with the source and a binary like Basic AFK Manager installation is pretty straight forward and is basically the same as enabling one of the official plugins (see section 1.4). You copy the .smx to the plugins folder and the .sp to the scripting folder. For more complex plugins like SM Bot Tools it might also be required to copy translations or gamedata to the corresponding folders, but the smart developer gives you a zip with the correct folder layout anyway, so you just need to copy everything to the sourcemod folder. Always follow instructions on the plugins page. |
Installing Plugins
2.2 Dependencies
Rarely plugins have dependencies on other plugins, but it's quite common for a plugin to require one or more extensions. Extensions usually provide features that enable plugins to do stuff they couldnt otherwise. If a plugin has any dependencies it has to be noted somewhere in the plugin description. Look for it. Learn in chapter 3 how to install an extension. |
Installing Plugins
2.3 How to test if your plugin is installed correctly?
When you are troubleshooting plugin and/or extension issues always use the server console. Forget the client console. SourceMod is a server-side addon after all. Just change the map after the installation and type sm plugins list in the server console. You should see the changes you've made. If the plugin you've installed is not listed, then it is not installed correctly (aka its not the plugins fault, but yours) and you need to figure out what you did wrong. Basically it has to be this: you didn't put the compiled plugin (the .smx file) in the /plugins directory of your sourcemod installation. If it is listed but prefixed with a <Failed>, something else went wrong. To get details what exactly was the problem type sm plugins info <plugin id>, replace <plugin id> with the number of the plugin you've got in the list. It will probably say something like this:
|
Installing Plugins
2.4 Helping the developer
Ok, so you've tried everything to get a plugin to work, but it still won't load. This is pretty unusual. The plugin developer will think you did something wrong installing it and link you to this thread. Prevent this from happening. Give them proof that you've reached a point where it is out of your hand to fix the problem. Tell them what you've tried, give them the console log (via screenshot if you can't copy+paste) and give them as much information as you can. |
Extensions
3.1 The basics
Extensions are like plugins, just more powerful. They load if required by a plugin and stay dormant if not. This means extensions that are not required by any of your plugins won't even load - you won't see them when typing sm exts list. Some extensions provide features for other plugins to use (like SDK Hooks), some extensions influence the game directly (like UnlockBlock). |
| All times are GMT -4. The time now is 21:53. |
Powered by vBulletin®
Copyright ©2000 - 2024, vBulletin Solutions, Inc.