AlliedModders Wiki - User contributions [en]

SQL (SourceMod Scripting)

2022-09-25T18:16:40Z

Bacardi: /* External Links */ update link

{{Languages|SQL (SourceMod_Scripting)}}
This article is an introduction to using SourceMod's SQL features. It is not an introduction or tutorial about SQL or any specific SQL implementation.

SourceMod's SQL layer is formally called ''DBI'', or the '''D'''ata'''b'''ase '''I'''nterface. The interface is a generic abstraction of common SQL functions. To connect to a specific database implementation (such as MySQL, or sqLite), a SourceMod DBI "driver" must be loaded. Currently, there are drivers for MySQL, PostgreSQL (pgsql), and SQLite.

SourceMod automatically detects and loads drivers on demand (if they exist, of course). All database natives are in <tt>scripting/include/dbi.inc</tt>. The C++ API is in <tt>public/IDBDriver.h</tt>.

=Connecting=
There are two ways to connect to a database. The first is through named configurations. Named configurations are preset configurations listed in <tt>configs/databases.cfg</tt>. SourceMod specifies that if SQL is being used, there should always be one configuration named "default."

An example of such a configuration looks like:
<pre> "default"
{
"host" "localhost"
"database" "sourcemod"
"user" "root"
"pass" ""
//"timeout" "0"
//"port" "0"
}</pre>

Connections based on named configurations can be instantiated with either <tt>SQL_Connect</tt> or <tt>SQL_DefConnect</tt>.

The other option is to use <tt>SQL_ConnectCustom</tt> and manually specify all connection parameters by passing a keyvalue handle containing them.

Example of a typical connection:
<sourcepawn>char error[255];
Database db = SQL_DefConnect(error, sizeof(error));

if (db == null)
{
PrintToServer("Could not connect: %s", error);
}
else
{
delete db;
}</sourcepawn>

=Queries=

==No Results==
The simplest queries are ones which do not return results -- for example, CREATE, DROP, UPDATE, INSERT, and DELETE. For such queries it is recommended to use <tt>SQL_FastQuery()</tt>. The name does not imply that the query will be faster, but rather, it is faster to write code using this function. For example, given that <tt>db</tt> is a valid database Handle:

<sourcepawn>if (!SQL_FastQuery(db, "UPDATE stats SET players = players + 1"))
{
char error[255];
SQL_GetError(db, error, sizeof(error));
PrintToServer("Failed to query (error: %s)", error);
}</sourcepawn>

==Results==
If a query returns a result set and the results must be processed, you must use <tt>SQL_Query()</tt>. Unlike <tt>SQL_FastQuery()</tt>, this function returns a Handle which must be closed.

An example of a query which will produce results is:
<sourcepawn>DBResultSet query = SQL_Query(db, "SELECT userid FROM vb_user WHERE username = 'BAILOPAN'");
if (query == null)
{
char error[255];
SQL_GetError(db, error, sizeof(error));
PrintToServer("Failed to query (error: %s)", error);
}
else
{
/* Process results here! */

/* Free the Handle */
delete query;
}</sourcepawn>

=Prepared Statements=
Prepared statements are another method of querying. The idea behind a prepared statement is that you construct a query "template" once, and re-use it as many times as needed. Prepared statements have the following benefits:
*A good SQL implementation will be able to cache the query better if it is a prepared statement.
*You don't have to rebuild the entire query string every execution.
*You don't have to allocate a new query structure on every execution.
*Input is "always" secure (more on this later).

A prepared statement has "markers" for inputs. For example, let's consider a function that takes in a database Handle and a name, and retrieves some info from a table:
<sourcepawn>int GetSomeInfo(Database db, const char[] name)
{
DBResultSet hQuery;
char query[100];

/* Create enough space to make sure our string is quoted properly */
int buffer_len = strlen(name) * 2 + 1;
char[] new_name = new char[buffer_len];

/* Ask the SQL driver to make sure our string is safely quoted */
db.Escape(name, new_name, buffer_len);

/* Build the query */
Format(query, sizeof(query), "SELECT userid FROM vb_user WHERE username = '%s'", new_name);

/* Execute the query */
if ((hQuery = SQL_Query(query)) == null)
{
return 0;
}

/* Get some info here */

delete hQuery;

/* return info; */
}</sourcepawn>

Observe a version with prepared statements:
<sourcepawn>DBStatement hUserStmt = null;
int GetSomeInfo(Database db, const char[] name)
{
/* Check if we haven't already created the statement */
if (hUserStmt == null)
{
char error[255];
hUserStmt = SQL_PrepareQuery(db, "SELECT userid FROM vb_user WHERE username = ?", error, sizeof(error));
if (hUserStmt == null)
{
return 0;
}
}

SQL_BindParamString(hUserStmt, 0, name, false);
if (!SQL_Execute(hUserStmt))
{
return 0;
}

/* Get some info here */
/* return info; */
}</sourcepawn>

The important differences:
*The input string (<tt>name</tt>) did not need to be backticked (quoted). The SQL engine automatically performs all type safety and insertion checks.
*There was no need for quotation marks around the parameter marker, <tt>?</tt>, even though it accepted a string.
*We only needed to create the statement Handle once; after that it can live for the lifetime of the database connection.

=Processing Results=
Processing results is done in the same manner for both normal queries and prepared statements. The important functions are:
*<tt>SQL_GetRowCount()</tt> - Returns the number of rows.
*<tt>SQL_FetchRow()</tt> - Fetches the next row if one is available.
*<tt>SQL_Fetch[Int|String|Float]()</tt> - Fetches data from a field in the current row.

Let's consider a sample table that looks like this:
<sql>CREATE TABLE users (
name VARCHAR(64) NOT NULL PRIMARY KEY,
age INT UNSIGNED NOT NULL
);</sql>

The following example has code that will print out all users matching a certain age. There is an example for both prepared statements and normal queries.
<sourcepawn>void PrintResults(Handle query)
{
/* Even if we have just one row, you must call SQL_FetchRow() first */
char name[MAX_NAME_LENGTH];
while (SQL_FetchRow(query))
{
SQL_FetchString(query, 0, name, sizeof(name));
PrintToServer("Name \"%s\" was found.", name);
}
}

bool GetByAge_Query(Database db, int age)
{
char query[100];
Format(query, sizeof(query), "SELECT name FROM users WHERE age = %d", age);

DBResultSet hQuery = SQL_Query(db, query);
if (hQuery == null)
{
return false;
}

PrintResults(hQuery);

delete hQuery;

return true;
}

DBStatement hAgeStmt = null;
bool GetByAge_Statement(Database db, int age)
{
if (hAgeSmt == null)
{
char error[255];
if ((hAgeStmt = SQL_PrepareQuery(db,
"SELECT name FROM users WHERE age = ?",
error,
sizeof(error))) == null)
{
return false;
}
}

SQL_BindParamInt(hAgeStmt, 0, age);
if (!SQL_Execute(hAgeStmt))
{
return false;
}

PrintResults(hAgeStmt);

return true;
}</sourcepawn>

Note that these examples did not close the statement Handles. These examples assume a global database instance that is only closed when the plugin is unloaded. For plugins which maintain temporary database connections, prepared statement Handles must be freed or else the database connection will never be closed.

=Threading=
SourceMod supports threaded SQL querying. That is, SQL operations can be completed in a separate thread from main gameplay. If your database server is remote or requires a network connection, queries can cause noticeable gameplay lag, and supporting threading is often a good idea if your queries occur in the middle of gameplay.

Threaded queries are ''asynchronous''. That is, they are dispatched and you can only find the results through a callback. Although the callback is guaranteed to fire eventually, it may not fire in any specific given timeframe. Certain drivers may not support threading; if this is the case, an RTE will be thrown. If the threader cannot start or the threader is currently disabled, SourceMod will transparently execute the query in the main thread as a fallback.

==Operations==
All threaded operations (except connecting) use the same callback for result notification: <tt>SQLQueryCallback</tt>. The parameters are:
*<tt>db</tt> - The cloned database handle. If the db handle was not found or was invalidated, <tt>null</tt> is passed.
*<tt>results</tt> - Result object, or null on failure.
*<tt>error</tt> - An error string.
*<tt>data</tt> - Custom data that can be passed via some SQL operations.

The following operations can be done via threads:
*Connection, via <tt>SQL_TConnect</tt>.
*Querying, via <tt>SQL_TQuery()</tt>.
*''Note: prepared statements are not yet available for the threader.''

It is always safe to chain one operation from another.

===Connecting===
It is not necessary to make a threaded connection in order to make threaded queries. However, creating a threaded connection will not pause the game server if a connection cannot be immediately established.
Connecting however uses a different callback: <tt>SQLConnectCallback</tt>.

The following parameters are used for the threaded connection callback:
*<tt>db</tt>: Handle to the database connection, or <tt>null</tt> if it could not be found.
*<tt>error</tt>: The error string, if any.
*<tt>data</tt>: Unused (0)

Example:
<sourcepawn>Database hDatabase = null;

void StartSQL()
{
Database.Connect(GotDatabase);
}

public void GotDatabase(Database db, const char[] error, any data)
{
if (db == null)
{
LogError("Database failure: %s", error);
}
else
{
hDatabase = db;
}
}</sourcepawn>

===Querying===
Threaded queries can be performed on any database Handle as long as the driver supports threading. All query results for the first result set are retrieved while in the thread. If your query returns more than one set of results (for example, <tt>CALL</tt> on MySQL with certain functions), the behaviour of the threader is undefined at this time. Note that if you want to perform both threaded and non-threaded queries on the same connection, you MUST read the "Locking" section below.

Query operations use the following callback parameters:
*<tt>owner</tt>: A Handle to the database used to query. The Handle is not the same as the Handle originally passed; however, it will test positively with <tt>SQL_IsSameConnection</tt>. The Handle can be cloned but it cannot be closed (it is closed automatically). It may be <tt>null</tt> in the case of a serious error (for example, the driver being unloaded).
*<tt>hndl</tt>: A Handle to the query. It can be cloned, but not closed (it is closed automatically). It may be <tt>null</tt> if there was an error.
*<tt>error</tt>: Error string, if any.
*<tt>data</tt>: Optional user-defined data passed in through <tt>SQL_TQuery()</tt>.

Example, continuing from above:
<sourcepawn>void CheckSteamID(int userid, const char[] auth)
{
char query[255];
FormatEx(query, sizeof(query), "SELECT userid FROM users WHERE steamid = '%s'", auth);
hdatabase.Query(T_CheckSteamID, query, userid);
}

public void T_CheckSteamID(Database db, DBResultSet results, const char[] error, any data)
{
int client = 0;

/* Make sure the client didn't disconnect while the thread was running */
if ((client = GetClientOfUserId(data)) == 0)
{
return;
}

if (db == null || results == null || error[0] != '\0')
{
LogError("Query failed! %s", error);
KickClient(client, "Authorization failed");
}
else if (results.RowCount == 0)
{
KickClient(client, "You are not a member");
}
}
</sourcepawn>

==Locking==
It is possible to run both threaded and non-threaded queries on the same connection. However, without the proper precautions, you could corrupt the network stream (even if it's local), corrupt memory, or otherwise cause a crash in the SQL driver. To solve this, SourceMod has ''database locking''. Locking is done via <tt>SQL_LockDatabase()</tt> and <tt>SQL_UnlockDatabase</tt>.

Whenever performing any of the following non-threaded operations on a database, it is absolutely necessary to enclose the entire operation with a lock:
*<tt>SQL_Query()</tt> (and <tt>SQL_FetchMoreResults</tt> pairings)
*<tt>SQL_FastQuery</tt>
*<tt>SQL_PrepareQuery</tt>
*<tt>SQL_Bind*</tt> and <tt>SQL_Execute</tt> pairings

The rule of thumb is: if your operation is going to use the database connection, it must be locked until the operation is fully completed.

Example:
<sourcepawn>bool GetByAge_Query(Database db, int age)
{
char query[100];
FormatEx(query, sizeof(query), "SELECT name FROM users WHERE age = %d", age);

SQL_LockDatabase(db);

DBResultSet hQuery = SQL_Query(db, query);
if (hQuery == null)
{
SQL_UnlockDatabase(db);
return false;
}

SQL_UnlockDatabase(db);

PrintResults(hQuery);

delete hQuery;

return true;
}</sourcepawn>

Note that it was only necessary to lock the query; SourceMod pre-fetches the result set, and thus the network queue is clean.

===Warnings===
*Never call <tt>SQL_LockDatabase</tt> right before a threaded operation. You will deadlock the server and have to terminate/kill it.
*Always pair every Lock with an Unlock. Otherwise you risk a deadlock.
*If your query returns multiple result sets, for example, a procedure call on MySQL that returns results, you must lock both the query and the entire fetch operation. SourceMod is only able to fetch one result set at a time, and all result sets must be cleared before a new query is started.

==Priority==
Threaded SQL operations are placed in a simple priority queue. The priority levels are <tt>High</tt>, <tt>Medium</tt>, and <tt>Low</tt>. Connections always have the highest priority.

Changing the priority can be useful if you have many queries with different purposes. For example, a statistics plugin might execute 10 queries on death, and one query on join. Because the statistics might rely on the join info, the join query might need to be high priority, while the death queries can be low priority.

You should never simply assign a high priority to all of your queries simply because you want them to get done fast. Not only does it not work that way, but you may be inserting subtle problems into other plugins by being greedy.

=SQLite=
==Introduction==
[http://www.sqlite.org/ SQLite] is a fast local-file SQL database engine and SourceMod provides a DBI driver for it. SQLite differs from MySQL, and thus MySQL queries may not work in SQLite. The driver type for connections is <tt>sqlite</tt>.

==Usage==
Since SQLite is local only, most of the connection parameters can be ignored. The only connection parameter required is <tt>database</tt>, which specifies the file name of the database. Databases are created on demand if they do not already exist, and are stored in <tt>addons/sourcemod/data/sqlite</tt>. An extension of ".sq3" is automatically appended to the file name.

Additionally, you can specify sub-folders in the database name. For example, "cssdm/players" will become <tt>addons/sourcemod/data/sqlite/cssdm/players.sq3</tt>.

SQLite supports the threading layer, and requires all of the same rules as the MySQL driver (including locks on shared connections).

==External Links==
*[http://www.sqlite.org SQLite Homepage]
*[https://sqlitebrowser.org/ DB Browser for SQLite]

[[Category:SourceMod Scripting]]

{{LanguageSwitch}}

Creating Natives (SourceMod Scripting)

2021-10-16T14:32:24Z

Bacardi: /* Arrays */ const int[] array

SourceMod allows plugins to create their own natives that other plugins can use. This is very similar to AMX Mod X's {{amxx_func|register_native}} function. It is a powerful inter-plugin communication resource that can greatly enhance the functionality you provide.

''Prerequisites:'' You should have a good grasp of Pawn or SourcePawn scripting, as well as how [[Tags (Scripting)|Tags]] work. 
''Note:'' Most functions herein can be found in the [[SourceMod SDK]], under <tt>plugins/include/functions.inc</tt>.

=Introduction=
Before creating natives, you should always document and specify exactly how they will work. This means writing your "include file" beforehand. Not only does this guide you in writing your natives, but it has the added benefit of completing a large portion of documentation at the same time.

==Include File==
For our first example, let's start off with a simple native that adds two numbers, a float and a non-float. It might look like this:
<sourcepawn>/** Double-include prevention */
#if defined _mynatives_included_
#endinput
#endif
#define _mynatives_included_

/**
* Adds two numbers together.
*
* @param num1 An integer.
* @param num2 A float.
* @return The float value of the integer and float added together.
*/
native float My_AddNumbers(int num1, int num2);</sourcepawn>

The documentation and commenting style above is a SourceMod Development Team convention. While you are not required to follow it for your own code, it may be a good idea to enhance readability (as readers will expect the style to conform).

==Creating the Native==
To actually create the native, first let's define the native handler itself. From the [https://sm.alliedmods.net/new-api/functions/NativeCall API reference] we can see that there are two prototypes. We will use the second one:
<sourcepawn>function any (Handle plugin, int numParams)</sourcepawn>

Thus, we have a function like:
<sourcepawn>public any Native_My_AddNumbers(Handle plugin, int numParams)
{
}</sourcepawn>

Note that we don't use the same function name as we did in our include file. This is to prevent a possible ''name clash''. Otherwise, two different symbols (one a native, another a function) could have the same name, and that's not allowed. We'll see later how we bind the native to its actual name.

Next, we need to implement our native.
<sourcepawn>public any Native_My_AddNumbers(Handle plugin, int numParams)
{
/* Retrieve the first parameter we receive */
int num1 = GetNativeCell(1);
/* Retrieve the second parameter we receive */
float num2 = view_as<float>(GetNativeCell(2));
/* Add them together */
float value = num1 + num2;
/* Return the value */
return value;
}</sourcepawn>

You should note three important details. The first is that we have to manually grab the parameters -- they're not easily sent via arguments. This is for technical reasons that go beyond the scope of this document. That means you have to know exactly ''how'' to grab each parameter. For our example, we know that both parameters are simply cells, and thus we can use <tt>GetNativeCell</tt>.

However, the second detail is that there is no <tt>GetNativeCellFloat</tt>. This is because a <tt>float</tt> is still a cell; the data is just interpreted differently. Thus, we ''cast'' the type to <tt>float</tt> manually. '''This is different from calling float(GetNativeCell(2)).''' In fact, that would not work; the <tt>float()</tt> call would interpret the cell as an integer, when in fact it's already a float, just with the wrong type (i.e., no type at all).

Lastly, we did not need to verify <tt>numParams</tt>. The compiler will always send the correct amount of parameters - the user can't mess this up in any easy way. Only if you use variadic arguments, or add parameters and need to support older binaries, do you need to handle <tt>numParams</tt> variations.

==Registering the Native==
Natives must be registered in <tt>AskPluginLoad2</tt>. Although they can be registered elsewhere, only this function guarantees that all other plugins will see your native. The definition for this forward is in <tt>sourcemod.inc</tt>.

<sourcepawn>public APLRes AskPluginLoad2(Handle myself, bool late, char[] error, int err_max)
{
CreateNative("My_AddNumbers", Native_My_AddNumbers);
return APLRes_Success;
}</sourcepawn>

Now, any plugin will be able to use our native as if it were from a Core or a C++ extension.

=Usage=
==By-Reference==
Sometimes, it may be desirable to return data through by-reference parameters. For example, observe the following native prototype:
<sourcepawn>/**
* Closes a Handle, and sets the variable to INVALID_HANDLE by reference.
*
* @param hndl Handle to close and clear.
* @return Anything that CloseHandle() returns.
*/
native bool AltCloseHandle(Handle &hndl);</sourcepawn>

An implementation of this would look like:
<sourcepawn>public int Native_AltCloseHandle(Handle plugin, int numParams)
{
Handle hndl = view_as<Handle>(GetNativeCellRef(1));
SetNativeCellRef(1, 0); /* Zero out the variable by reference */
return CloseHandle(hndl);
}</sourcepawn>

Now, we have a native that is "safer" than a normal <tt>CloseHandle</tt>, as it ensures we don't hold onto invalid Handles.

==Strings==
Strings can be retrieved and altered via dynamic natives. Observe the following native prototype:
<sourcepawn>/**
* Converts a string to upper case.
*
* @param str String to convert.
* @noreturn
*/
native void StringToUpper(char[] str);</sourcepawn>

An implementation of this is very easy, because of dynamic arrays:
<sourcepawn>public int Native_StringToUpper(Handle plugin, int numParams)
{
int len;
GetNativeStringLength(1, len);

if (len <= 0)
{
return;
}

char[] str = new char[len + 1];
GetNativeString(1, str, len + 1);

for (int i = 0; i < len; i++)
{
/* 5th bit specifies case in ASCII --
* this is not UTF-8 compatible.
*/
if ((str[i] & (1 << 5)) == (1 << 5))
{
str[i] &= ~(1 << 5)
}
}

SetNativeString(1, str, len+1, false);
}</sourcepawn>

==Arrays==
Working with arrays is very similar to strings. For example, observe the following native prototype:
<sourcepawn>/**
* Sums an array of numbers and returns the sum.
*
* @param array Array of numbers to sum.
* @param size Size of array.
* @return Sum of the array elements.
*/
native int SumArray(const int[] array, int size);</sourcepawn>

An implementation of this could look like:
<sourcepawn>public int Native_SumArray(Handle plugin, int numParams)
{
int size = GetNativeCell(2);
if (size < 1)
{
return 0;
}

int[] array = new int[size];
int total;
GetNativeArray(1, array, size);

for (int i = 0; i < size; i++)
{
total += array[i];
}
return total;
}</sourcepawn>

Similarly, there is a <tt>SetNativeArray</tt>, which is used to alter array contents.

==Variable Arguments==
Variable arguments are usually used when dealing with [[Format Class Functions (SourceMod Scripting)|format class functions]], however it is also possible to use them for general functionality. The only trick is that unlike normal parameters, every variable argument parameter is passed by-reference. This adds no change for arrays and strings, but for floats, handles, numbers, or anything else that fits in a cell, <tt>GetNativeCellRef</tt> must be used instead.

As an example, let's convert our function from above to use variable arguments:
<sourcepawn>/**
* Sums a list of numbers.
*
* @param num First number to use as a base.
* @param ... Any number of additional numbers to add.
* @return Sum of all numbers passed.
*/
native int SumParams(int num, ...);</sourcepawn>

An implementation of this would look like:
<sourcepawn>public int Native_SumParams(Handle plugin, int numParams)
{
int base = GetNativeCell(1);
for (int i = 2; i <= numParams; i++)
{
base += GetNativeCellRef(i);
}
return base;
}</sourcepawn>

==Format Functions==
It is also possible to create your own [[Format Class Functions (SourceMod Scripting)|format class functions]]. This topic is much more complicated than the previous ones, as the native string formatter allows for many different configurations. This is mainly for optimization. Note that a formatting routine deals with two buffers: the input format string, and the output buffer. <tt>FormatNativeString</tt>, by default, uses parameter indexes directly so you don't have to copy or locally store any of these buffers.

The most common usage of this is to accept a user-formatted string and to not
<sourcepawn>/**
* Prints a message with a [DEBUG] prefix to the server.
*
* @param fmt Format string.
* @param ... Format arguments.
*/
native void DebugPrint(const char[] fmt, any ...);</sourcepawn>

This could be easily implemented as:
<sourcepawn>native int DebugPrint(Handle plugin, int numParams)
{
char buffer[1024];
int written;

FormatNativeString(0, /* Use an output buffer */
1, /* Format param */
2, /* Format argument #1 */
sizeof(buffer), /* Size of output buffer */
written, /* Store # of written bytes */
buffer /* Use our buffer */
);

PrintToServer("[DEBUG] %s", buffer);
}</sourcepawn>

==Throwing Errors==
Often, your native will encounter an unrecoverable error, and you wish to trigger a fatal exception. This is equivalent to <tt>IPluginContext::ThrowNativeError</tt>, and will halt the current function execution in the plugin. The debugger will be invoked and a backtrace will be printed out (if the plugin is in debug mode). Although the current function is cancelled, the plugin will continue to operate normally afterward.

For example, let's say we have a native that operates on clients. We want to throw an error if we get a client index that is invalid or disconnected. We could do this like so:
<sourcepawn>public int MyFunction(Handle plugin, int numParams)
{
int client = GetNativeCell(1);
if (client < 1 || client > MaxClients)
{
return ThrowNativeError(SP_ERROR_NATIVE, "Invalid client index (%d)", client);
}
if (!IsClientConnected(client))
{
return ThrowNativeError(SP_ERROR_NATIVE, "Client %d is not connected", client);
}
/* Code */
}</sourcepawn>

==Creating Natives for Methodmaps==
Declaring natives for methodmaps is similar to other natives, with a few requirements:

# The <tt>CreateNative</tt> string argument is in the format <tt>Tag.Function</tt>.
# The function is declared as a "member" of the methodmap.
# The magic "this" parameter is implicitly passed in first.

Here's an example of a shared plugin and its corresponding include file:

<sourcepawn>/* sharedplugin.sp */
public APLRes AskPluginLoad2(Handle myself, bool late, char[] error, int err_max)
{
CreateNative("Number.PrintToClient", Native_PrintNumberToClient);
return APLRes_Success;
}

public int Native_PrintNumberToClient(Handle plugin, int numParams)
{
int number = GetNativeCell(1);
int client = GetNativeCell(2);

PrintToChat(client, "%d", number);
return;
}

/* sharedplugin.inc */
methodmap Number
{
public Number(int number)
{
return view_as<Number>(number);
}
public native void PrintToClient(int client);
}</sourcepawn>

[[Category:SourceMod Scripting]]

Creating Natives (SourceMod Scripting)

2021-10-16T14:22:27Z

Bacardi: /* Arrays */ : error 161: brackets after variable name indicate a fixed-size array, but a dynamic size was given - did you mean to use 'new int[size]' syntax?

SourceMod allows plugins to create their own natives that other plugins can use. This is very similar to AMX Mod X's {{amxx_func|register_native}} function. It is a powerful inter-plugin communication resource that can greatly enhance the functionality you provide.

''Prerequisites:'' You should have a good grasp of Pawn or SourcePawn scripting, as well as how [[Tags (Scripting)|Tags]] work. 
''Note:'' Most functions herein can be found in the [[SourceMod SDK]], under <tt>plugins/include/functions.inc</tt>.

=Introduction=
Before creating natives, you should always document and specify exactly how they will work. This means writing your "include file" beforehand. Not only does this guide you in writing your natives, but it has the added benefit of completing a large portion of documentation at the same time.

==Include File==
For our first example, let's start off with a simple native that adds two numbers, a float and a non-float. It might look like this:
<sourcepawn>/** Double-include prevention */
#if defined _mynatives_included_
#endinput
#endif
#define _mynatives_included_

/**
* Adds two numbers together.
*
* @param num1 An integer.
* @param num2 A float.
* @return The float value of the integer and float added together.
*/
native float My_AddNumbers(int num1, int num2);</sourcepawn>

The documentation and commenting style above is a SourceMod Development Team convention. While you are not required to follow it for your own code, it may be a good idea to enhance readability (as readers will expect the style to conform).

==Creating the Native==
To actually create the native, first let's define the native handler itself. From the [https://sm.alliedmods.net/new-api/functions/NativeCall API reference] we can see that there are two prototypes. We will use the second one:
<sourcepawn>function any (Handle plugin, int numParams)</sourcepawn>

Thus, we have a function like:
<sourcepawn>public any Native_My_AddNumbers(Handle plugin, int numParams)
{
}</sourcepawn>

Note that we don't use the same function name as we did in our include file. This is to prevent a possible ''name clash''. Otherwise, two different symbols (one a native, another a function) could have the same name, and that's not allowed. We'll see later how we bind the native to its actual name.

Next, we need to implement our native.
<sourcepawn>public any Native_My_AddNumbers(Handle plugin, int numParams)
{
/* Retrieve the first parameter we receive */
int num1 = GetNativeCell(1);
/* Retrieve the second parameter we receive */
float num2 = view_as<float>(GetNativeCell(2));
/* Add them together */
float value = num1 + num2;
/* Return the value */
return value;
}</sourcepawn>

You should note three important details. The first is that we have to manually grab the parameters -- they're not easily sent via arguments. This is for technical reasons that go beyond the scope of this document. That means you have to know exactly ''how'' to grab each parameter. For our example, we know that both parameters are simply cells, and thus we can use <tt>GetNativeCell</tt>.

However, the second detail is that there is no <tt>GetNativeCellFloat</tt>. This is because a <tt>float</tt> is still a cell; the data is just interpreted differently. Thus, we ''cast'' the type to <tt>float</tt> manually. '''This is different from calling float(GetNativeCell(2)).''' In fact, that would not work; the <tt>float()</tt> call would interpret the cell as an integer, when in fact it's already a float, just with the wrong type (i.e., no type at all).

Lastly, we did not need to verify <tt>numParams</tt>. The compiler will always send the correct amount of parameters - the user can't mess this up in any easy way. Only if you use variadic arguments, or add parameters and need to support older binaries, do you need to handle <tt>numParams</tt> variations.

==Registering the Native==
Natives must be registered in <tt>AskPluginLoad2</tt>. Although they can be registered elsewhere, only this function guarantees that all other plugins will see your native. The definition for this forward is in <tt>sourcemod.inc</tt>.

<sourcepawn>public APLRes AskPluginLoad2(Handle myself, bool late, char[] error, int err_max)
{
CreateNative("My_AddNumbers", Native_My_AddNumbers);
return APLRes_Success;
}</sourcepawn>

Now, any plugin will be able to use our native as if it were from a Core or a C++ extension.

=Usage=
==By-Reference==
Sometimes, it may be desirable to return data through by-reference parameters. For example, observe the following native prototype:
<sourcepawn>/**
* Closes a Handle, and sets the variable to INVALID_HANDLE by reference.
*
* @param hndl Handle to close and clear.
* @return Anything that CloseHandle() returns.
*/
native bool AltCloseHandle(Handle &hndl);</sourcepawn>

An implementation of this would look like:
<sourcepawn>public int Native_AltCloseHandle(Handle plugin, int numParams)
{
Handle hndl = view_as<Handle>(GetNativeCellRef(1));
SetNativeCellRef(1, 0); /* Zero out the variable by reference */
return CloseHandle(hndl);
}</sourcepawn>

Now, we have a native that is "safer" than a normal <tt>CloseHandle</tt>, as it ensures we don't hold onto invalid Handles.

==Strings==
Strings can be retrieved and altered via dynamic natives. Observe the following native prototype:
<sourcepawn>/**
* Converts a string to upper case.
*
* @param str String to convert.
* @noreturn
*/
native void StringToUpper(char[] str);</sourcepawn>

An implementation of this is very easy, because of dynamic arrays:
<sourcepawn>public int Native_StringToUpper(Handle plugin, int numParams)
{
int len;
GetNativeStringLength(1, len);

if (len <= 0)
{
return;
}

char[] str = new char[len + 1];
GetNativeString(1, str, len + 1);

for (int i = 0; i < len; i++)
{
/* 5th bit specifies case in ASCII --
* this is not UTF-8 compatible.
*/
if ((str[i] & (1 << 5)) == (1 << 5))
{
str[i] &= ~(1 << 5)
}
}

SetNativeString(1, str, len+1, false);
}</sourcepawn>

==Arrays==
Working with arrays is very similar to strings. For example, observe the following native prototype:
<sourcepawn>/**
* Sums an array of numbers and returns the sum.
*
* @param array Array of numbers to sum.
* @param size Size of array.
* @return Sum of the array elements.
*/
native int SumArray(const int array[], int size);</sourcepawn>

An implementation of this could look like:
<sourcepawn>public int Native_SumArray(Handle plugin, int numParams)
{
int size = GetNativeCell(2);
if (size < 1)
{
return 0;
}

int[] array = new int[size];
int total;
GetNativeArray(1, array, size);

for (int i = 0; i < size; i++)
{
total += array[i];
}
return total;
}</sourcepawn>

Similarly, there is a <tt>SetNativeArray</tt>, which is used to alter array contents.

==Variable Arguments==
Variable arguments are usually used when dealing with [[Format Class Functions (SourceMod Scripting)|format class functions]], however it is also possible to use them for general functionality. The only trick is that unlike normal parameters, every variable argument parameter is passed by-reference. This adds no change for arrays and strings, but for floats, handles, numbers, or anything else that fits in a cell, <tt>GetNativeCellRef</tt> must be used instead.

As an example, let's convert our function from above to use variable arguments:
<sourcepawn>/**
* Sums a list of numbers.
*
* @param num First number to use as a base.
* @param ... Any number of additional numbers to add.
* @return Sum of all numbers passed.
*/
native int SumParams(int num, ...);</sourcepawn>

An implementation of this would look like:
<sourcepawn>public int Native_SumParams(Handle plugin, int numParams)
{
int base = GetNativeCell(1);
for (int i = 2; i <= numParams; i++)
{
base += GetNativeCellRef(i);
}
return base;
}</sourcepawn>

==Format Functions==
It is also possible to create your own [[Format Class Functions (SourceMod Scripting)|format class functions]]. This topic is much more complicated than the previous ones, as the native string formatter allows for many different configurations. This is mainly for optimization. Note that a formatting routine deals with two buffers: the input format string, and the output buffer. <tt>FormatNativeString</tt>, by default, uses parameter indexes directly so you don't have to copy or locally store any of these buffers.

The most common usage of this is to accept a user-formatted string and to not
<sourcepawn>/**
* Prints a message with a [DEBUG] prefix to the server.
*
* @param fmt Format string.
* @param ... Format arguments.
*/
native void DebugPrint(const char[] fmt, any ...);</sourcepawn>

This could be easily implemented as:
<sourcepawn>native int DebugPrint(Handle plugin, int numParams)
{
char buffer[1024];
int written;

FormatNativeString(0, /* Use an output buffer */
1, /* Format param */
2, /* Format argument #1 */
sizeof(buffer), /* Size of output buffer */
written, /* Store # of written bytes */
buffer /* Use our buffer */
);

PrintToServer("[DEBUG] %s", buffer);
}</sourcepawn>

==Throwing Errors==
Often, your native will encounter an unrecoverable error, and you wish to trigger a fatal exception. This is equivalent to <tt>IPluginContext::ThrowNativeError</tt>, and will halt the current function execution in the plugin. The debugger will be invoked and a backtrace will be printed out (if the plugin is in debug mode). Although the current function is cancelled, the plugin will continue to operate normally afterward.

For example, let's say we have a native that operates on clients. We want to throw an error if we get a client index that is invalid or disconnected. We could do this like so:
<sourcepawn>public int MyFunction(Handle plugin, int numParams)
{
int client = GetNativeCell(1);
if (client < 1 || client > MaxClients)
{
return ThrowNativeError(SP_ERROR_NATIVE, "Invalid client index (%d)", client);
}
if (!IsClientConnected(client))
{
return ThrowNativeError(SP_ERROR_NATIVE, "Client %d is not connected", client);
}
/* Code */
}</sourcepawn>

==Creating Natives for Methodmaps==
Declaring natives for methodmaps is similar to other natives, with a few requirements:

# The <tt>CreateNative</tt> string argument is in the format <tt>Tag.Function</tt>.
# The function is declared as a "member" of the methodmap.
# The magic "this" parameter is implicitly passed in first.

Here's an example of a shared plugin and its corresponding include file:

<sourcepawn>/* sharedplugin.sp */
public APLRes AskPluginLoad2(Handle myself, bool late, char[] error, int err_max)
{
CreateNative("Number.PrintToClient", Native_PrintNumberToClient);
return APLRes_Success;
}

public int Native_PrintNumberToClient(Handle plugin, int numParams)
{
int number = GetNativeCell(1);
int client = GetNativeCell(2);

PrintToChat(client, "%d", number);
return;
}

/* sharedplugin.inc */
methodmap Number
{
public Number(int number)
{
return view_as<Number>(number);
}
public native void PrintToClient(int client);
}</sourcepawn>

[[Category:SourceMod Scripting]]

Function Calling API (SourceMod Scripting)

2021-08-01T21:31:38Z

Bacardi: /* Private Forwards */ remove const

SourceMod provides plugins with an API for calling functions. This API can be used to call public functions in any plugin, including public functions in the same plugin.

This article is split into two sections. The first is on generic function calling, which is used for single function calls. The second is on Forwards, which is used for calling multiple functions in one operation.

For more information on forwards, readers should see [[Writing_Extensions#Creating_Events.2FForwards|forwards in extensions]].

=Generic Calling=
There are four steps to calling a function in a plugin:
<ol>
<li>Obtaining a "call Handle." This is either in the form of a function ID, tagged with <tt>Function</tt>, or a Forward Handle, tagged with <tt>Handle</tt>.</li>
<li>Starting the call.
<li>Pushing parameters in increasing order in a way that matches the function prototype.</li>
<li>Ending the the call, which performs the call operation and returns the result.</li>
</ol>

For simplicity, let's consider calling a function in our own plugin. We have the following function:
<sourcepawn>public void OnClientDied(int attacker, int victim, const char[] weapon, bool headshot)
{
char name[MAX_NAME_LENGTH];
GetClientName(victim, name, sizeof(name));

if (attacker != victim)
{
char other[MAX_NAME_LENGTH];
GetClientName(attacker, other, sizeof(other));
PrintToServer("<\"%s\"> killed by <\"%s\"> with \"%s\" (headshot: %d)", name, other, weapon, headshot);
}
else if (!attacker)
{
PrintToServer("<\"%s\"> killed by \"world\" with \"%s\" (headshot: %d)", name, weapon, headshot);
}
else
{
PrintToServer("<\"%s\"> killed by \"self\" with \"%s\" (headshot: %d)", name, weapon, headshot);
}
}</sourcepawn>

An indirect way to call this function would be:
<sourcepawn>
public void EventHandler(Event event, const char[] name, bool dontBroadcast)
{
if (StrEqual(name, "player_death"))
{
char weapon[64];
int result;

event.GetString("weapon", weapon, sizeof(weapon));

/* Start function call */
Call_StartFunction(null, OnClientDied);

/* Push parameters one at a time */
Call_PushCell(GetClientOfUserId(event.GetInt("attacker")));
Call_PushCell(GetClientOfUserId(event.GetInt("userid")));
Call_PushString(weapon);
Call_PushCell(event.GetInt("headshot"));

/* Finish the call, get the result */
Call_Finish(result);
}
}</sourcepawn>

This basic example shows starting and completing a function call. However, the real use of function calling is with forwards, which is covered in the next section.

=Forwards=
Forwards are much more advantageous over single function calls. They are expandable containers, so you can store and complete many calls with very little action. Furthermore, they also adjust themselves when contained plugins are unloaded. Lastly, they are type-checked; each forward's parameter types must be known in advance, and if you push a mismatching type, the call will not complete.

Forwards must be created using the following types:
*<tt>Param_Any</tt> - Any parameter type can be pushed
*<tt>Param_Cell</tt> - A non-Float cell can be pushed
*<tt>Param_Float</tt> - A Float cell can be pushed
*<tt>Param_String</tt> - A string can be pushed
*<tt>Param_Array</tt> - An array can be pushed
*<tt>Param_VarArgs</tt> - This and all further parameters can be any type, but will be by reference. This cannot be the first parameter type, and if it is used, it must be the last parameter type.
*<tt>Param_CellByRef</tt> - A non-Float cell by reference
*<tt>Param_FloatByRef</tt> - A Float cell by reference

Strings and arrays are implicitly by-reference. When pushing variable argument parameters, if anything is pushed by-value, it will be internally automatically converted to by-reference.

Since Forwards will call multiple functions in a row, it needs to know how to interpret the return values of functions. There are four predefined methods:
*<tt>ET_Ignore</tt> - All return values will be ignored; 0 will be returned at the end.
*<tt>ET_Single</tt> - Only the last return value will be returned.
*<tt>ET_Event</tt> - Function should return an <tt>Action</tt> value (<tt>core.inc</tt>). <tt>Plugin_Stop</tt> acts as <tt>Plugin_Handled</tt>. The highest value is returned.
*<tt>ET_Hook</tt> - Function should return an <tt>Action</tt> value. <tt>Plugin_Stop</tt> ends the forward call immediately.

Let's write a simple example. Our plugin, Plugin A, wants to tell other plugins when a player dies. It has two ways of doing this, either via a ''global'' forward or a ''private'' forward. A global forward acts upon all functions in all plugins that match a single name. A private forward lets you explicitly manage which functions are in the container.

==Global Forwards==
Global forwards are very simple to use. After creation, they do not need to be maintained. An example plugin below creates a global forward with the following prototype:
<sourcepawn>forward void OnClientDied(int attacker, int victim, const char[] weapon, bool headshot);</sourcepawn>

Implementation:
<sourcepawn>GlobalForward g_DeathForward;

public void OnPluginStart()
{
g_DeathForward = new GlobalForward("OnClientDied", ET_Event, Param_Cell, Param_Cell, Param_String, Param_Cell);
HookEvent("player_death", EventHandler);
}

public APLRes AskPluginLoad2(Handle plugin, bool late, char[] error, int err_max)
{
RegPluginLibrary("my_plugin");
}

public Action EventHandler(Event event, const char[] name, bool dontBroadcast)
{
char weapon[64];
Action result;

event.GetString("weapon", weapon, sizeof(weapon));

/* Start function call */
Call_StartForward(g_DeathForward);

/* Push parameters one at a time */
Call_PushCell(GetClientOfUserId(event.GetInt("attacker")));
Call_PushCell(GetClientOfUserId(event.GetInt("userid")));
Call_PushString(weapon);
Call_PushCell(GetEventInt(event, "headshot"));

/* Finish the call, get the result */
Call_Finish(result);

return result;
}</sourcepawn>

==Private Forwards==
Private forwards require you to manually add functions to its container. This can leave you with much more flexibility. Like global forwards, they automatically remove functions from unloaded plugins.

Usually, this is done using dynamic natives; a plugin will expose a function to add to its own forwards. For example:
<sourcepawn>typedef OnClientDiedFunc = function Action (int attacker, int victim, const char[] weapon, bool headshot);

/**
* Calls the target function when a client dies.
*
* @param func OnClientDiedFunc function.
* @noreturn
*/
native void HookClientDeath(OnClientDiedFunc func);</sourcepawn>

An implementation of this might look like:
<sourcepawn>PrivateForward g_DeathForward;

public void OnPluginStart()
{
g_DeathForward = new PrivateForward(ET_Event, Param_Cell, Param_Cell, Param_String, Param_Cell);

CreateNative("HookClientDeath", Native_HookClientDeath);

HookEvent("player_death", EventHandler);
}

public int Native_HookClientDeath(Handle plugin, int numParams)
{
g_DeathForward.AddFunction(plugin, GetNativeFunction(1));
}</sourcepawn>

Note that the code to call the forward does not need to change at all.

A complete implementation of a private forward may look like this:
<sourcepawn>typedef MyFunction = function void (int client);
native void My_NativeEx(MyFunction func);</sourcepawn>

<sourcepawn>PrivateForward g_hDeathFwd;

// typedef MyFunction = function void (int client);
// native void My_NativeEx(MyFunction func);
public APLRes AskPluginLoad2(Handle plugin, bool late, char[] error, int err_max)
{
RegPluginLibrary("MyPlugin");

CreateNative("My_NativeEx", My_Native);

return APLRes_Success;
}

public void OnPluginStart()
{
HookEvent("player_death", Event_Death);
g_hDeathFwd = new PrivateForward(ET_Ignore, Param_Cell);
}

public int My_Native(Handle plugin, int numParams)
{
g_hDeathFwd.AddFunction(plugin, GetNativeFunction(1));
}

public Action Event_Death(Event event, const char[] name, bool dontBroadcast)
{
int client = GetClientOfUserId(event.GetInt("userid"));

Call_StartForward(g_hDeathFwd);
Call_PushCell(client);
Call_Finish();
}</sourcepawn>

[[Category:SourceMod Scripting]]

KeyValues (SourceMod Scripting)

2020-04-03T13:00:34Z

Bacardi: kv.GoBack(kv) -> kv.GoBack()

KeyValues are simple, tree-based structures used for storing nested sections containing key/value pairs. Detailed information on KeyValues can be seen at the [http://developer.valvesoftware.com/wiki/KeyValues_class Valve Developer Wiki].

All KeyValues specific functions in this document are from <tt>public/include/keyvalues.inc</tt>.

''Note: While the following examples are correct code-wise, over the years they have occasionally led people to use KeyValues in cases where they really should be using a [https://wiki.alliedmods.net/SQL_%28SourceMod_Scripting%29 database] instead.''

=Introduction=
KeyValues consist of a ''nodes'', or ''sections'', which contain pairs of keys and values. A section looks like this:
<pre>"section"
{
"key" "value"
}</pre>

The <tt>"section"</tt> string denotes the section's name. The <tt>"key"</tt> string is the key name, and the <tt>"value"</tt>" string is the value.

KeyValues structures are created with <tt>new KeyValues()</tt>. The Handle must be freed when finished in order to avoid a memory leak.

=Files=
KeyValues can be exported and imported via KeyValues files. These files always consist of a root node and any number of sub-keys or sub-sections. For example, a file might look like this:
<pre>"MyFile"
{
"STEAM_0:0:7"
{
"name" "crab"
}
}</pre>

In this example, <tt>STEAM_0:0:7</tt> is a section under <tt>MyFile</tt>, the root node.

To load KeyValues from a file, use <tt>kv.ImportFromFile</tt> To save KeyValues to a file, use <tt>kv.ExportToFile</tt>, where <tt>kv</tt> is a Handle to a KeyValues structure.

=Traversal=
SourceMod provides natives for traversing over a KeyValues structure. However, it is important to understand how this traversal works. Internally, SourceMod keeps track of two pieces of information:
*The root node
*A traversal stack

Since a KeyValues structure is inherently recursive (it's a tree), the ''traversal stack'' is used to save a history of each ''traversal'' made (a traversal being a recursive dive into the tree, where the current nesting level deepens by one section). The ''top'' of this stack is where all operations take place.

For example, <tt>kv.JumpToKey</tt> will attempt to find a sub-key under the current section. If it succeeds, the position in the tree has changed by moving down one level, and thus this position is pushed onto the traversal stack. Now, operations such as <tt>kv.GetString</tt> will use this new position.

There are natives which change the position but do not change the traversal stack. For example, <tt>kv.GotoNextKey</tt> will change the current section being viewed, but there are no push/pop operations to the traversal stack. This is because the nesting level did not change; it advances to the next section at the same level, rather than finding a section a level deeper.

More traversal natives:
*<tt>kv.GotoFirstSubKey</tt> - Finds the first sub-section under the current section. This pushes the section onto the traversal stack.
*<tt>kv.GoBack</tt> - Pops the traversal stack (moves up one level).
*<tt>kv.Rewind</tt> - Clears the traversal stack so the current position is the root node.

==Basic Lookup==
Let's take our <tt>MyFile</tt> example from above. How could we retrieve the name "crab" given the Steam ID?

<sourcepawn>bool GetNameFromSteamID(const char[] steamid, char[] name, int maxlength)
{
KeyValues kv = new KeyValues("MyFile");
kv.ImportFromFile("myfile.txt");

if (!kv.JumpToKey(steamid))
{
delete kv;
return false;
}

kv.GetString("name", name, maxlength);
delete kv;

return true;
}</sourcepawn>

'''Note:''' <tt>kv.JumpToKey</tt> is a traversal native that changes the nesting level of the traversal stack. However, <tt>delete</tt> will not accidentally close only the current level of the KeyValues structure. It will close the entire thing.

==Iterative Lookup==
Let's modify our previous example to use iteration. This has the same functionality, but demonstrates how to browse over many sections.

<sourcepawn>bool GetNameFromSteamID(const char[] steamid, char[] name, int maxlength)
{
KeyValues kv = new KeyValues("MyFile");
kv.ImportFromFile("myfile.txt");

// Jump into the first subsection
if (!kv.GotoFirstSubKey())
{
delete kv;
return false;
}

// Iterate over subsections at the same nesting level
char buffer[255];
do
{
kv.GetSectionName(buffer, sizeof(buffer));
if (StrEqual(buffer, steamid))
{
kv.GetString("name", name, maxlength);
delete kv;
return true;
}
} while (kv.GotoNextKey());

delete kv;

return false;
}</sourcepawn>

'''Note:''' In this example, note that <tt>kv.GotoNextKey</tt> is an iterative function, not a traversal one. Since it does not change the nesting level, we don't need to call <tt>kv.GoBack</tt> to return and continue iterating.

==Full Traversal==
Let's say we wanted to browse every section of a KeyValues file. An example of this might look like:
<sourcepawn>void BrowseKeyValues(KeyValues kv)
{
do
{
// You can read the section/key name by using kv.GetSectionName here.

if (kv.GotoFirstSubKey(false))
{
// Current key is a section. Browse it recursively.
BrowseKeyValues(kv);
kv.GoBack();
}
else
{
// Current key is a regular key, or an empty section.
if (kv.GetDataType(NULL_STRING) != KvData_None)
{
// Read value of key here (use NULL_STRING as key name). You can
// also get the key name by using kv.GetSectionName here.
}
else
{
// Found an empty sub section. It can be handled here if necessary.
}
}
} while (kv.GotoNextKey(false));
}</sourcepawn>

This function will browse an entire KeyValues structure. Note that every successful call to <tt>kv.GotoFirstSubKey</tt> is paired with a call to <tt>kv.GoBack</tt>. This is because the former pushes onto the traversal stack. We must pop the position off so we can continue browsing from our old position.

Also note that <tt>keyOnly</tt> is set to false in both <tt>kv.GotoFirstSubKey</tt> and <tt>kv.GotoNextKey</tt> so that it will jump to regular keys and not just between sections. Because of this we also need to check if <tt>kv.GotoFirstSubKey</tt> succeeded moving to a regular key before we read the value. This is simply done by getting the data type of the current key. If <tt>kv.GotoFirstSubKey</tt> failed to move to any key (the section is empty), the cursor is still on the section, which doesn't have a data type. If there is a data type, we've confirmed that it's a regular key.

=Deletion=
There are two ways to delete sections from a KeyValues structure:
*<tt>kv.DeleteKey</tt> - Safely removes a named sub-section and any of its child sections/keys.
*<tt>kv.DeleteThis</tt> - Safely removes the current position if possible.

==Simple Deletion==
First, let's use our "basic lookup" example to delete a Steam ID section:
<sourcepawn>
void RemoveSteamID(const char[] steamid)
{
KeyValues kv = new KeyValues("MyFile");
kv.ImportFromFile("myfile.txt");

if (!kv.JumpToKey(steamid))
{
delete kv;
return;
}

kv.DeleteThis();
kv.Rewind();
kv.ExportToFile("myfile.txt");
delete kv;
}
</sourcepawn>

'''Note:''' We called <tt>kv.Rewind</tt> so the file would be dumped from the root position, instead of the current one.

==Iterative Deletion==
Likewise, let's show how our earlier iterative example could be adapted for deleting a section. For this we can use <tt>kv.DeleteThis</tt>, which deletes the current position from the previous position in the traversal stack.

<sourcepawn>void RemoveSteamID(const char[] steamid)
{
KeyValues kv = new KeyValues("MyFile");
kv.ImportFromFile("myfile.txt");

if (!kv.JumpToKey(steamid))
{
delete kv;
return;
}

char buffer[255];
do
{
kv.GetSectionName(buffer, sizeof(buffer))
if (StrEqual(buffer, steamid))
{
kv.DeleteThis();
delete kv;
return;
}
} while (kv.GotoNextKey());

delete kv;
}</sourcepawn>

==Full Deletion==
Now, let's take a look at how we would delete all (or some) keys. <tt>kv.DeleteThis</tt> has the special property that it can act as an automatic iterator. When it deletes a key, it automatically attempts to advance to the next one, as <tt>kv.GotoNextKey</tt> would. If it can't find any more keys, it simply pops the traversal stack.

An example of deleting all SteamIDs that have blank names:
<sourcepawn>void DeleteAll(KeyValues kv)
{
if (!kv.GotoFirstSubKey())
{
delete kv;
return;
}

for (;;)
{
char name[4];
kv.GetString("name", name, sizeof(name));
if (name[0] == '\0')
{
if (kv.DeleteThis() < 1)
{
break;
}
}
else if (!kv.GotoNextKey())
{
break;
}
}

delete kv;
}</sourcepawn>

While at first this loop looks infinite, it is not. If <tt>kv.DeleteThis</tt> fails to find a subsequent key, it will break out of the loop. Similarly, if <tt>kv.GotoNextKey</tt> fails, the loop will end.

==KeyValue Creation==
This is how you would create the <tt>MyFile</tt> example from above with the KeyValue API
<sourcepawn>KeyValues kv = new KeyValues("MyFile");
kv.JumpToKey("STEAM_0:0:7", true);
kv.SetString("name", "crab");
kv.Rewind();
kv.ExportToFile("C:\\javalia.txt");
delete kv;</sourcepawn>

[[Category:SourceMod Scripting]]
{{LanguageSwitch}}

SourcePawn Transitional Syntax

2020-03-31T19:24:43Z

Bacardi: Link to Category:SourceMod_Scripting

__FORCETOC__
We would like to give our users a more modern language. Pawn is showing its age; manual memory management, buffers, tags, and lack of object-oriented API are very frustrating. We can't solve everything all at once, but we can begin to take steps in the right direction.

SourceMod 1.7 introduces a ''Transitional API''. It is built on a new ''Transitional Syntax'' in SourcePawn, which is a set of language tools to make Pawn feel more modern. In particular, it allows developers to use older APIs in an object-oriented manner, without breaking compatibility. Someday, if and when SourcePawn can become a full-fledged modern language, the transitional API will making porting efforts very minimal.

The transitional API has the following major features and changes:
* New Declarators - A cleaner way of declaring variables, similar to Java and C#.
* Methodmaps - Object-oriented wrappers around older APIs.
* Real Types - SourcePawn now has "int", "float", "bool", "void", and "char" as real types.
* <tt>null</tt> - A new, general keyword to replace <tt>INVALID_HANDLE</tt>.

=New Declarators=
Developers familiar with pawn will recognize Pawn's original declaration style:
<pawn>
new Float:x = 5.0;
new y = 7;
</pawn>

In the transitional syntax, this can be reworded as:
<pawn>
float x = 5.0;
int y = 7;
</pawn>

The following builtin tags now have types:
* <tt>Float:</tt> is <tt>float</tt>.
* <tt>bool:</tt> is <tt>bool</tt>.
* <tt>_:</tt> (or no tag) is <tt>int</tt>.
* <tt>String:</tt> is <tt>char</tt>.
* <tt>void</tt> can now be used as a return type for functions.

===Rationale===
In the old style, tagged variables are not real types. <tt>Float:x</tt> does not indicate a float-typed variable, it indicates a 32-bit "cell" tagged as a float. It is possible to remove the tag or change the tag, which while flexible, is dangerous and confusing. The syntax itself is also problematic. The parser does not have the ability to identify characters in between the tag name and the colon. Internally, the compiler cannot represent values that are not exactly 32-bit.

The takeaway message is: there is no sensible way to represent a concept like "int64" or "X is a type that represents an array of floats". The tagging grammar makes it too awkward, and the compiler itself is incapable of attaching such information to a tag. We can't fix that right away, but we can begin to deprecate the tag system via a more normal declaration syntax.

An easy example to see why this is necessary, is the weirdness in expressing something like this with tags:
<pawn>
native float[3] GetEntOrigin();
</pawn>

''Note on the <tt>String</tt> tag:'' The introduction of <tt>char</tt> might initially seem confusing. The reason for this is that in the future, we would like to introduce a true "string" type that acts as an object, like strings in most other languages. The existing behavior in Pawn is an array of characters, which is much lower-level. The renaming clarifies what the type really is, and leaves the door open for better types in the future.

==Arrays==
The new style of declaration disambiguates between two kinds of arrays. Pawn has ''indeterminate arrays'', where the size is not known, and ''determinate arrays'', where the size is known. We refer to these as "dynamic" and "fixed-length" arrays, respectively.

'''A fixed-length array is declared by placing brackets after a variable name'''. For example:
<pawn>
int CachedStuff[1000];
int PlayerData[MAXPLAYERS + 1] = { 0, ... };
int Weapons[] = { WEAPON_AK47, WEAPON_GLOCK, WEAPON_KNIFE };
</pawn>

In these examples, the array size is fixed. The size is known ahead of time and cannot change. When using brackets in this position, the array size must be specified, either via an explicit size or inferred from an initial value.

A dynamic-length array has the brackets '''before the variable name''', that is, '''after the type'''. The most common case is when specifying functions that take an array as input:
<pawn>
native void SetPlayerName(int player, const char[] name);
</pawn>

Here, we are specifying that the length of <tt>name</tt> is not always known - it could be anything.

Dynamic arrays can also be created in local scopes. For example,
<pawn>
void FindPlayers()
{
int[] players = new int[MaxClients + 1];
}
</pawn>

This allocates a new array of the given size and places a reference in <tt>players</tt>. The memory is automatically freed when no longer in use.

It is illegal to initialize a fixed-length array with an indeterminate array, and it is illegal to initialize a dynamic array with a fixed-array. It is also illegal to specify a fixed size on a dynamic length array.

For the most part, this does not change existing Pawn semantics. It is simply new syntax intended to clarify the way arrays work.

===Rationale===
In the original syntax, there was a subtle difference in array declaration:
<tt>
new array1[MAXPLAYERS + 1];
new array2[MaxClients + 1];
</tt>

Here, <tt>array1</tt> and <tt>array2</tt> are very different types: the first is an <tt>int[65]</tt> and the latter is an <tt>int[]</tt>. However, there is no syntactic difference: the compiler has to deduce whether the size expression is constant to determine the type. The new syntax clearly and explicitly disambiguates these cases, so in the future when we introduce fully dynamic and flexible arrays, we're less likely to break existing code.

This may result in some confusion. Hopefully won't matter long term, as once we have true dynamic arrays, fixed arrays will become much less useful and more obscure.

The rationale for restricting initializers is similar. Once we have true dynamic arrays, the restrictions will be lifted. In the meantime, we need to make sure we're limited to semantics that won't have subtle differences in the future.

==Examples==
<pawn>
float x = 5.0; // Replacement for "new Float:x = 5.0;"
int y = 4; // Replacement for "new y = 4;"
char name[32]; // Replacement for "new String:name[32];" and "decl String:name[32];"

void DoStuff(float x, int y, char[] name, int length) { //Replacement for "DoStuff(Float:x, y, String:name[], length)"
Format(name, length, "%f %d", x, y); //No replacement here
}
</pawn>

==View As==
A new operator is available for reinterpreting the bits in a value as another type. This operator is called <tt>view_as</tt>. It is not a safe cast, in that, it can transform one type to another even if the actual value does not conform to either.

In pre-transitional syntax, this was called "retagging". Retagging does not support new-style types, which is why this operator has been introduced. Example of before and after code:

<pawn>
// Before:
float x = Float:array.Get(i);

// After:
float y = view_as<float>(array.Get(i));
</pawn>

It is worth reiterating that this is not a cast. If the value in the array is not a float, then when "viewed as" a float it will probably look very odd.

==Grammar==
The new and old declaration grammar is below.

<pre>
return-type ::= return-old | return-new
return-new ::= type-expr new-dims? // Note, dims not yet supported.
return-old ::= old-dims? label?

argdecl ::= arg-old | arg-new
arg-new ::= "const"? type-expr '&'? symbol old-dims? ('=' arg-init)?
arg-old ::= "const"? tags? '&'? symbol old-dims? ('=' arg-init)?

vardecl ::= var-old | var-new
var-new ::= var-new-prefix type-expr symbol old-dims?
var-new-prefix ::= "static" | "const"
var-old ::= var-old-prefix tag? symbol old-dims?
var-old-prefix ::= "new" | "decl" | "static" | "const"

global ::= global-old | global-new
global-new ::= storage-class* type-expr symbol old-dims?
global-old ::= storage-class* tag? symbol old-dims?

storage-class ::= "public" | "static" | "const" | "stock"

type-expr ::= (builtin-type | symbol) new-dims?
builtin-type ::= "void"
| "int"
| "float"
| "char"
| "bool"

tags ::= tag-vector | tag
tag-vector ::= '{' symbol (',' symbol)* '}' ':'
tag ::= label

new-dims ::= ('[' ']')*
old-dims ::= ('[' expr? ']')+

label ::= symbol ':'
symbol ::= [A-Za-z_]([A-Za-z0-9_]*)
</pre>

Also note, there is no equivalent of <tt>decl</tt> in the new declarator syntax. <tt>decl</tt> is considered to be dangerous and unnecessary. If an array's zero initialization is too costly, consider making it static or global.

=Methodmaps=
==Introduction==
Methodmaps are simple: they attach methods onto an enum. For example, here is our legacy API for Handles:

<pawn>
native CloneHandle(Handle handle);
native CloseHandle(Handle handle);
</pawn>

This is a good example of our legacy API. Using it generally looks something like:
<pawn>
Handle array = CreateAdtArray();
PushArrayCell(array, 4);
CloseHandle(array);
</pawn>

Gross! A Methodmap can clean it up by attaching functions to the <tt>Handle</tt> tag, like this:
<pawn>
methodmap Handle {
public Clone() = CloneHandle;
public Close() = CloseHandle;
};
</pawn>

Now, our earlier array code can start to look object-oriented:
<pawn>
Handle array = CreateAdtArray();
PushArrayCell(array, 4);
array.Close();
</pawn>

With a full methodmap for Arrays, for example,
<pawn>
methodmap ArrayList < Handle
{
public native ArrayList(); // constructor
public native void Push(any value);
};
</pawn>

We can write even more object-like code:
<pawn>
ArrayList array = new ArrayList();
array.Push(4);
delete array;
</pawn>

(Note: the official API does not expose methods on raw Handles.)

==Inheritance==
The Handle system has a "weak" hierarchy. All handles can be passed to <tt>CloseHandle</tt>, but only AdtArray handles can be passed to functions like <tt>PushArrayCell</tt>. This hierarchy is not enforced via tags (unfortunately), but instead by run-time checks. Methodmaps allow us to make individual handle types object-oriented, while also moving type-checks into the compiler.

For example, here is a transitional API for arrays:

<pawn>
native AdtArray CreateAdtArray();

methodmap AdtArray < Handle {
public PushCell() = PushArrayCell;
};
</pawn>

Note that <tt>CreateAdtArray</tt> now returns <tt>AdtArray</tt> instead of <tt>Handle</tt>. Normally that would break older code, but since <tt>AdtArray</tt> inherits from <tt>Handle</tt>, there is a special rule in the type system that allows coercing an <tt>AdtArray</tt> to a <tt>Handle</tt> (but not vice versa).

Now, the API looks much more object-oriented:
<pawn>
AdtArray array = CreateAdtArray();
array.PushCell(4);
array.Close();
</pawn>

==Inline Methods==
Methodmaps can declare inline methods and accessors. Inline methods can be either natives or Pawn functions. For example:

<pawn>
methodmap AdtArray {
public native void PushCell(value);
};
</pawn>

This example requires that an "AdtArray.PushCell" native exists somewhere in SourceMod. It has a magic initial parameter called "this", so the signature will look something like:
<pawn>
native void AdtArray.PushCell(AdtArray this, value);
</pawn>

(Of course, this exact signature will not appear in an include file - it's the signature that the C++ implementation should expect, however.)

It's also possible to define new functions without a native:
<pawn>
methodmap AdtArray {
public native void PushCell(value);

public void PushCells(list[], count) {
for (int i = 0; i < count; i++) {
this.PushCell(i);
}
}
};
</pawn>

Lastly, we can also define accessors. or example,
<pawn>
methodmap AdtArray {
property int Size {
public get() = GetArraySize;
}
property bool Empty {
public get() {
return this.Size == 0;
}
}
property int Capacity {
public native get();
}
};
</pawn>

The first accessor simply assigns an existing function as an accessor for "Size". The second accessor is an inline method with an implicit "this" parameter. The third accessor will bind to a native with the following name and signature:

<pawn>
native int AdtArray.Capacity.get(AdtArray this);
</pawn>

Setters are also supported. For example:

<pawn>
methodmap Player {
property int Health {
public native get();
public native set(int health);
}
}
</pawn>

==Custom Tags==
Methodmaps don't have to be used with Handles. It is possible to define custom methodmaps on new or existing tags. For example:

<pawn>
methodmap AdminId {
public int Rights() {
return GetAdminFlags(this);
}
};
</pawn>

Now, for example, it is possible to do:

<pawn>GetPlayerAdmin(id).Rights()</pawn>

==Constructors and Destructors==
Methodmaps can also define constructors and destructors, which is useful if they are intended to behave like actual objects. For example,

<pawn>
methodmap AdtArray {
public AdtArray(blocksize = 1);
public ~AdtArray();
public void PushCell(value);
};
</pawn>

Now AdtArrays can be used in a fully object-oriented style:
<pawn>
AdtArray array = new AdtArray();
array.PushCell(10);
array.PushCell(20);
array.PushCell(30);
delete array;
</pawn>

==Caveats==
There are a few caveats to methodmaps:
<ol>
<li>CloseHandle() is not yet gone. It is required to call <tt>delete</tt> on any object that previously would have required CloseHandle().</li>
<li>There can be only one methodmap for a tag.</li>
<li>When using existing natives, the first parameter of the native must coerce to the tag of the methodmap. Tag mismatches of the "this" parameter will result in an error. Not a warning!</li>
<li>Methodmaps can only be defined on tags. Pawn has some ways of creating actual types (like via <tt>struct</tt> or <tt>class</tt>). Methodmaps cannot be created on those types.</li>
<li>Methodmaps do not have strong typing. For example, it is still possible to perform "illegal" casts like <tt>Float:CreateAdtArray()</tt>. This is necessary for backwards compatibility, so methodmap values can flow into natives like <tt>PrintToServer</tt> or <tt>CreateTimer</tt>.</li>
<li>It is not possible to inherit from anything other than another previously declared methodmap.</li>
<li>Methodmaps can only be defined over scalars - that is, the "this" parameter can never be an array. This means they cannot be used for enum-structs.</li>
<li>Destructors can only be native. When we are able to achieve garbage collection, destructors will be removed.</li>
<li>The signatures of methodmaps must use the new declaration syntax.</li>
<li>Methodmaps must be declared before they are used.</li>
</ol>

==Grammar==
The grammar for methodmaps is:
<pre>
visibility ::= "public"
method-args ::= arg-new* "..."?

methodmap ::= "methodmap" symbol? { methodmap-item* } term
methodmap-item ::=
visibility "~"? symbol "(" ")" "=" symbol term
| visibility "native" type-expr "~"? symbol methodmap-symbol "(" method-args ")" term
| visibility type-expr symbol "(" method-args ")" func-body term
| "property" type-expr symbol { property-decl } term
property-func ::= "get" | "set"
property-decl ::= visibility property-impl
property-impl ::=
"native" property-func "(" ")" term
| property-func "(" ")" func-body term
| property-func "(" ")" "=" symbol
</pre>

=Typedefs=

Function tags and function enums have been deprecated in favor of a more modern syntax. Currently, they can still only create tag names for functions. Future versions will support arbitrary types.

Upgrading both functags and funcenums is simple. Below are two examples:

<pawn>
functag public Action:SrvCmd(args);

funcenum Timer {
Action:public(Handle:Timer, Handle:hndl),
Action:public(Handle:timer),
};
</pawn>

Now, this becomes:
<pawn>
typedef SrvCmd = function Action (int args);

typeset Timer {
function Action (Handle timer, Handle hndl);
function Action (Handle timer);
};
</pawn>

The grammar for the new syntax is:

<pre>
typedef ::= "typedef" symbol "=" full-type-expr term
full-type-expr ::= "(" type-expr ")"
| type-expr
type-expr ::= "function" type-name "(" typedef-args? ")"
typedef-args ::= "..."
| typedef-arg (", " "...")?
</pre>

Note that typedefs only support new-style types.

=Enum Structs=

Enum structs were a previously unsupported mechanism for emulating structs through arrays. As of SourceMod 1.10, this mechanism is now fully supported through Transitional Syntax. Here is an example of enum struct syntax:

<pawn>
enum struct Rectangle {
int x;
int y;
int width;
int height;

int Area() {
return this.width * this.height;
}
}

void DoStuff(Rectangle r) {
PrintToServer("%d, %d, %d, %d", r.x, r.y, r.width, r.height);
}
</pawn>

Enum structs are syntactic sugar and are internally represented as arrays. This means they pass by-reference to function arguments, and the "&" token is not required (nor is it allowed).

Note that even though enum structs are actually arrays, for the most part they cannot be used as arrays. The exception is when interacting with opaque data structures like <tt>ArrayList</tt>. For example, this is considered valid:

<pawn>
void SaveRectangle(ArrayList list, const Rectangle r) {
list.PushArray(r, sizeof(r));
}

void PopArray(ArrayList list, Rectangle r) {
list.GetArray(list.Length - 1, r, sizeof(r));
list.Erase(list.Length - 1);
}
</pawn>

But this is not allowed:

<pawn>
Rectangle r;
PrintToServer("%d", r[0]);
</pawn>

The grammar for enum structs is as follows:

<pre>
enum-struct ::= "enum" "struct" symbol "{" newline enum-struct-entry enum-struct-entry* "}" term
enum-struct-entry ::= enum-struct-field
| enum-struct-method
enum-struct-field ::= type-expr symbol old-dims? term
enum-struct-method ::= type-expr symbol "(" method-args ")" func-body term
</pre>

=Enforcing new syntax=

You can enforce the new syntax in 1.7 by using <pawn>#pragma newdecls required</pawn> ontop of your code, after the includes (or else current 1.7 includes which contain old syntax will be read with new-syntax rules).

[[Category:SourceMod_Scripting]]

Setting up a Notepad++ (SourceMod)

2020-03-31T13:39:41Z

Bacardi: Newer Notepad++ version use now autoCompletion folder.

This is guide to setting up NotePad++ 
Install '''Notepad++ 32-bit x86''' text editor 
:https://notepad-plus-plus.org/download/ 
 
__TOC__
[https://youtu.be/RZ_sv6DtLQ8?list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube Video Setting up a Notepad++ (SourceMod) - Wiki guide]
==SourcePawn syntax highlight & autocompletion==

Download '''npp-docs zip''' file 
:https://github.com/raziEiL/SourceMod-Npp-Docs/releases 
and extract files on your desktop. 
 
Move '''sourcemod.xml''' file into Notepad++ ...plugins\APIs folder
C:\Program Files (x86)\notepad++\plugins\APIs\sourcemod.xml

*Update 31.3.2020 -Since Notepad++ 7.6.x and later
C:\Program Files (x86)\notepad++\autoCompletion\sourcemod.xml
 
Open Notepad++ and select Language -> Define your language... 
Select Import...
and open '''userDefineLang.xml''' file 
 
Restart Notepad++
 

==Plugin NppExec==

Install NppExec Notepad++ plugin (manually or through Plugin Manager). 
:https://sourceforge.net/projects/npp-plugins/files/NppExec/ 
C:\Program Files (x86)\notepad++\plugins\NppExec\NppExec.dll
Restart NotePad++ 
 
Choose Plugins -> NppExec -> Execute... (F6) 
Add this script:
NPP_SAVE
cd "$(CURRENT_DIRECTORY)"
spcomp.exe "$(FILE_NAME)"
cmd /q /c move "$(CURRENT_DIRECTORY)\$(NAME_PART).smx" "$(CURRENT_DIRECTORY)\..\plugins\$(NAME_PART).smx"
Save -> name it ''sourcemod'' -> Save 
 
 
Choose Plugins -> NppExec -> Console Output Filters... (Shift+F6) 
{| border="1"
|✔️||%FILE%(%LINE%) : error *||0x99||0x00||0x00||B
|-
|✔️||%FILE%(%LINE%) : warning *||0x00||0x50||0x99||I
|}
 
 
Choose Plugins -> NppExec -> NppExec Advanced Options... 
Select ''Associated scipt: sourcemod'', then click ''Add/Modify'' button. Ok and restart Notepad++
 
 
Choose Settings -> Shortcut Mapper... and go ''Plugin Commands'' tab. 
Find and clear ''Execute... = F6'' button. 
Find ''sourcemod ='' and Modify ''F6'' button in this line.

==Testing compiling Sourcemod plugin==
Go SourceMod scripting folder, where you find *.sp files. 
Make copy of any file for testing purpose and open it with NotePad++. 
When you hit F6 key, NotePad++ should:
*Save your file
*Run CMD and compile current *.sp file to *.smx
*Move compiled *.smx file from scripting folder to SourceMod plugins folder.

----
--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 08:39, 31 March 2020 (CDT)

[[Category:SourceMod for beginners]]

Setting up a Source Dedicated Server (Windows)

2020-03-30T13:05:02Z

Bacardi: hidden template broken. removing it.

This is '''Quickstart guide''' - Setting up a '''Source Dedicated Server''' into your home PC (Windows version) using [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD tool].
__TOC__
[https://youtu.be/SF7lGzZM6Q0?list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube Video Installing SRCDS - Wiki guide] 
[https://youtu.be/3XC8RnpgDgo?list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube Video Launching SRCDS - Wiki guide]

==Installing SRCDS==
[[File:Steamcmd files.png|thumb|50px|none]]
Get '''SteamCMD tool''' ([https://steamcdn-a.akamaihd.net/client/installer/steamcmd.zip Download Link]), extract zip file and place '''steamcmd.exe''' in this directory structure.
{| border="0"
|-
|{{font|text=C:\server\steamcmd\steamcmd.exe|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
Open notepad.exe and create TXT file in same destination, named '''update.txt''' and create BATCH file named '''steamcmd_run.bat'''.
{| border="0"
|-
|{{font|text=C:\server\steamcmd\update.txt C:\server\steamcmd\steamcmd_run.bat|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
 
Inside '''steamcmd_run.bat''' file, save this script.
steamcmd.exe +runscript update.txt
 
Inside '''update.txt''' file, save this SteamCMD script
{{Note|''This script will now install multiple SRCDS (CS:GO, CS:S and TF2). Disable lines which you not want to install with double slash // or delete lines''}}

login anonymous

force_install_dir "../Counter-Strike Global Offensive"
app_update 740 validate

force_install_dir "../Counter-Strike Source"
app_update 232330 validate

{{color|green|//force_install_dir "../Half-Life 2 Deathmatch"
//app_update 232370 validate

//force_install_dir "../Day of Defeat Source"
//app_update 232290 validate}}

force_install_dir "../Team Fortress 2"
app_update 232250 validate

{{Note|''If some reason you fail to create these above files, you can download those from google drive''}}
https://drive.google.com/open?id=1Hb81rG2D5exQlPz1icLVG3c6VtIwedGP
 
 
Run '''steamcmd_run.bat''' file, SteamCMD window should appear and start downloading files.
If everything is done right, you get SRCDS in C:\server\
 

==Launching SRCDS==
[[File:Launch script.png|thumb|50px|none]]
Find '''srcds.exe''' program from SRCDS game directory. For example in CS:GO mod:
{| border="0"
|-
|{{font|text=C:\server\Counter-Strike Global Offensive\srcds.exe|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
Create shortcut from '''srcds.exe''' and open shortcut properties. 
In shortcut properties Target: input, you see path to the program.
"C:\Server\counter-strike global offensive\srcds.exe"

*By adding parameter '''-console''', you run SRCDS without GUI
*Adding parameter '''-game''', you set <game mod> folder you are going to run
*Adding SRCDS command '''+map''', you start server with specific map. You find maps in ...<game mod>/maps/ folder
Example to run Counter-Strike: Global Offensive dedicated server
"C:\Server\counter-strike global offensive\srcds.exe" -console -game csgo +map de_dust2

Examples for other games
"C:\Server\Counter-Strike Source\srcds.exe" -console -game cstrike +map de_dust2
"C:\Server\Team Fortress 2\srcds.exe" -console -game tf +map cp_dustbowl

==Updating SRCDS==
Close all running SRCDS servers and run '''steamcmd_run.bat'''
 
 
 
 
----

--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 08:05, 30 March 2020 (CDT)

[[Category:SourceMod for beginners]]

Category:SourceMod for beginners

2020-03-30T12:58:45Z

Bacardi: hidden template broken. removing it.

:::{{Alert||'''This page is under construction''' --[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 07:58, 30 March 2020 (CDT)}}

= '''Welcome new users!''' =
This page is helping '''beginners''' who have no experience, to set up and start testing [https://www.sourcemod.net/ SourceMod] addon in own home PC (Windows). 
- Some configuration (cvars, admins, etc. etc.) 
- Tricks and Tips to start scripting own plugins
 
Me [[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]), I try to guide you and add more content in here wiki when possible with my terrible english. 
About games, we focus some popular games which have bots included. Such as Counter-Strike: Source, Counter-Strike: Global Offensive (free game), Team Fortress 2 (free game!)
----

'''Installation'''

*[[Setting up a Source Dedicated Server (Windows)]]
*[[Installing MetaMod:Source and SourceMod (Windows)]]
*[[Setting up a Notepad++ (SourceMod)]]

'''Problem solving''' 
{{Note|{{color|red|Problem to launch the game while using srcds.}}}}
Such as CS:GO game. Go game directory and find '''csgo.exe''' program (or HL2.exe). 
Create shortcut of program and add launch parameter '''-steam'''. Use shortcut instead Steam/Games window 
<code>"C:\Program Files (x86)\steam\steamapps\common\Counter-Strike Global Offensive\csgo.exe" -steam</code>
:[https://youtu.be/t1fYp98FGH8?list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube Video]

...more content coming someday.
 

[[Category:SourceMod Documentation]]

User Messages

2018-12-30T23:53:59Z

Bacardi: added link, csgo usermessage page

This is just a dump of some stuff for now, needs a complete revamp later.
Here's a topic on the subject as well: https://forums.alliedmods.net/showthread.php?t=80256 and here http://forums.alliedmods.net/showthread.php?t=52777

{{Note| Protobuf [[Counter-Strike:_Global_Offensive_UserMessages]]}}

=== Counter-Strike: Source User Messages ===
List obtained by using 'meta game' in the console

User Messages: Name Index Size
Geiger 0 1
Train 1 1
HudText 2 -1
SayText 3 -1
SayText2 4 -1
TextMsg 5 -1
HudMsg 6 -1
ResetHUD 7 1
GameTitle 8 0
ItemPickup 9 -1
ShowMenu 10 -1
Shake 11 13
Fade 12 10
VGUIMenu 13 -1
Rumble 14 3
CloseCaption 15 -1
SendAudio 16 -1
RawAudio 17 -1
VoiceMask 18 25
RequestState 19 0
BarTime 20 -1
Damage 21 -1
RadioText 22 -1
HintText 23 -1
KeyHintText 24 -1
ReloadEffect 25 2
PlayerAnimEvent 26 -1
AmmoDenied 27 2
UpdateRadar 28 -1
KillCam 29 -1
MarkAchievement 30 -1
CallVoteFailed 31 -1
VoteStart 32 -1
VotePass 33 -1
VoteFailed 34 2
VoteSetup 35 -1
SPHapWeapEvent 36 4
HapDmg 37 -1
HapPunch 38 -1
HapSetDrag 39 -1
HapSetConst 40 -1
HapMeleeContact 41 0
PlayerStatsUpdate_DEPRECATED 42 -1
AchievementEvent 43 -1
MatchEndConditions 44 -1
MatchStatsUpdate 45 -1
PlayerStatsUpdate 46 -1
47 user messages in total

=== Left 4 Dead 2 User Messages ===

For vote specific user messages see http://wiki.alliedmods.net/Left_4_Voting_2

User Messages: Name Index Size Parameter types
SayText2 4 -1
TextMsg 5 -1
HudMsg 6 -1
ResetHUD 7 1
GameTitle 8 0
ItemPickup 9 -1
ShowMenu 10 -1
Shake 11 13
Fade 12 10
VGUIMenu 13 -1 string, bool, string (keyvalues)
Rumble 14 3
CloseCaption 15 -1
CloseCaptionDirect 16 -1
SendAudio 17 -1
RawAudio 18 -1
VoiceMask 19 9
RequestState 20 0
BarTime 21 -1
Damage 22 -1
RadioText 23 -1
HintText 24 -1
KeyHintText 25 -1
ReloadEffect 26 4
PlayerAnimEvent 27 -1
AmmoDenied 28 2
UpdateRadar 29 -1
KillCam 30 -1
MarkAchievement 31 -1
Splatter 32 1
MeleeSlashSplatter 33 1
MeleeClubSplatter 34 1
MudSplatter 35 1
SplatterClear 36 0
MessageText 37 -1
TransitionRestore 38 0
Spawn 39 1
CreditsLine 40 -1
CreditsMsg 41 0
JoinLateMsg 42 0
StatsCrawlMsg 43 0
StatsSkipState 44 2
ShowStats 45 -1
BlurFade 46 0
MusicCmd 47 -1
WitchBloodSplatter 48 -1 vec[3]
AchievementEvent 49 -1
PZDmgMsg 50 -1
AllPlayersConnectedGameStarting 51 0
VoteRegistered 52 1
DisconnectToLobby 53 0 empty
CallVoteFailed 54 1
SteamWeaponStatData 55 -1
CurrentTimescale 56 4
DesiredTimescale 57 16
PZEndGamePanelMsg 58 1
PZEndGamePanelVoteRegisteredMsg 59 1
PZEndGameVoteStatsMsg 60 8
VoteStart 61 -1
VotePass 62 -1
VoteFail 63 1

=== Team Fortress 2 User Messages ===

User Messages: Name Index Size
Geiger 0 1
Train 1 1
HudText 2 -1
SayText 3 -1
SayText2 4 -1
TextMsg 5 -1
ResetHUD 6 1
GameTitle 7 0
ItemPickup 8 -1
ShowMenu 9 -1
Shake 10 13
Fade 11 10
VGUIMenu 12 -1
Rumble 13 3
CloseCaption 14 -1
SendAudio 15 -1
VoiceMask 16 17
RequestState 17 0
Damage 18 -1
HintText 19 -1
KeyHintText 20 -1
HudMsg 21 -1
AmmoDenied 22 2
AchievementEvent 23 -1
UpdateRadar 24 -1
VoiceSubtitle 25 3
HudNotify 26 2
HudNotifyCustom 27 -1
PlayerStatsUpdate 28 -1
MapStatsUpdate 29 -1
PlayerIgnited 30 3
PlayerIgnitedInv 31 3
HudArenaNotify 32 2
UpdateAchievement 33 -1
TrainingMsg 34 -1
TrainingObjective 35 -1
DamageDodged 36 -1
PlayerJarated 37 2
PlayerExtinguished 38 2
PlayerJaratedFade 39 2
PlayerShieldBlocked 40 2
BreakModel 41 -1
CheapBreakModel 42 -1
BreakModel_Pumpkin 43 -1
BreakModelRocketDud 44 -1
CallVoteFailed 45 -1
VoteStart 46 -1
VotePass 47 -1
VoteFailed 48 2
VoteSetup 49 -1
PlayerBonusPoints 50 3
RDTeamPointsChanged 51 4
SpawnFlyingBird 52 -1
PlayerGodRayEffect 53 -1
PlayerTeleportHomeEffect 54 -1
MVMStatsReset 55 -1
MVMPlayerEvent 56 -1
MVMResetPlayerStats 57 -1
MVMWaveFailed 58 0
MVMAnnouncement 59 2
MVMPlayerUpgradedEvent 60 9
MVMVictory 61 2
MVMWaveChange 62 15
MVMLocalPlayerUpgradesClear 63 1
MVMLocalPlayerUpgradesValue 64 6
MVMResetPlayerWaveSpendingStats 65 1
MVMLocalPlayerWaveSpendingValue 66 12
MVMResetPlayerUpgradeSpending 67 -1
MVMServerKickTimeUpdate 68 1
PlayerLoadoutUpdated 69 -1
PlayerTauntSoundLoopStart 70 -1
PlayerTauntSoundLoopEnd 71 -1
ForcePlayerViewAngles 72 -1
BonusDucks 73 2
EOTLDuckEvent 74 7
PlayerPickupWeapon 75 -1
QuestObjectiveCompleted 76 14
SPHapWeapEvent 77 4
HapDmg 78 -1
HapPunch 79 -1
HapSetDrag 80 -1
HapSetConst 81 -1
HapMeleeContact 82 0

=== Fade Flags ===
These may not be correct...

FFADE_IN 0x0001 // Just here so we don't pass 0 into the function
FFADE_OUT 0x0002 // Fade out (not in)
FFADE_MODULATE 0x0004 // Modulate (don't blend)
FFADE_STAYOUT 0x0008 // ignores the duration, stays faded out until new ScreenFade message received
FFADE_PURGE 0x0010 // Purges all other fades, replacing them with this one

=== Fade Function ===
Example Fade function (be sure to define the Fade Flags!)

This Fades the clients screen to a specified color, and stays until you reset the color to {0,0,0,0}

To modify it to Fade the screen for a certain amount of time, remove the STAYOUT flag, and pass a value to "fade & hold"

PerformFade(target, 500, {0, 128, 255, 51})

PerformFade(client, duration, const color[4]) {
new Handle:hFadeClient=StartMessageOne("Fade",client)
BfWriteShort(hFadeClient,duration) // FIXED 16 bit, with SCREENFADE_FRACBITS fractional, milliseconds duration
BfWriteShort(hFadeClient,0) // FIXED 16 bit, with SCREENFADE_FRACBITS fractional, milliseconds duration until reset (fade & hold)
BfWriteShort(hFadeClient,(FFADE_PURGE|FFADE_OUT|FFADE_STAYOUT)) // fade type (in / out)
BfWriteByte(hFadeClient,color[0]) // fade red
BfWriteByte(hFadeClient,color[1]) // fade green
BfWriteByte(hFadeClient,color[2]) // fade blue
BfWriteByte(hFadeClient,color[3]) // fade alpha
EndMessage()
}

=== HudMsg Function ===
This does not work in CS:S.

This Draws a text Message to a specified players screen. This is just for educational purposes and there is a much easier way of doing this with native functions here: [https://sm.alliedmods.net/new-api/halflife/ShowHudText ShowHudText] & [https://sm.alliedmods.net/new-api/halflife/SetHudTextParams SetHudTextParams]

PerformHudMsg(client, "This is a Test")

PerformHudMsg(client, const String:szMsg[]) {
new Handle:hBf = StartMessageOne("HudMsg", client)
BfWriteByte(hBf, 3) //channel
BfWriteFloat(hBf, 0.0); // x ( -1 = center )
BfWriteFloat(hBf, -1); // y ( -1 = center )
// second color
BfWriteByte(hBf, 0); //r1
BfWriteByte(hBf, 0); //g1
BfWriteByte(hBf, 255); //b1
BfWriteByte(hBf, 255); //a1 // transparent?
// init color
BfWriteByte(hBf, 255); //r2
BfWriteByte(hBf, 0); //g2
BfWriteByte(hBf, 0); //b2
BfWriteByte(hBf, 255); //a2
BfWriteByte(hBf, 0); //effect (0 is fade in/fade out; 1 is flickery credits; 2 is write out)
BfWriteFloat(hBf, 1.0); //fadeinTime (message fade in time - per character in effect 2)
BfWriteFloat(hBf, 1.0); //fadeoutTime
BfWriteFloat(hBf, 15.0); //holdtime
BfWriteFloat(hBf, 5.0); //fxtime (effect type(2) used)
BfWriteString(hBf, szMsg); //Message
EndMessage();
}

=== HookUserMessage Fade ===
Some sample code to hook a UserMessage, In this case Fade.
You cannot send other UserMessages inside of a UserMessage Hook. Many simple functions such as PrintToChat call UserMessages.

public OnPluginStart() {
HookUserMessage(GetUserMessageId("Fade"),HookFade,true)
}

public Action:HookFade(UserMsg:msg_id, Handle:bf, const players[], playersNum, bool:reliable, bool:init) {
new duration = BfReadShort(bf)
new holdtime = BfReadShort(bf)
BfReadShort(bf) //You must read all of the bf values, even If you only want the last value such as this one.
new r = BfReadByte(bf) //You do NOT need to store their value though.
new g = BfReadByte(bf)
new b = BfReadByte(bf)
new a = BfReadByte(bf)

PrintToServer("Duration: %i, HoldTime: %i, rgba: %i %i %i %i",duration,holdtime,r,g,b,a)
}

[[Category:SourceMod Scripting]]

Category:SourceMod for beginners

2018-12-24T20:59:12Z

Bacardi:

:::{{Alert||'''This page is under construction''' --[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 17:13, 21 November 2018 (CST)}}

= '''Welcome new users!''' =
This page is helping '''beginners''' who have no experience, to set up and start testing [https://www.sourcemod.net/ SourceMod] addon in own home PC (Windows). 
- Some configuration (cvars, admins, etc. etc.) 
- Tricks and Tips to start scripting own plugins
 
Me [[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]), I try to guide you and add more content in here wiki when possible with my terrible english. 
About games, we focus some popular games which have bots included. Such as Counter-Strike: Source, Counter-Strike: Global Offensive (free game), Team Fortress 2 (free game!)
----

'''Installation'''

*[[Setting up a Source Dedicated Server (Windows)]]
*[[Installing MetaMod:Source and SourceMod (Windows)]]
*[[Setting up a Notepad++ (SourceMod)]]

'''Problem solving'''
{{Note|{{color|red|Problem to launch the game while using srcds.}} {{hidden|id=Problem_00|label=Click me!|
Such as CS:GO game. Go game directory and find '''csgo.exe''' program (or HL2.exe). 
Create shortcut of program and add launch parameter '''-steam'''. Use shortcut instead Steam/Games window 
<code>"C:\Program Files (x86)\steam\steamapps\common\Counter-Strike Global Offensive\csgo.exe" -steam</code>}}}}
:[https://youtu.be/t1fYp98FGH8?list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube Video]

...more content coming someday.
 

[[Category:SourceMod Documentation]]

Category:SourceMod for beginners

2018-12-16T09:36:37Z

Bacardi:

Category:SourceMod for beginners

2018-11-21T23:13:27Z

Bacardi: timestamp

:::{{Alert||'''This page is under construction''' --[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 17:13, 21 November 2018 (CST)}}

= '''Welcome new users!''' =
This page is helping '''beginners''' who have no experience, to set up and start testing [https://www.sourcemod.net/ SourceMod] addon in own home PC (Windows). 
- Some configuration (cvars, admins, etc. etc.) 
- Tricks and Tips to start scripting own plugins
 
Me [[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]), I try to guide you and add more content in here wiki when possible with my terrible english. 
About games, we focus some popular games which have bots included. Such as Counter-Strike: Source, Counter-Strike: Global Offensive, Team Fortress 2 (free game!)
----

'''Installation'''

*[[Setting up a Source Dedicated Server (Windows)]]
*[[Installing MetaMod:Source and SourceMod (Windows)]]
*[[Setting up a Notepad++ (SourceMod)]]

'''Problem solving'''
{{Note|{{color|red|Problem to launch the game while using srcds.}} {{hidden|id=Problem_00|label=Click me!|
Such as CS:GO game. Go game directory and find '''csgo.exe''' program (or HL2.exe). 
Create shortcut of program and add launch parameter '''-steam'''. Use shortcut instead Steam/Games window 
<code>"C:\Program Files (x86)\steam\steamapps\common\Counter-Strike Global Offensive\csgo.exe" -steam</code>}}}}
:[https://youtu.be/t1fYp98FGH8?list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube Video]

...more content coming someday.

Setting up a Notepad++ (SourceMod)

2018-11-21T23:12:06Z

Bacardi: YouTube video

This is guide to setting up NotePad++ 
Install '''Notepad++ 32-bit x86''' text editor 
:https://notepad-plus-plus.org/download/ 
 
__TOC__
[https://youtu.be/RZ_sv6DtLQ8?list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube Video Setting up a Notepad++ (SourceMod) - Wiki guide]
==SourcePawn syntax highlight & autocompletion==

Download '''npp-docs zip''' file 
:https://github.com/raziEiL/SourceMod-Npp-Docs/releases 
and extract files on your desktop. 
 
Move '''sourcemod.xml''' file into Notepad++ ...plugins\APIs folder
C:\Program Files (x86)\notepad++\plugins\APIs\sourcemod.xml
 
Open Notepad++ and select Language -> Define your language... 
Select Import...
and open '''userDefineLang.xml''' file 
 
Restart Notepad++
 

==Plugin NppExec==

Install NppExec Notepad++ plugin (manually or through Plugin Manager). 
:https://sourceforge.net/projects/npp-plugins/files/NppExec/ 
C:\Program Files (x86)\notepad++\plugins\NppExec\NppExec.dll
Restart NotePad++ 
 
Choose Plugins -> NppExec -> Execute... (F6) 
Add this script:
NPP_SAVE
cd "$(CURRENT_DIRECTORY)"
spcomp.exe "$(FILE_NAME)"
cmd /q /c move "$(CURRENT_DIRECTORY)\$(NAME_PART).smx" "$(CURRENT_DIRECTORY)\..\plugins\$(NAME_PART).smx"
Save -> name it ''sourcemod'' -> Save 
 
 
Choose Plugins -> NppExec -> Console Output Filters... (Shift+F6) 
{| border="1"
|✔️||%FILE%(%LINE%) : error *||0x99||0x00||0x00||B
|-
|✔️||%FILE%(%LINE%) : warning *||0x00||0x50||0x99||I
|}
 
 
Choose Plugins -> NppExec -> NppExec Advanced Options... 
Select ''Associated scipt: sourcemod'', then click ''Add/Modify'' button. Ok and restart Notepad++
 
 
Choose Settings -> Shortcut Mapper... and go ''Plugin Commands'' tab. 
Find and clear ''Execute... = F6'' button. 
Find ''sourcemod ='' and Modify ''F6'' button in this line.

==Testing compiling Sourcemod plugin==
Go SourceMod scripting folder, where you find *.sp files. 
Make copy of any file for testing purpose and open it with NotePad++. 
When you hit F6 key, NotePad++ should:
*Save your file
*Run CMD and compile current *.sp file to *.smx
*Move compiled *.smx file from scripting folder to SourceMod plugins folder.

----
--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 08:47, 21 November 2018 (CST)

[[Category:SourceMod for beginners]]

Setting up a Notepad++ (SourceMod)

2018-11-21T23:07:49Z

Bacardi: /* Plugin NppExec */

This is guide to setting up NotePad++ 
Install '''Notepad++ 32-bit x86''' text editor 
:https://notepad-plus-plus.org/download/ 
 
__TOC__

==SourcePawn syntax highlight & autocompletion==

Download '''npp-docs zip''' file 
:https://github.com/raziEiL/SourceMod-Npp-Docs/releases 
and extract files on your desktop. 
 
Move '''sourcemod.xml''' file into Notepad++ ...plugins\APIs folder
C:\Program Files (x86)\notepad++\plugins\APIs\sourcemod.xml
 
Open Notepad++ and select Language -> Define your language... 
Select Import...
and open '''userDefineLang.xml''' file 
 
Restart Notepad++
 

==Plugin NppExec==

Install NppExec Notepad++ plugin (manually or through Plugin Manager). 
:https://sourceforge.net/projects/npp-plugins/files/NppExec/ 
C:\Program Files (x86)\notepad++\plugins\NppExec\NppExec.dll
Restart NotePad++ 
 
Choose Plugins -> NppExec -> Execute... (F6) 
Add this script:
NPP_SAVE
cd "$(CURRENT_DIRECTORY)"
spcomp.exe "$(FILE_NAME)"
cmd /q /c move "$(CURRENT_DIRECTORY)\$(NAME_PART).smx" "$(CURRENT_DIRECTORY)\..\plugins\$(NAME_PART).smx"
Save -> name it ''sourcemod'' -> Save 
 
 
Choose Plugins -> NppExec -> Console Output Filters... (Shift+F6) 
{| border="1"
|✔️||%FILE%(%LINE%) : error *||0x99||0x00||0x00||B
|-
|✔️||%FILE%(%LINE%) : warning *||0x00||0x50||0x99||I
|}
 
 
Choose Plugins -> NppExec -> NppExec Advanced Options... 
Select ''Associated scipt: sourcemod'', then click ''Add/Modify'' button. Ok and restart Notepad++
 
 
Choose Settings -> Shortcut Mapper... and go ''Plugin Commands'' tab. 
Find and clear ''Execute... = F6'' button. 
Find ''sourcemod ='' and Modify ''F6'' button in this line.

==Testing compiling Sourcemod plugin==
Go SourceMod scripting folder, where you find *.sp files. 
Make copy of any file for testing purpose and open it with NotePad++. 
When you hit F6 key, NotePad++ should:
*Save your file
*Run CMD and compile current *.sp file to *.smx
*Move compiled *.smx file from scripting folder to SourceMod plugins folder.

----
--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 08:47, 21 November 2018 (CST)

[[Category:SourceMod for beginners]]

Setting up a Notepad++ (SourceMod)

2018-11-21T22:34:04Z

Bacardi: /* Plugin NppExec */

This is guide to setting up NotePad++ 
Install '''Notepad++ 32-bit x86''' text editor 
:https://notepad-plus-plus.org/download/ 
 
__TOC__

==SourcePawn syntax highlight & autocompletion==

Download '''npp-docs zip''' file 
:https://github.com/raziEiL/SourceMod-Npp-Docs/releases 
and extract files on your desktop. 
 
Move '''sourcemod.xml''' file into Notepad++ ...plugins\APIs folder
C:\Program Files (x86)\notepad++\plugins\APIs\sourcemod.xml
 
Open Notepad++ and select Language -> Define your language... 
Select Import...
and open '''userDefineLang.xml''' file 
 
Restart Notepad++
 

==Plugin NppExec==

Install NppExec Notepad++ plugin. 
:https://sourceforge.net/projects/npp-plugins/files/NppExec/ 
C:\Program Files (x86)\notepad++\plugins\NppExec\NppExec.dll
Restart NotePad++ 
 
Choose Plugins -> NppExec -> Execute... (F6) 
Add this script:
NPP_SAVE
cd "$(CURRENT_DIRECTORY)"
spcomp.exe "$(FILE_NAME)"
cmd /q /c move "$(CURRENT_DIRECTORY)\$(NAME_PART).smx" "$(CURRENT_DIRECTORY)\..\plugins\$(NAME_PART).smx"
Save -> name it ''sourcemod'' -> Save 
 
 
Choose Plugins -> NppExec -> Console Output Filters... (Shift+F6) 
{| border="1"
|✔️||%FILE%(%LINE%) : error *||0x99||0x00||0x00||B
|-
|✔️||%FILE%(%LINE%) : warning *||0x00||0x50||0x99||I
|}
 
 
Choose Plugins -> NppExec -> NppExec Advanced Options... 
Select ''Associated scipt: sourcemod'', then click ''Add/Modify'' button. Ok and restart Notepad++
 
 
Choose Settings -> Shortcut Mapper... and go ''Plugin Commands'' tab. 
Find and clear ''Execute... = F6'' button. 
Find ''sourcemod ='' and Modify ''F6'' button in this line.

==Testing compiling Sourcemod plugin==
Go SourceMod scripting folder, where you find *.sp files. 
Make copy of any file for testing purpose and open it with NotePad++. 
When you hit F6 key, NotePad++ should:
*Save your file
*Run CMD and compile current *.sp file to *.smx
*Move compiled *.smx file from scripting folder to SourceMod plugins folder.

----
--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 08:47, 21 November 2018 (CST)

[[Category:SourceMod for beginners]]

Setting up a Notepad++ (SourceMod)

2018-11-21T22:32:03Z

Bacardi: /* Plugin NppExec */

This is guide to setting up NotePad++ 
Install '''Notepad++ 32-bit x86''' text editor 
:https://notepad-plus-plus.org/download/ 
 
__TOC__

==SourcePawn syntax highlight & autocompletion==

Download '''npp-docs zip''' file 
:https://github.com/raziEiL/SourceMod-Npp-Docs/releases 
and extract files on your desktop. 
 
Move '''sourcemod.xml''' file into Notepad++ ...plugins\APIs folder
C:\Program Files (x86)\notepad++\plugins\APIs\sourcemod.xml
 
Open Notepad++ and select Language -> Define your language... 
Select Import...
and open '''userDefineLang.xml''' file 
 
Restart Notepad++
 

==Plugin NppExec==

Install NppExec Notepad++ plugin. 
:https://sourceforge.net/projects/npp-plugins/files/NppExec/ 
C:\Program Files (x86)\notepad++\plugins\NppExec.dll
Restart NotePad++ 
 
Choose Plugins -> NppExec -> Execute... (F6) 
Add this script:
NPP_SAVE
cd "$(CURRENT_DIRECTORY)"
spcomp.exe "$(FILE_NAME)"
cmd /q /c move "$(CURRENT_DIRECTORY)\$(NAME_PART).smx" "$(CURRENT_DIRECTORY)\..\plugins\$(NAME_PART).smx"
Save -> name it ''sourcemod'' -> Save 
 
 
Choose Plugins -> NppExec -> Console Output Filters... (Shift+F6) 
{| border="1"
|✔️||%FILE%(%LINE%) : error *||0x99||0x00||0x00||B
|-
|✔️||%FILE%(%LINE%) : warning *||0x00||0x50||0x99||I
|}
 
 
Choose Plugins -> NppExec -> NppExec Advanced Options... 
Select ''Associated scipt: sourcemod'', then click ''Add/Modify'' button. Ok and restart Notepad++
 
 
Choose Settings -> Shortcut Mapper... and go ''Plugin Commands'' tab. 
Find and clear ''Execute... = F6'' button. 
Find ''sourcemod ='' and Modify ''F6'' button in this line.

==Testing compiling Sourcemod plugin==
Go SourceMod scripting folder, where you find *.sp files. 
Make copy of any file for testing purpose and open it with NotePad++. 
When you hit F6 key, NotePad++ should:
*Save your file
*Run CMD and compile current *.sp file to *.smx
*Move compiled *.smx file from scripting folder to SourceMod plugins folder.

----
--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 08:47, 21 November 2018 (CST)

[[Category:SourceMod for beginners]]

Setting up a Notepad++ (SourceMod)

2018-11-21T14:47:35Z

Bacardi: I need improve this page.... later

This is guide to setting up NotePad++ 
Install '''Notepad++ 32-bit x86''' text editor 
:https://notepad-plus-plus.org/download/ 
 
__TOC__

==SourcePawn syntax highlight & autocompletion==

Download '''npp-docs zip''' file 
:https://github.com/raziEiL/SourceMod-Npp-Docs/releases 
and extract files on your desktop. 
 
Move '''sourcemod.xml''' file into Notepad++ ...plugins\APIs folder
C:\Program Files (x86)\notepad++\plugins\APIs\sourcemod.xml
 
Open Notepad++ and select Language -> Define your language... 
Select Import...
and open '''userDefineLang.xml''' file 
 
Restart Notepad++
 

==Plugin NppExec==

Install NppExec Notepad++ plugin. 
:https://sourceforge.net/projects/npp-plugins/files/NppExec/ 
C:\Program Files (x86)\notepad++\plugins\NppExec.dll
Restart NotePad++ 
 
Choose Plugins -> NppExec -> Execute... (F6) 
Add this script:
NPP_SAVE
cd "$(CURRENT_DIRECTORY)"
spcomp.exe $(FILE_NAME)
cmd /q /c move "$(CURRENT_DIRECTORY)\$(NAME_PART).smx" "$(CURRENT_DIRECTORY)\..\plugins\$(NAME_PART).smx"
Save -> name it ''sourcemod'' -> Save 
 
 
Choose Plugins -> NppExec -> Console Output Filters... (Shift+F6) 
{| border="1"
|✔️||%FILE%(%LINE%) : error *||0x99||0x00||0x00||B
|-
|✔️||%FILE%(%LINE%) : warning *||0x00||0x50||0x99||I
|}
 
 
Choose Plugins -> NppExec -> NppExec Advanced Options... 
Select ''Associated scipt: sourcemod'', then click ''Add/Modify'' button. Ok and restart Notepad++
 
 
Choose Settings -> Shortcut Mapper... and go ''Plugin Commands'' tab. 
Find and clear ''Execute... = F6'' button. 
Find ''sourcemod ='' and Modify ''F6'' button in this line.

==Testing compiling Sourcemod plugin==
Go SourceMod scripting folder, where you find *.sp files. 
Make copy of any file for testing purpose and open it with NotePad++. 
When you hit F6 key, NotePad++ should:
*Save your file
*Run CMD and compile current *.sp file to *.smx
*Move compiled *.smx file from scripting folder to SourceMod plugins folder.

----
--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 08:47, 21 November 2018 (CST)

[[Category:SourceMod for beginners]]

Installing MetaMod:Source and SourceMod (Windows)

2018-11-20T15:46:54Z

Bacardi: Rename youtube alt name

This is '''Quickstart guide''' - How install '''MetaMod:Source''' and '''SourceMod''' into Source Dedicated Server (Windows)
__TOC__
[https://www.youtube.com/watch?v=jqnnvIjH2WQ&index=4&list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube Video Installing MetaMod:Source and SourceMod - Wiki guide]
==Installing addons==
Download latest stable MM:S and SM zip packs (Windows version).
*https://www.sourcemm.net/downloads.php?branch=stable
*https://www.sourcemod.net/downloads.php?branch=stable
Extrack both zip files on your desktop, merging them into one.
 Move '''addons''' and '''cfg''' folders into SRCDS <game mod> folder. 
For example in Counter-Strike: Global Offensive dedicated server:
{| border="0"
|{{font|text=C:\Server\counter-strike global offensive\csgo\addons 
C:\Server\counter-strike global offensive\csgo\cfg|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
 

==Checking loaded addons & plugins==
Launch SRCDS.
Typing these server commands into console input:
{|
|style="padding-right:50px"|'''plugin_print'''||you see loaded addons
|-
|'''meta list'''||you see loaded MetaMod:Source plugins
|-
|'''sm exts list'''||you see loaded SourceMod extensions
|-
|'''sm plugins list'''||you see loaded SourceMod plugins
|}
{{Note|''To see example of commands output text, click Show ->''}}
{{hidden|id=last|contentonly=yes|label=none|content= 
plugin_print
Loaded plugins:
---------------------
0: "Metamod:Source 1.10.7-dev"
---------------------
meta list
Listing 3 plugins:
[01] SourceMod (1.9.0.6260) by AlliedModders LLC
[02] CS Tools (1.9.0.6260) by AlliedModders LLC
[03] SDK Tools (1.9.0.6260) by AlliedModders LLC
sm exts list
[SM] Displaying 8 extensions:
[01] Automatic Updater (1.9.0.6260): Updates SourceMod gamedata files
[02] Webternet (1.9.0.6260): Extension for interacting with URLs
[03] CS Tools (1.9.0.6260): CS extended functionality
[04] BinTools (1.9.0.6260): Low-level C/C++ Calling API
[05] SDK Tools (1.9.0.6260): Source SDK Tools
[06] Top Menus (1.9.0.6260): Creates sorted nested menus
[07] Client Preferences (1.9.0.6260): Saves client preference settings
[08] SQLite (1.9.0.6260): SQLite Driver
sm plugins list
[SM] Listing 17 plugins:
01 "Admin File Reader" (1.9.0.6260) by AlliedModders LLC
02 "Admin Help" (1.9.0.6260) by AlliedModders LLC
03 "Admin Menu" (1.9.0.6260) by AlliedModders LLC
04 "Anti-Flood" (1.9.0.6260) by AlliedModders LLC
05 "Basic Ban Commands" (1.9.0.6260) by AlliedModders LLC
06 "Basic Chat" (1.9.0.6260) by AlliedModders LLC
07 "Basic Comm Control" (1.9.0.6260) by AlliedModders LLC
08 "Basic Commands" (1.9.0.6260) by AlliedModders LLC
09 "Basic Info Triggers" (1.9.0.6260) by AlliedModders LLC
10 "Basic Votes" (1.9.0.6260) by AlliedModders LLC
11 "Client Preferences" (1.9.0.6260) by AlliedModders LLC
12 "Fun Commands" (1.9.0.6260) by AlliedModders LLC
13 "Fun Votes" (1.9.0.6260) by AlliedModders LLC
14 "Nextmap" (1.9.0.6260) by AlliedModders LLC
15 "Player Commands" (1.9.0.6260) by AlliedModders LLC
16 "Reserved Slots" (1.9.0.6260) by AlliedModders LLC
17 "Sound Commands" (1.9.0.6260) by AlliedModders LLC
 |contentclass=toccolours|contentcss="overflow: auto;"}}

==Upgrading addons==
Before upgrading files, close all running servers. 
:- If the server can not be shutdown (server reboot back up), find metamod.vdf file and move it out from addons folder. Server stop loading MM:S and SM addons after reboot.

Upgrading files, repeat again like in [[#Installing addons]]. 
But before moving files in server, delete these folders so you not lose your current configures/settings.
addons\sourcemod\configs\
cfg\sourcemod\
Launch server (or reboot) and check loaded addons [[#Checking loaded addons & plugins]]

----
--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 13:39, 18 November 2018 (CST)

[[Category:SourceMod for beginners]]

Setting up a Source Dedicated Server (Windows)

2018-11-20T15:45:01Z

Bacardi: Moved YouTube videos to top of page.

This is '''Quickstart guide''' - Setting up a '''Source Dedicated Server''' into your home PC (Windows version) using [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD tool].
__TOC__
[https://youtu.be/SF7lGzZM6Q0?list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube Video Installing SRCDS - Wiki guide] 
[https://youtu.be/3XC8RnpgDgo?list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube Video Launching SRCDS - Wiki guide]

==Installing SRCDS==
[[File:Steamcmd files.png|thumb|50px|none]]
Get '''SteamCMD tool''' ([https://steamcdn-a.akamaihd.net/client/installer/steamcmd.zip Download Link]), extract zip file and place '''steamcmd.exe''' in this directory structure.
{| border="0"
|-
|{{font|text=C:\server\steamcmd\steamcmd.exe|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
Open notepad.exe and create TXT file in same destination, named '''update.txt''' and create BATCH file named '''steamcmd_run.bat'''.
{| border="0"
|-
|{{font|text=C:\server\steamcmd\update.txt C:\server\steamcmd\steamcmd_run.bat|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
 
Inside '''steamcmd_run.bat''' file, save this script.
steamcmd.exe +runscript update.txt
 
Inside '''update.txt''' file, save this SteamCMD script
{{Note|''This script will now install multiple SRCDS (CS:GO, CS:S and TF2). Disable lines which you not want to install with double slash // or delete lines''}}

login anonymous

force_install_dir "../Counter-Strike Global Offensive"
app_update 740 validate

force_install_dir "../Counter-Strike Source"
app_update 232330 validate

{{color|green|//force_install_dir "../Half-Life 2 Deathmatch"
//app_update 232370 validate

//force_install_dir "../Day of Defeat Source"
//app_update 232290 validate}}

force_install_dir "../Team Fortress 2"
app_update 232250 validate

{{Note|''If some reason you fail to create these above files, you can download those from google drive {{hidden|id=last2|label=Hidden Link!|labelonly=yes}}''
{{hidden|id=last2|contentonly=yes|label=none|content=https://drive.google.com/open?id=1Hb81rG2D5exQlPz1icLVG3c6VtIwedGP}}}}
 
Run '''steamcmd_run.bat''' file, SteamCMD window should appear and start downloading files.
If everything is done right, you get SRCDS in C:\server\
 

==Launching SRCDS==
[[File:Launch script.png|thumb|50px|none]]
Find '''srcds.exe''' program from SRCDS game directory. For example in CS:GO mod:
{| border="0"
|-
|{{font|text=C:\server\Counter-Strike Global Offensive\srcds.exe|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
Create shortcut from '''srcds.exe''' and open shortcut properties. 
In shortcut properties Target: input, you see path to the program.
"C:\Server\counter-strike global offensive\srcds.exe"

*By adding parameter '''-console''', you run SRCDS without GUI
*Adding parameter '''-game''', you set <game mod> folder you are going to run
*Adding SRCDS command '''+map''', you start server with specific map. You find maps in ...<game mod>/maps/ folder
Example to run Counter-Strike: Global Offensive dedicated server
"C:\Server\counter-strike global offensive\srcds.exe" -console -game csgo +map de_dust2

Examples for other games
"C:\Server\Counter-Strike Source\srcds.exe" -console -game cstrike +map de_dust2
"C:\Server\Team Fortress 2\srcds.exe" -console -game tf +map cp_dustbowl

==Updating SRCDS==
Close all running SRCDS servers and run '''steamcmd_run.bat'''
 
 
 
 
----

--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 09:29, 17 November 2018 (CST)

[[Category:SourceMod for beginners]]

Installing MetaMod:Source and SourceMod (Windows)

2018-11-20T15:29:57Z

Bacardi: YouTube video

This is '''Quickstart guide''' - How install '''MetaMod:Source''' and '''SourceMod''' into Source Dedicated Server (Windows)
__TOC__
[https://www.youtube.com/watch?v=jqnnvIjH2WQ&index=4&list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube]
==Installing addons==
Download latest stable MM:S and SM zip packs (Windows version).
*https://www.sourcemm.net/downloads.php?branch=stable
*https://www.sourcemod.net/downloads.php?branch=stable
Extrack both zip files on your desktop, merging them into one.
 Move '''addons''' and '''cfg''' folders into SRCDS <game mod> folder. 
For example in Counter-Strike: Global Offensive dedicated server:
{| border="0"
|{{font|text=C:\Server\counter-strike global offensive\csgo\addons 
C:\Server\counter-strike global offensive\csgo\cfg|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
 

==Checking loaded addons & plugins==
Launch SRCDS.
Typing these server commands into console input:
{|
|style="padding-right:50px"|'''plugin_print'''||you see loaded addons
|-
|'''meta list'''||you see loaded MetaMod:Source plugins
|-
|'''sm exts list'''||you see loaded SourceMod extensions
|-
|'''sm plugins list'''||you see loaded SourceMod plugins
|}
{{Note|''To see example of commands output text, click Show ->''}}
{{hidden|id=last|contentonly=yes|label=none|content= 
plugin_print
Loaded plugins:
---------------------
0: "Metamod:Source 1.10.7-dev"
---------------------
meta list
Listing 3 plugins:
[01] SourceMod (1.9.0.6260) by AlliedModders LLC
[02] CS Tools (1.9.0.6260) by AlliedModders LLC
[03] SDK Tools (1.9.0.6260) by AlliedModders LLC
sm exts list
[SM] Displaying 8 extensions:
[01] Automatic Updater (1.9.0.6260): Updates SourceMod gamedata files
[02] Webternet (1.9.0.6260): Extension for interacting with URLs
[03] CS Tools (1.9.0.6260): CS extended functionality
[04] BinTools (1.9.0.6260): Low-level C/C++ Calling API
[05] SDK Tools (1.9.0.6260): Source SDK Tools
[06] Top Menus (1.9.0.6260): Creates sorted nested menus
[07] Client Preferences (1.9.0.6260): Saves client preference settings
[08] SQLite (1.9.0.6260): SQLite Driver
sm plugins list
[SM] Listing 17 plugins:
01 "Admin File Reader" (1.9.0.6260) by AlliedModders LLC
02 "Admin Help" (1.9.0.6260) by AlliedModders LLC
03 "Admin Menu" (1.9.0.6260) by AlliedModders LLC
04 "Anti-Flood" (1.9.0.6260) by AlliedModders LLC
05 "Basic Ban Commands" (1.9.0.6260) by AlliedModders LLC
06 "Basic Chat" (1.9.0.6260) by AlliedModders LLC
07 "Basic Comm Control" (1.9.0.6260) by AlliedModders LLC
08 "Basic Commands" (1.9.0.6260) by AlliedModders LLC
09 "Basic Info Triggers" (1.9.0.6260) by AlliedModders LLC
10 "Basic Votes" (1.9.0.6260) by AlliedModders LLC
11 "Client Preferences" (1.9.0.6260) by AlliedModders LLC
12 "Fun Commands" (1.9.0.6260) by AlliedModders LLC
13 "Fun Votes" (1.9.0.6260) by AlliedModders LLC
14 "Nextmap" (1.9.0.6260) by AlliedModders LLC
15 "Player Commands" (1.9.0.6260) by AlliedModders LLC
16 "Reserved Slots" (1.9.0.6260) by AlliedModders LLC
17 "Sound Commands" (1.9.0.6260) by AlliedModders LLC
 |contentclass=toccolours|contentcss="overflow: auto;"}}

==Upgrading addons==
Before upgrading files, close all running servers. 
:- If the server can not be shutdown (server reboot back up), find metamod.vdf file and move it out from addons folder. Server stop loading MM:S and SM addons after reboot.

Upgrading files, repeat again like in [[#Installing addons]]. 
But before moving files in server, delete these folders so you not lose your current configures/settings.
addons\sourcemod\configs\
cfg\sourcemod\
Launch server (or reboot) and check loaded addons [[#Checking loaded addons & plugins]]

----
--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 13:39, 18 November 2018 (CST)

[[Category:SourceMod for beginners]]

Category:SourceMod for beginners

2018-11-20T14:46:25Z

Bacardi: YouTube video

:::{{Alert||'''This page is under construction''' --[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 14:51, 18 November 2018 (CST)}}

= '''Welcome new users!''' =
This page is helping '''beginners''' who have no experience, to set up and start testing [https://www.sourcemod.net/ SourceMod] addon in own home PC (Windows). 
- Some configuration (cvars, admins, etc. etc.) 
- Tricks and Tips to start scripting own plugins
 
Me [[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]), I try to guide you and add more content in here wiki when possible with my terrible english. 
About games, we focus some popular games which have bots included. Such as Counter-Strike: Source, Counter-Strike: Global Offensive, Team Fortress 2 (free game!)
----

'''Installation'''

*[[Setting up a Source Dedicated Server (Windows)]]
*[[Installing MetaMod:Source and SourceMod (Windows)]]
*[[Setting up a Notepad++ (SourceMod)]]

'''Problem solving'''
{{Note|{{color|red|Problem to launch the game while using srcds.}} {{hidden|id=Problem_00|label=Click me!|
Such as CS:GO game. Go game directory and find '''csgo.exe''' program (or HL2.exe). 
Create shortcut of program and add launch parameter '''-steam'''. Use shortcut instead Steam/Games window 
<code>"C:\Program Files (x86)\steam\steamapps\common\Counter-Strike Global Offensive\csgo.exe" -steam</code>}}}}
:[https://youtu.be/t1fYp98FGH8?list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube Video]

...more content coming someday.

Setting up a Source Dedicated Server (Windows)

2018-11-20T14:15:22Z

Bacardi: /* Launching SRCDS */ YouTube Video

This is '''Quickstart guide''' - Setting up a '''Source Dedicated Server''' into your home PC (Windows version) using [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD tool].
__TOC__

==Installing SRCDS==
[[File:Steamcmd files.png|thumb|50px|none]] [https://youtu.be/SF7lGzZM6Q0?list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube Video]
Get '''SteamCMD tool''' ([https://steamcdn-a.akamaihd.net/client/installer/steamcmd.zip Download Link]), extract zip file and place '''steamcmd.exe''' in this directory structure.
{| border="0"
|-
|{{font|text=C:\server\steamcmd\steamcmd.exe|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
Open notepad.exe and create TXT file in same destination, named '''update.txt''' and create BATCH file named '''steamcmd_run.bat'''.
{| border="0"
|-
|{{font|text=C:\server\steamcmd\update.txt C:\server\steamcmd\steamcmd_run.bat|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
 
Inside '''steamcmd_run.bat''' file, save this script.
steamcmd.exe +runscript update.txt
 
Inside '''update.txt''' file, save this SteamCMD script
{{Note|''This script will now install multiple SRCDS (CS:GO, CS:S and TF2). Disable lines which you not want to install with double slash // or delete lines''}}

login anonymous

force_install_dir "../Counter-Strike Global Offensive"
app_update 740 validate

force_install_dir "../Counter-Strike Source"
app_update 232330 validate

{{color|green|//force_install_dir "../Half-Life 2 Deathmatch"
//app_update 232370 validate

//force_install_dir "../Day of Defeat Source"
//app_update 232290 validate}}

force_install_dir "../Team Fortress 2"
app_update 232250 validate

{{Note|''If some reason you fail to create these above files, you can download those from google drive {{hidden|id=last2|label=Hidden Link!|labelonly=yes}}''
{{hidden|id=last2|contentonly=yes|label=none|content=https://drive.google.com/open?id=1Hb81rG2D5exQlPz1icLVG3c6VtIwedGP}}}}
 
Run '''steamcmd_run.bat''' file, SteamCMD window should appear and start downloading files.
If everything is done right, you get SRCDS in C:\server\
 

==Launching SRCDS==
[[File:Launch script.png|thumb|50px|none]][https://youtu.be/3XC8RnpgDgo?list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube Video]
Find '''srcds.exe''' program from SRCDS game directory. For example in CS:GO mod:
{| border="0"
|-
|{{font|text=C:\server\Counter-Strike Global Offensive\srcds.exe|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
Create shortcut from '''srcds.exe''' and open shortcut properties. 
In shortcut properties Target: input, you see path to the program.
"C:\Server\counter-strike global offensive\srcds.exe"

*By adding parameter '''-console''', you run SRCDS without GUI
*Adding parameter '''-game''', you set <game mod> folder you are going to run
*Adding SRCDS command '''+map''', you start server with specific map. You find maps in ...<game mod>/maps/ folder
Example to run Counter-Strike: Global Offensive dedicated server
"C:\Server\counter-strike global offensive\srcds.exe" -console -game csgo +map de_dust2

Examples for other games
"C:\Server\Counter-Strike Source\srcds.exe" -console -game cstrike +map de_dust2
"C:\Server\Team Fortress 2\srcds.exe" -console -game tf +map cp_dustbowl

==Updating SRCDS==
Close all running SRCDS servers and run '''steamcmd_run.bat'''
 
 
 
 
----

--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 09:29, 17 November 2018 (CST)

[[Category:SourceMod for beginners]]

Setting up a Source Dedicated Server (Windows)

2018-11-20T13:49:33Z

Bacardi: /* Installing SRCDS */ YouTube Video

This is '''Quickstart guide''' - Setting up a '''Source Dedicated Server''' into your home PC (Windows version) using [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD tool].
__TOC__

==Installing SRCDS==
[[File:Steamcmd files.png|thumb|50px|none]] [https://youtu.be/SF7lGzZM6Q0?list=PLDz5Z5KigHNV0QDPeO3bCl09GblHV0pX0 YouTube Video]
Get '''SteamCMD tool''' ([https://steamcdn-a.akamaihd.net/client/installer/steamcmd.zip Download Link]), extract zip file and place '''steamcmd.exe''' in this directory structure.
{| border="0"
|-
|{{font|text=C:\server\steamcmd\steamcmd.exe|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
Open notepad.exe and create TXT file in same destination, named '''update.txt''' and create BATCH file named '''steamcmd_run.bat'''.
{| border="0"
|-
|{{font|text=C:\server\steamcmd\update.txt C:\server\steamcmd\steamcmd_run.bat|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
 
Inside '''steamcmd_run.bat''' file, save this script.
steamcmd.exe +runscript update.txt
 
Inside '''update.txt''' file, save this SteamCMD script
{{Note|''This script will now install multiple SRCDS (CS:GO, CS:S and TF2). Disable lines which you not want to install with double slash // or delete lines''}}

login anonymous

force_install_dir "../Counter-Strike Global Offensive"
app_update 740 validate

force_install_dir "../Counter-Strike Source"
app_update 232330 validate

{{color|green|//force_install_dir "../Half-Life 2 Deathmatch"
//app_update 232370 validate

//force_install_dir "../Day of Defeat Source"
//app_update 232290 validate}}

force_install_dir "../Team Fortress 2"
app_update 232250 validate

{{Note|''If some reason you fail to create these above files, you can download those from google drive {{hidden|id=last2|label=Hidden Link!|labelonly=yes}}''
{{hidden|id=last2|contentonly=yes|label=none|content=https://drive.google.com/open?id=1Hb81rG2D5exQlPz1icLVG3c6VtIwedGP}}}}
 
Run '''steamcmd_run.bat''' file, SteamCMD window should appear and start downloading files.
If everything is done right, you get SRCDS in C:\server\
 

==Launching SRCDS==
[[File:Launch script.png|thumb|50px|none]]
Find '''srcds.exe''' program from SRCDS game directory. For example in CS:GO mod:
{| border="0"
|-
|{{font|text=C:\server\Counter-Strike Global Offensive\srcds.exe|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
Create shortcut from '''srcds.exe''' and open shortcut properties. 
In shortcut properties Target: input, you see path to the program.
"C:\Server\counter-strike global offensive\srcds.exe"

*By adding parameter '''-console''', you run SRCDS without GUI
*Adding parameter '''-game''', you set <game mod> folder you are going to run
*Adding SRCDS command '''+map''', you start server with specific map. You find maps in ...<game mod>/maps/ folder
Example to run Counter-Strike: Global Offensive dedicated server
"C:\Server\counter-strike global offensive\srcds.exe" -console -game csgo +map de_dust2

Examples for other games
"C:\Server\Counter-Strike Source\srcds.exe" -console -game cstrike +map de_dust2
"C:\Server\Team Fortress 2\srcds.exe" -console -game tf +map cp_dustbowl

==Updating SRCDS==
Close all running SRCDS servers and run '''steamcmd_run.bat'''
 
 
 
 
----

--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 09:29, 17 November 2018 (CST)

[[Category:SourceMod for beginners]]

Category:SourceMod for beginners

2018-11-19T18:03:50Z

Bacardi: link to new page

Setting up a Source Dedicated Server (Windows)

2018-11-19T00:08:41Z

Bacardi: remove color and icon

This is '''Quickstart guide''' - Setting up a '''Source Dedicated Server''' into your home PC (Windows version) using [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD tool].
__TOC__

==Installing SRCDS==
[[File:Steamcmd files.png|thumb|50px|none]]
Get '''SteamCMD tool''' ([https://steamcdn-a.akamaihd.net/client/installer/steamcmd.zip Download Link]), extract zip file and place '''steamcmd.exe''' in this directory structure.
{| border="0"
|-
|{{font|text=C:\server\steamcmd\steamcmd.exe|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
Open notepad.exe and create TXT file in same destination, named '''update.txt''' and create BATCH file named '''steamcmd_run.bat'''.
{| border="0"
|-
|{{font|text=C:\server\steamcmd\update.txt C:\server\steamcmd\steamcmd_run.bat|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
 
Inside '''steamcmd_run.bat''' file, save this script.
steamcmd.exe +runscript update.txt
 
Inside '''update.txt''' file, save this SteamCMD script
{{Note|''This script will now install multiple SRCDS (CS:GO, CS:S and TF2). Disable lines which you not want to install with double slash // or delete lines''}}

login anonymous

force_install_dir "../Counter-Strike Global Offensive"
app_update 740 validate

force_install_dir "../Counter-Strike Source"
app_update 232330 validate

{{color|green|//force_install_dir "../Half-Life 2 Deathmatch"
//app_update 232370 validate

//force_install_dir "../Day of Defeat Source"
//app_update 232290 validate}}

force_install_dir "../Team Fortress 2"
app_update 232250 validate

{{Note|''If some reason you fail to create these above files, you can download those from google drive {{hidden|id=last2|label=Hidden Link!|labelonly=yes}}''
{{hidden|id=last2|contentonly=yes|label=none|content=https://drive.google.com/open?id=1Hb81rG2D5exQlPz1icLVG3c6VtIwedGP}}}}
 
Run '''steamcmd_run.bat''' file, SteamCMD window should appear and start downloading files.
If everything is done right, you get SRCDS in C:\server\
 
==Launching SRCDS==
[[File:Launch script.png|thumb|50px|none]]
Find '''srcds.exe''' program from SRCDS game directory. For example in CS:GO mod:
{| border="0"
|-
|{{font|text=C:\server\Counter-Strike Global Offensive\srcds.exe|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
Create shortcut from '''srcds.exe''' and open shortcut properties. 
In shortcut properties Target: input, you see path to the program.
"C:\Server\counter-strike global offensive\srcds.exe"

*By adding parameter '''-console''', you run SRCDS without GUI
*Adding parameter '''-game''', you set <game mod> folder you are going to run
*Adding SRCDS command '''+map''', you start server with specific map. You find maps in ...<game mod>/maps/ folder
Example to run Counter-Strike: Global Offensive dedicated server
"C:\Server\counter-strike global offensive\srcds.exe" -console -game csgo +map de_dust2

Examples for other games
"C:\Server\Counter-Strike Source\srcds.exe" -console -game cstrike +map de_dust2
"C:\Server\Team Fortress 2\srcds.exe" -console -game tf +map cp_dustbowl

==Updating SRCDS==
Close all running SRCDS servers and run '''steamcmd_run.bat'''
 
 
 
 
----

--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 09:29, 17 November 2018 (CST)

[[Category:SourceMod for beginners]]

Category:SourceMod for beginners

2018-11-18T23:33:50Z

Bacardi: tweak

:::{{Alert||'''This page is under construction''' --[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 14:51, 18 November 2018 (CST)}}

= '''Welcome new users!''' =
This page is helping '''beginners''' who have no experience, to set up and start testing [https://www.sourcemod.net/ SourceMod] addon in own home PC (Windows). 
- Some configuration (cvars, admins, etc. etc.) 
- Tricks and Tips to start scripting own plugins
 
Me [[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]), I try to guide you and add more content in here wiki when possible with my terrible english. 
About games, we focus some popular games which have bots included. Such as Counter-Strike: Source, Counter-Strike: Global Offensive, Team Fortress 2 (free game!)
----

'''Installation'''

*[[Setting up a Source Dedicated Server (Windows)]]
*[[Installing MetaMod:Source and SourceMod (Windows)]]

'''Problem solving'''
{{Note|{{color|red|Problem to launch the game while using srcds.}} {{hidden|id=Problem_00|label=Click me!|
Such as CS:GO game. Go game directory and find '''csgo.exe''' program (or HL2.exe). 
Create shortcut of program and add launch parameter '''-steam'''. Use shortcut instead Steam/Games window 
<code>"C:\Program Files (x86)\steam\steamapps\common\Counter-Strike Global Offensive\csgo.exe" -steam</code>}}}}

...more content coming someday.

Installing MetaMod:Source and SourceMod (Windows)

2018-11-18T22:59:43Z

Bacardi: /* Installing addons */ tiny tweak

This is '''Quickstart guide''' - How install '''MetaMod:Source''' and '''SourceMod''' into Source Dedicated Server (Windows)
__TOC__
==Installing addons==
Download latest stable MM:S and SM zip packs (Windows version).
*https://www.sourcemm.net/downloads.php?branch=stable
*https://www.sourcemod.net/downloads.php?branch=stable
Extrack both zip files on your desktop, merging them into one.
 Move '''addons''' and '''cfg''' folders into SRCDS <game mod> folder. 
For example in Counter-Strike: Global Offensive dedicated server:
{| border="0"
|{{font|text=C:\Server\counter-strike global offensive\csgo\addons 
C:\Server\counter-strike global offensive\csgo\cfg|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
 

==Checking loaded addons & plugins==
Launch SRCDS.
Typing these server commands into console input:
{|
|style="padding-right:50px"|'''plugin_print'''||you see loaded addons
|-
|'''meta list'''||you see loaded MetaMod:Source plugins
|-
|'''sm exts list'''||you see loaded SourceMod extensions
|-
|'''sm plugins list'''||you see loaded SourceMod plugins
|}
{{Note|''To see example of commands output text, click Show ->''}}
{{hidden|id=last|contentonly=yes|label=none|content= 
plugin_print
Loaded plugins:
---------------------
0: "Metamod:Source 1.10.7-dev"
---------------------
meta list
Listing 3 plugins:
[01] SourceMod (1.9.0.6260) by AlliedModders LLC
[02] CS Tools (1.9.0.6260) by AlliedModders LLC
[03] SDK Tools (1.9.0.6260) by AlliedModders LLC
sm exts list
[SM] Displaying 8 extensions:
[01] Automatic Updater (1.9.0.6260): Updates SourceMod gamedata files
[02] Webternet (1.9.0.6260): Extension for interacting with URLs
[03] CS Tools (1.9.0.6260): CS extended functionality
[04] BinTools (1.9.0.6260): Low-level C/C++ Calling API
[05] SDK Tools (1.9.0.6260): Source SDK Tools
[06] Top Menus (1.9.0.6260): Creates sorted nested menus
[07] Client Preferences (1.9.0.6260): Saves client preference settings
[08] SQLite (1.9.0.6260): SQLite Driver
sm plugins list
[SM] Listing 17 plugins:
01 "Admin File Reader" (1.9.0.6260) by AlliedModders LLC
02 "Admin Help" (1.9.0.6260) by AlliedModders LLC
03 "Admin Menu" (1.9.0.6260) by AlliedModders LLC
04 "Anti-Flood" (1.9.0.6260) by AlliedModders LLC
05 "Basic Ban Commands" (1.9.0.6260) by AlliedModders LLC
06 "Basic Chat" (1.9.0.6260) by AlliedModders LLC
07 "Basic Comm Control" (1.9.0.6260) by AlliedModders LLC
08 "Basic Commands" (1.9.0.6260) by AlliedModders LLC
09 "Basic Info Triggers" (1.9.0.6260) by AlliedModders LLC
10 "Basic Votes" (1.9.0.6260) by AlliedModders LLC
11 "Client Preferences" (1.9.0.6260) by AlliedModders LLC
12 "Fun Commands" (1.9.0.6260) by AlliedModders LLC
13 "Fun Votes" (1.9.0.6260) by AlliedModders LLC
14 "Nextmap" (1.9.0.6260) by AlliedModders LLC
15 "Player Commands" (1.9.0.6260) by AlliedModders LLC
16 "Reserved Slots" (1.9.0.6260) by AlliedModders LLC
17 "Sound Commands" (1.9.0.6260) by AlliedModders LLC
 |contentclass=toccolours|contentcss="overflow: auto;"}}

==Upgrading addons==
Before upgrading files, close all running servers. 
:- If the server can not be shutdown (server reboot back up), find metamod.vdf file and move it out from addons folder. Server stop loading MM:S and SM addons after reboot.

Upgrading files, repeat again like in [[#Installing addons]]. 
But before moving files in server, delete these folders so you not lose your current configures/settings.
addons\sourcemod\configs\
cfg\sourcemod\
Launch server (or reboot) and check loaded addons [[#Checking loaded addons & plugins]]

----
--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 13:39, 18 November 2018 (CST)

[[Category:SourceMod for beginners]]

Category:SourceMod for beginners

2018-11-18T21:32:16Z

Bacardi: /* Welcome new users! */

:::{{Alert||'''This page is under construction''' --[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 14:51, 18 November 2018 (CST)}}

= '''Welcome new users!''' =
This page is helping '''beginners''' who have no experience, to set up and start testing [https://www.sourcemod.net/ SourceMod] addon in own home PC (Windows). 
- Some configuration (cvars, admins, etc. etc.) 
- Tricks and Tips to start scripting own plugins
 
Me [[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]), I try to guide you and add more content in here wiki when possible with my terrible english. 
About games, we focus some popular games which have bots included. Such as Counter-Strike: Source, Counter-Strike: Global Offensive, Team Fortress 2 (free game!)
----

'''Installation'''

*[[Setting up a Source Dedicated Server (Windows)]]
*[[Installing MetaMod:Source and SourceMod (Windows)]]
{{Note|Problem to launch the game while using srcds {{hidden|label=click me!|
Such as CS:GO game. Go game directory and find '''csgo.exe''' program. 
Create shortcut of program and add launch parameter '''-steam'''. Use shortcut instead Steam/Games window 
<code>"C:\Program Files (x86)\steam\steamapps\common\Counter-Strike Global Offensive\csgo.exe" -steam</code>}}}}

...more content coming someday.

Category:SourceMod for beginners

2018-11-18T21:31:10Z

Bacardi: adding note, problem to launch game while using srcds

:::{{Alert||'''This page is under construction''' --[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 14:51, 18 November 2018 (CST)}}

= '''Welcome new users!''' =
This page is helping '''beginners''' who have no experience, to set up and start testing [https://www.sourcemod.net/ SourceMod] addon in own home PC (Windows). 
- Some configuration (cvars, admins, etc. etc.) 
- Tricks and Tips to start scripting own plugins
 
Me [[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]), I try to guide you and add more content in here wiki when possible with my terrible english. 
About games, we focus some popular games which have bots included. Such as Counter-Strike: Source, Counter-Strike: Global Offensive, Team Fortress 2 (free game!)

'''Installation'''

*[[Setting up a Source Dedicated Server (Windows)]]
*[[Installing MetaMod:Source and SourceMod (Windows)]]
{{Note|Problem to launch the game while using srcds {{hidden|label=click me!|
Such as CS:GO game. Go game directory and find '''csgo.exe''' program. 
Create shortcut of program and add launch parameter '''-steam'''. Use shortcut instead Steam/Games window 
<code>"C:\Program Files (x86)\steam\steamapps\common\Counter-Strike Global Offensive\csgo.exe" -steam</code>}}}}

...more content coming someday.

Category:SourceMod for beginners

2018-11-18T20:51:11Z

Bacardi: new category

Installing MetaMod:Source and SourceMod (Windows)

2018-11-18T19:48:58Z

Bacardi: /* Upgrading addons */ missing hastag #

This is '''Quickstart guide''' - How install '''MetaMod:Source''' and '''SourceMod''' into Source Dedicated Server (Windows)
__TOC__
==Installing addons==
Download latest stable MM:S and SM zip packs (Windows version).
*https://www.sourcemm.net/downloads.php?branch=stable
*https://www.sourcemod.net/downloads.php?branch=stable
Extrack both zip files on your desktop, merging them into one.
 Move '''addons''' and '''cfg''' folders into SRCDS <game mod> folder. 
For example in Counter-Strike: Global Offensive dedicated server:
{| border="0"
|-
|{{font|text=C:\Server\counter-strike global offensive\csgo\addons|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
{| border="0"
|-
|{{font|text=C:\Server\counter-strike global offensive\csgo\cfg|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
 
==Checking loaded addons & plugins==
Launch SRCDS.
Typing these server commands into console input:
{|
|style="padding-right:50px"|'''plugin_print'''||you see loaded addons
|-
|'''meta list'''||you see loaded MetaMod:Source plugins
|-
|'''sm exts list'''||you see loaded SourceMod extensions
|-
|'''sm plugins list'''||you see loaded SourceMod plugins
|}
{{Note|''To see example of commands output text, click Show ->''}}
{{hidden|id=last|contentonly=yes|label=none|content= 
plugin_print
Loaded plugins:
---------------------
0: "Metamod:Source 1.10.7-dev"
---------------------
meta list
Listing 3 plugins:
[01] SourceMod (1.9.0.6260) by AlliedModders LLC
[02] CS Tools (1.9.0.6260) by AlliedModders LLC
[03] SDK Tools (1.9.0.6260) by AlliedModders LLC
sm exts list
[SM] Displaying 8 extensions:
[01] Automatic Updater (1.9.0.6260): Updates SourceMod gamedata files
[02] Webternet (1.9.0.6260): Extension for interacting with URLs
[03] CS Tools (1.9.0.6260): CS extended functionality
[04] BinTools (1.9.0.6260): Low-level C/C++ Calling API
[05] SDK Tools (1.9.0.6260): Source SDK Tools
[06] Top Menus (1.9.0.6260): Creates sorted nested menus
[07] Client Preferences (1.9.0.6260): Saves client preference settings
[08] SQLite (1.9.0.6260): SQLite Driver
sm plugins list
[SM] Listing 17 plugins:
01 "Admin File Reader" (1.9.0.6260) by AlliedModders LLC
02 "Admin Help" (1.9.0.6260) by AlliedModders LLC
03 "Admin Menu" (1.9.0.6260) by AlliedModders LLC
04 "Anti-Flood" (1.9.0.6260) by AlliedModders LLC
05 "Basic Ban Commands" (1.9.0.6260) by AlliedModders LLC
06 "Basic Chat" (1.9.0.6260) by AlliedModders LLC
07 "Basic Comm Control" (1.9.0.6260) by AlliedModders LLC
08 "Basic Commands" (1.9.0.6260) by AlliedModders LLC
09 "Basic Info Triggers" (1.9.0.6260) by AlliedModders LLC
10 "Basic Votes" (1.9.0.6260) by AlliedModders LLC
11 "Client Preferences" (1.9.0.6260) by AlliedModders LLC
12 "Fun Commands" (1.9.0.6260) by AlliedModders LLC
13 "Fun Votes" (1.9.0.6260) by AlliedModders LLC
14 "Nextmap" (1.9.0.6260) by AlliedModders LLC
15 "Player Commands" (1.9.0.6260) by AlliedModders LLC
16 "Reserved Slots" (1.9.0.6260) by AlliedModders LLC
17 "Sound Commands" (1.9.0.6260) by AlliedModders LLC
 |contentclass=toccolours|contentcss="overflow: auto;"}}

==Upgrading addons==
Before upgrading files, close all running servers. 
:- If the server can not be shutdown (server reboot back up), find metamod.vdf file and move it out from addons folder. Server stop loading MM:S and SM addons after reboot.

Upgrading files, repeat again like in [[#Installing addons]]. 
But before moving files in server, delete these folders so you not lose your current configures/settings.
addons\sourcemod\configs\
cfg\sourcemod\
Launch server (or reboot) and check loaded addons [[#Checking loaded addons & plugins]]

----
--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 13:39, 18 November 2018 (CST)

[[Category:SourceMod for beginners]]

Installing MetaMod:Source and SourceMod (Windows)

2018-11-18T19:46:51Z

Bacardi: /* Checking loaded addons & plugins */ note for example

This is '''Quickstart guide''' - How install '''MetaMod:Source''' and '''SourceMod''' into Source Dedicated Server (Windows)
__TOC__
==Installing addons==
Download latest stable MM:S and SM zip packs (Windows version).
*https://www.sourcemm.net/downloads.php?branch=stable
*https://www.sourcemod.net/downloads.php?branch=stable
Extrack both zip files on your desktop, merging them into one.
 Move '''addons''' and '''cfg''' folders into SRCDS <game mod> folder. 
For example in Counter-Strike: Global Offensive dedicated server:
{| border="0"
|-
|{{font|text=C:\Server\counter-strike global offensive\csgo\addons|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
{| border="0"
|-
|{{font|text=C:\Server\counter-strike global offensive\csgo\cfg|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
 
==Checking loaded addons & plugins==
Launch SRCDS.
Typing these server commands into console input:
{|
|style="padding-right:50px"|'''plugin_print'''||you see loaded addons
|-
|'''meta list'''||you see loaded MetaMod:Source plugins
|-
|'''sm exts list'''||you see loaded SourceMod extensions
|-
|'''sm plugins list'''||you see loaded SourceMod plugins
|}
{{Note|''To see example of commands output text, click Show ->''}}
{{hidden|id=last|contentonly=yes|label=none|content= 
plugin_print
Loaded plugins:
---------------------
0: "Metamod:Source 1.10.7-dev"
---------------------
meta list
Listing 3 plugins:
[01] SourceMod (1.9.0.6260) by AlliedModders LLC
[02] CS Tools (1.9.0.6260) by AlliedModders LLC
[03] SDK Tools (1.9.0.6260) by AlliedModders LLC
sm exts list
[SM] Displaying 8 extensions:
[01] Automatic Updater (1.9.0.6260): Updates SourceMod gamedata files
[02] Webternet (1.9.0.6260): Extension for interacting with URLs
[03] CS Tools (1.9.0.6260): CS extended functionality
[04] BinTools (1.9.0.6260): Low-level C/C++ Calling API
[05] SDK Tools (1.9.0.6260): Source SDK Tools
[06] Top Menus (1.9.0.6260): Creates sorted nested menus
[07] Client Preferences (1.9.0.6260): Saves client preference settings
[08] SQLite (1.9.0.6260): SQLite Driver
sm plugins list
[SM] Listing 17 plugins:
01 "Admin File Reader" (1.9.0.6260) by AlliedModders LLC
02 "Admin Help" (1.9.0.6260) by AlliedModders LLC
03 "Admin Menu" (1.9.0.6260) by AlliedModders LLC
04 "Anti-Flood" (1.9.0.6260) by AlliedModders LLC
05 "Basic Ban Commands" (1.9.0.6260) by AlliedModders LLC
06 "Basic Chat" (1.9.0.6260) by AlliedModders LLC
07 "Basic Comm Control" (1.9.0.6260) by AlliedModders LLC
08 "Basic Commands" (1.9.0.6260) by AlliedModders LLC
09 "Basic Info Triggers" (1.9.0.6260) by AlliedModders LLC
10 "Basic Votes" (1.9.0.6260) by AlliedModders LLC
11 "Client Preferences" (1.9.0.6260) by AlliedModders LLC
12 "Fun Commands" (1.9.0.6260) by AlliedModders LLC
13 "Fun Votes" (1.9.0.6260) by AlliedModders LLC
14 "Nextmap" (1.9.0.6260) by AlliedModders LLC
15 "Player Commands" (1.9.0.6260) by AlliedModders LLC
16 "Reserved Slots" (1.9.0.6260) by AlliedModders LLC
17 "Sound Commands" (1.9.0.6260) by AlliedModders LLC
 |contentclass=toccolours|contentcss="overflow: auto;"}}

==Upgrading addons==
Before upgrading files, close all running servers. 
:- If the server can not be shutdown (server reboot back up), find metamod.vdf file and move it out from addons folder. Server stop loading MM:S and SM addons after reboot.

Upgrading files, repeat again like in [[#Installing addons]]. 
But before moving files in server, delete these folders so you not lose your current configures/settings.
addons\sourcemod\configs\
cfg\sourcemod\
Launch server (or reboot) and check loaded addons [[Checking loaded addons & plugins]]

----
--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 13:39, 18 November 2018 (CST)

[[Category:SourceMod for beginners]]

Setting up a Source Dedicated Server (Windows)

2018-11-18T19:43:20Z

Bacardi:

This is '''Quickstart guide''' - Setting up a '''{{color|orange|Source Dedicated Server}}''' {{srcds}} into your home PC (Windows version) using [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD tool]. 

 
__TOC__

==Installing SRCDS==
[[File:Steamcmd files.png|thumb|50px|none]]
Get '''SteamCMD tool''' ([https://steamcdn-a.akamaihd.net/client/installer/steamcmd.zip Download Link]), extract zip file and place '''steamcmd.exe''' in this directory structure.
{| border="0"
|-
|{{font|text=C:\server\steamcmd\steamcmd.exe|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
Open notepad.exe and create TXT file in same destination, named '''update.txt''' and create BATCH file named '''steamcmd_run.bat'''.
{| border="0"
|-
|{{font|text=C:\server\steamcmd\update.txt C:\server\steamcmd\steamcmd_run.bat|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
 
Inside '''steamcmd_run.bat''' file, save this script.
steamcmd.exe +runscript update.txt
 
Inside '''update.txt''' file, save this SteamCMD script
{{Note|''This script will now install multiple SRCDS (CS:GO, CS:S and TF2). Disable lines which you not want to install with double slash // or delete lines''}}

login anonymous

force_install_dir "../Counter-Strike Global Offensive"
app_update 740 validate

force_install_dir "../Counter-Strike Source"
app_update 232330 validate

{{color|green|//force_install_dir "../Half-Life 2 Deathmatch"
//app_update 232370 validate

//force_install_dir "../Day of Defeat Source"
//app_update 232290 validate}}

force_install_dir "../Team Fortress 2"
app_update 232250 validate

{{Note|''If some reason you fail to create these above files, you can download those from google drive {{hidden|id=last2|label=Hidden Link!|labelonly=yes}}''
{{hidden|id=last2|contentonly=yes|label=none|content=https://drive.google.com/open?id=1Hb81rG2D5exQlPz1icLVG3c6VtIwedGP}}}}
 
Run '''steamcmd_run.bat''' file, SteamCMD window should appear and start downloading files.
If everything is done right, you get SRCDS in C:\server\
 
==Launching SRCDS==
[[File:Launch script.png|thumb|50px|none]]
Find '''srcds.exe''' program from SRCDS game directory. For example in CS:GO mod:
{| border="0"
|-
|{{font|text=C:\server\Counter-Strike Global Offensive\srcds.exe|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
Create shortcut from '''srcds.exe''' and open shortcut properties. 
In shortcut properties Target: input, you see path to the program.
"C:\Server\counter-strike global offensive\srcds.exe"

*By adding parameter '''-console''', you run SRCDS without GUI
*Adding parameter '''-game''', you set <game mod> folder you are going to run
*Adding SRCDS command '''+map''', you start server with specific map. You find maps in ...<game mod>/maps/ folder
Example to run Counter-Strike: Global Offensive dedicated server
"C:\Server\counter-strike global offensive\srcds.exe" -console -game csgo +map de_dust2

Examples for other games
"C:\Server\Counter-Strike Source\srcds.exe" -console -game cstrike +map de_dust2
"C:\Server\Team Fortress 2\srcds.exe" -console -game tf +map cp_dustbowl

==Updating SRCDS==
Close all running SRCDS servers and run '''steamcmd_run.bat'''
 
 
 
 
----

--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 09:29, 17 November 2018 (CST)

[[Category:SourceMod for beginners]]

Installing MetaMod:Source and SourceMod (Windows)

2018-11-18T19:42:06Z

Bacardi: new category

This is '''Quickstart guide''' - How install '''MetaMod:Source''' and '''SourceMod''' into Source Dedicated Server (Windows)
__TOC__
==Installing addons==
Download latest stable MM:S and SM zip packs (Windows version).
*https://www.sourcemm.net/downloads.php?branch=stable
*https://www.sourcemod.net/downloads.php?branch=stable
Extrack both zip files on your desktop, merging them into one.
 Move '''addons''' and '''cfg''' folders into SRCDS <game mod> folder. 
For example in Counter-Strike: Global Offensive dedicated server:
{| border="0"
|-
|{{font|text=C:\Server\counter-strike global offensive\csgo\addons|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
{| border="0"
|-
|{{font|text=C:\Server\counter-strike global offensive\csgo\cfg|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
 
==Checking loaded addons & plugins==
Launch SRCDS.
Typing these server commands into console input:
{|
|style="padding-right:50px"|'''plugin_print'''||you see loaded addons
|-
|'''meta list'''||you see loaded MetaMod:Source plugins
|-
|'''sm exts list'''||you see loaded SourceMod extensions
|-
|'''sm plugins list'''||you see loaded SourceMod plugins
|}

{{hidden|id=last|contentonly=yes|label=none|content= 
plugin_print
Loaded plugins:
---------------------
0: "Metamod:Source 1.10.7-dev"
---------------------
meta list
Listing 3 plugins:
[01] SourceMod (1.9.0.6260) by AlliedModders LLC
[02] CS Tools (1.9.0.6260) by AlliedModders LLC
[03] SDK Tools (1.9.0.6260) by AlliedModders LLC
sm exts list
[SM] Displaying 8 extensions:
[01] Automatic Updater (1.9.0.6260): Updates SourceMod gamedata files
[02] Webternet (1.9.0.6260): Extension for interacting with URLs
[03] CS Tools (1.9.0.6260): CS extended functionality
[04] BinTools (1.9.0.6260): Low-level C/C++ Calling API
[05] SDK Tools (1.9.0.6260): Source SDK Tools
[06] Top Menus (1.9.0.6260): Creates sorted nested menus
[07] Client Preferences (1.9.0.6260): Saves client preference settings
[08] SQLite (1.9.0.6260): SQLite Driver
sm plugins list
[SM] Listing 17 plugins:
01 "Admin File Reader" (1.9.0.6260) by AlliedModders LLC
02 "Admin Help" (1.9.0.6260) by AlliedModders LLC
03 "Admin Menu" (1.9.0.6260) by AlliedModders LLC
04 "Anti-Flood" (1.9.0.6260) by AlliedModders LLC
05 "Basic Ban Commands" (1.9.0.6260) by AlliedModders LLC
06 "Basic Chat" (1.9.0.6260) by AlliedModders LLC
07 "Basic Comm Control" (1.9.0.6260) by AlliedModders LLC
08 "Basic Commands" (1.9.0.6260) by AlliedModders LLC
09 "Basic Info Triggers" (1.9.0.6260) by AlliedModders LLC
10 "Basic Votes" (1.9.0.6260) by AlliedModders LLC
11 "Client Preferences" (1.9.0.6260) by AlliedModders LLC
12 "Fun Commands" (1.9.0.6260) by AlliedModders LLC
13 "Fun Votes" (1.9.0.6260) by AlliedModders LLC
14 "Nextmap" (1.9.0.6260) by AlliedModders LLC
15 "Player Commands" (1.9.0.6260) by AlliedModders LLC
16 "Reserved Slots" (1.9.0.6260) by AlliedModders LLC
17 "Sound Commands" (1.9.0.6260) by AlliedModders LLC
 |contentclass=toccolours|contentcss="overflow: auto;"}}

==Upgrading addons==
Before upgrading files, close all running servers. 
:- If the server can not be shutdown (server reboot back up), find metamod.vdf file and move it out from addons folder. Server stop loading MM:S and SM addons after reboot.

Upgrading files, repeat again like in [[#Installing addons]]. 
But before moving files in server, delete these folders so you not lose your current configures/settings.
addons\sourcemod\configs\
cfg\sourcemod\
Launch server (or reboot) and check loaded addons [[Checking loaded addons & plugins]]

----
--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 13:39, 18 November 2018 (CST)

[[Category:SourceMod for beginners]]

Installing MetaMod:Source and SourceMod (Windows)

2018-11-18T19:39:55Z

Bacardi: new quickstart guide

This is '''Quickstart guide''' - How install '''MetaMod:Source''' and '''SourceMod''' into Source Dedicated Server (Windows)
__TOC__
==Installing addons==
Download latest stable MM:S and SM zip packs (Windows version).
*https://www.sourcemm.net/downloads.php?branch=stable
*https://www.sourcemod.net/downloads.php?branch=stable
Extrack both zip files on your desktop, merging them into one.
 Move '''addons''' and '''cfg''' folders into SRCDS <game mod> folder. 
For example in Counter-Strike: Global Offensive dedicated server:
{| border="0"
|-
|{{font|text=C:\Server\counter-strike global offensive\csgo\addons|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
{| border="0"
|-
|{{font|text=C:\Server\counter-strike global offensive\csgo\cfg|font=Courier New|size=20px|color=#c9b295|bgcolor=#364d6a}}
|}
 
==Checking loaded addons & plugins==
Launch SRCDS.
Typing these server commands into console input:
{|
|style="padding-right:50px"|'''plugin_print'''||you see loaded addons
|-
|'''meta list'''||you see loaded MetaMod:Source plugins
|-
|'''sm exts list'''||you see loaded SourceMod extensions
|-
|'''sm plugins list'''||you see loaded SourceMod plugins
|}

{{hidden|id=last|contentonly=yes|label=none|content= 
plugin_print
Loaded plugins:
---------------------
0: "Metamod:Source 1.10.7-dev"
---------------------
meta list
Listing 3 plugins:
[01] SourceMod (1.9.0.6260) by AlliedModders LLC
[02] CS Tools (1.9.0.6260) by AlliedModders LLC
[03] SDK Tools (1.9.0.6260) by AlliedModders LLC
sm exts list
[SM] Displaying 8 extensions:
[01] Automatic Updater (1.9.0.6260): Updates SourceMod gamedata files
[02] Webternet (1.9.0.6260): Extension for interacting with URLs
[03] CS Tools (1.9.0.6260): CS extended functionality
[04] BinTools (1.9.0.6260): Low-level C/C++ Calling API
[05] SDK Tools (1.9.0.6260): Source SDK Tools
[06] Top Menus (1.9.0.6260): Creates sorted nested menus
[07] Client Preferences (1.9.0.6260): Saves client preference settings
[08] SQLite (1.9.0.6260): SQLite Driver
sm plugins list
[SM] Listing 17 plugins:
01 "Admin File Reader" (1.9.0.6260) by AlliedModders LLC
02 "Admin Help" (1.9.0.6260) by AlliedModders LLC
03 "Admin Menu" (1.9.0.6260) by AlliedModders LLC
04 "Anti-Flood" (1.9.0.6260) by AlliedModders LLC
05 "Basic Ban Commands" (1.9.0.6260) by AlliedModders LLC
06 "Basic Chat" (1.9.0.6260) by AlliedModders LLC
07 "Basic Comm Control" (1.9.0.6260) by AlliedModders LLC
08 "Basic Commands" (1.9.0.6260) by AlliedModders LLC
09 "Basic Info Triggers" (1.9.0.6260) by AlliedModders LLC
10 "Basic Votes" (1.9.0.6260) by AlliedModders LLC
11 "Client Preferences" (1.9.0.6260) by AlliedModders LLC
12 "Fun Commands" (1.9.0.6260) by AlliedModders LLC
13 "Fun Votes" (1.9.0.6260) by AlliedModders LLC
14 "Nextmap" (1.9.0.6260) by AlliedModders LLC
15 "Player Commands" (1.9.0.6260) by AlliedModders LLC
16 "Reserved Slots" (1.9.0.6260) by AlliedModders LLC
17 "Sound Commands" (1.9.0.6260) by AlliedModders LLC
 |contentclass=toccolours|contentcss="overflow: auto;"}}

==Upgrading addons==
Before upgrading files, close all running servers. 
:- If the server can not be shutdown (server reboot back up), find metamod.vdf file and move it out from addons folder. Server stop loading MM:S and SM addons after reboot.

Upgrading files, repeat again like in [[#Installing addons]]. 
But before moving files in server, delete these folders so you not lose your current configures/settings.
addons\sourcemod\configs\
cfg\sourcemod\
Launch server (or reboot) and check loaded addons [[Checking loaded addons & plugins]]

----
--[[User:Bacardi|Bacardi]] ([[User talk:Bacardi|talk]]) 13:39, 18 November 2018 (CST)

2018-11-17T14:55:50Z

Bacardi: SteamCMD script

SteamCMD script

Template:Srcds

2018-11-16T16:01:01Z

Bacardi:

[[File:srcds.png|link=Source Dedicated Server|alt=<Source Dedicated Server>|18x16px|text-bottom]]<noinclude>[[Category:Game icons|{{PAGENAME}}]]</noinclude>