Configuring AMX Mod X

2006-09-02T01:00:37Z

Googol: /* Installing */

=Admins=
See the section on [[Adding Admins (AMX Mod X)|Adding Admins]] for more information.

=Plugins=
==Installing==
Often, plugins will have their own directions if they need special installation requirements. However, this will instruct you on the basics of adding a plugin.
#Follow any directions the plugin author has given you. If the plugin requires extra steps or special files, make sure you have them in the proper place and order.
#If you are given a .sma source file instead of a .amxx, you must compile the plugin yourself. For more information, see [[Compiling Plugins (AMX Mod X)]].
#Place the plugin's .amxx file in the addons/amxmodx/plugins folder.
#Add the plugin's name to addons\amxmodx\configs\plugins.ini. Example: <pre>myplugin.amxx</pre>
#Restart the server or change maps. If the plugin has any load errors, see [[Troubleshooting AMX Mod X#Plugins]].

==Removing==
#Remove the entry from addons\amxmodx\configs\plugins.ini by deleting it or prepending a semi-colon to comment it out.
#Delete any associated files.

==Default Plugins==
:{|
|- class="t2th"
| Plugin
| Purpose
|- class="t2td"
| admin.amxx
| Administration Base
|- class="t2td"
| admin_sql.amxx
| Administration Base for SQL. Use only one base.
|- class="t2td"
| admincmd.amxx
| Basic administration commands (such as kick/slap).
|- class="t2td"
| adminhelp.amxx
| Help for admin commands.
|- class="t2td"
| adminslots.amxx
| Slot reservation.
|- class="t2td"
| multilingual.amxx
| Multi-Lingual client configuration.
|- class="t2td"
| menufront.amxx
| Front-end for admin menus.
|- class="t2td"
| cmdmenu.amxx
| Command menu for settings.
|- class="t2td"
| plmenu.amxx
| Player menu commands (kick, ban, etc).
|- class="t2td"
| telemenu.amxx
| Teleport Menu (fun module required).
|- class="t2td"
| mapsmenu.amxx
| Maps menu (vote, changeleve, etc).
|- class="t2td"
| adminchat.amxx
| Console-based chat commands.
|- class="t2td"
| antiflood.amxx
| Prevents clients from flooding the say chat.
|- class="t2td"
| scrollmsg.amxx
| Displays a scrolling message.
|- class="t2td"
| imessage.amxx
| Displays a centered, timed information message.
|- class="t2td"
| adminvote.amxx
| Voting commands.
|- class="t2td"
| nextmap.amxx
| Displays next map in the mapcycle.
|- class="t2td"
| mapchooser.amxx
| Allows players to vote for the next map.
|- class="t2td"
| timeleft.amxx
| Displays time left on the current map.
|- class="t2td"
| pausecfg.amxx
| Allows pausing/unpausing of plugins.
|- class="t2td"
| statscfg.amxx
| Configuration of statistical plugins.
|}

=Modules=
Modules add additional functionality for plugins to use.
==Installing==
#Figure out what operating system your server is: Windows, Linux, or Linux using AMD64 (64bit).
#If the module is 3rd party, download the module corresponding to your OS. It will end in .dll for Windows, _i386.so for Linux, or _amd64.so for AMD64.
#Place the file in addons/amxmodx/modules/ and follow any additional instructions.
#If the module is already in addons/amxmodx/configs/modules.ini, remove the ';' next to its name to enable it.
#Otherwise, add the module's name to modules.ini. [[AMX Mod X]] supports generic notation, for example: <pre>mysql_amxx</pre> ... will automatically detect the correct module to use.
#To see if the module is working, you can type <tt>amxx modules</tt> in your [[server console]].

==Removing==
#Remove the entry from addons\amxmodx\configs\modules.ini by deleting it or prepending a semi-colon to comment it out.
#Delete any associated files if you don't need them.

==Default Modules==
:{|
|- class="t2th"
| Module
| Purpose
|- class="t2td"
| fun_amxx
| General functions for changing game values.
|- class="t2td"
| engine_amxx
| More advanced functions for getting and setting values in the HL engine.
|- class="t2td"
| fakemeta_amxx
| Expert/advanced functions for manipulating, hooking, and calling functions in the HL engine.
|- class="t2td"
| *sql_amxx
| SQL/Database scripting functions.
|- class="t2td"
| geoip_amxx
| Functions for finding countries by IP address.
|- class="t2td"
| array_amxx
| Functions for somewhat-dynamic arrays.
|- class="t2td"
| sockets_amxx
| Functions for socket (TCP/UDP) control and manipulation.
|- class="t2td"
| regex_amxx
| Functions for regular expression support.
|}

=CVARs=
The base [[CVAR]]s AMX Mod X defines are located in amxmodx/configs/amxx.cfg. You can edit these the same way you edit the server.cfg file:
:{|
|- class="t2th"
| CVAR
| Default Setting
| Purpose
|- class="t2td"
| amx_default_access
| "z"
| Sets the default access level for non-admin players.
|- class="t2td"
| amx_password_field
| "_pw"
| Name of the setinfo key which a user should store their password in.
|- class="t2td"
| amx_mode
| 1
| Changes the mode of logging into a server: 
0 - Disable logging, players won't be checked and no access will be given. 
1 - Normal mode which obeys flags set in accounts. 
2 - Kick all players not on the users list.
|- class="t2td"
| amx_show_activity
| 2
| Sets the mode of admin activity on the server: 
0 - Disabled 
1 - Show action anonymously 
2 - Show action with the admin's name
|- class="t2td"
| amx_scrollmsg
| "Welcome to %hostname% -- This server is using AMX Mod X" 600
| Sets the parameters (message and frequency) for a scrolling message.
|- class="t2td"
| amx_imessage
| "Welcome to %hostname" "000255100" "This server is using AMX Mod X\nVisit http://www.amxmodx.org" "00010025"
| Adds a center-typed colored message. The last parameter is in RRRGGGBBB format (red, green, blue).
|- class="t2td"
| amx_freq_imessage
| 180
| Frequency, in seconds, of the colored center messages.
|- class="t2td"
| amx_flood_time
| 0.75
| Chat flood prevention. Sets how fast a player can chat (in seconds).
|- class="t2td"
| amx_reservation
| 0
| Sets the amount of reserved slots.
|- class="t2td"
| amx_time_display
| "ab 1200" "ab 600" "ab 300" "ab 180" "ab 60" "bcde 11"
| Sets flags for remaining time display: 
a - Display white text on bottom 
b - Use voice 
c - Don't add "remaining" in voice 
d - Don't add "hours/minutes/seconds" in voice 
e - Show/speak if current time is less than set in parameter
|- class="t2td"
| amx_time_voice
| 1
| Sets whether to announce "say thetime" and "say timeleft" with voice.
|- class="t2td"
| amx_vote_delay
| 10
| Sets the minimum delay in seconds between two voting sessions.
|- class="t2td"
| amx_vote_time
| 10
| Sets how long a voting sessions lasts for.
|- class="t2td"
| amx_vote_answers
| 1
| Displays who votes for which options, publically.
|- class="t2td"
| amx_voteban_ratio
| 0.40
| Ratio for a ban vote to be successful.
|- class="t2td"
| amx_votekick_ratio
| 0.40
| Ratio for a kick vote to be successful.
|- class="t2td"
| amx_votemap_ratio
| 0.40
| Ratio for a map vote to be successful.
|- class="t2td"
| amx_vote_ratio
| 0.40
| Ratio for a general vote to be successful.
|- class="t2td"
| amx_extendmap_max
| 90
| Maximum time a mapvote can be extended.
|- class="t2td"
| amx_extendmap_step
| 15
| Amount of time a map extensions adds.
|- class="t2td"
| amx_client_languages
| 1
| Enables or disables the ability for clients to choose their own language.
|- class="t2td"
| amx_debug
| 1
| Sets the debug mode for plugins: 
0 - No debugging (warning messages for plugin errors) 
1 - Plugins with "debug" option in plugins.ini are put into debug mode. 
2 - All plugins are put into debug mode (full backtraces for errors). 
Note that debug mode greatly decreases JIT performance.
|- class="t2td"
| amx_mldebug
| 0
| Logs multi-lingual translation problems.
|}

=SQL=
Make sure you have mysql_amxx enabled in AMX Mod X's amxmodx/configs/modules.ini file.

Then, open amxmodx/configs/sql.cfg and edit the cvars accordingly:

:{|
|- class="t2th"
| CVAR
| Default Setting
| Purpose
|- class="t2td"
| amx_sql_host
| "127.0.0.1"
| IP address of SQL server.
|- class="t2td"
| amx_sql_user
| "root"
| Username to connect to the SQL server.
|- class="t2td"
| amx_sql_pass
| ""
| Password to connect to the SQL server.
|- class="t2td"
| amx_sql_db
| "amx"
| Database to use on the SQL server.
|- class="t2td"
| amx_sql_table
| "admins"
| The table to use for the admin_sql plugin.
|- class="t2td"
| amx_sql_type
| "mysql"
| The database type to connect to.
|}
*Note: amx_sql_type as of AMXX 1.75

=Maps=
If you use the mapsmenu plugin, you can either use "maps.ini" or "mapcycle.txt" to manage map rotations.

Delete "maps.ini" to use mapcycle.txt, otherwise, simply add a list of map names to maps.ini like so:
<pre>de_dust
cs_assault
de_aztec</pre>

Et cetera. For each map, you can also add a configuration file that will execute when the map loads. This is useful to set certain settings for 3rd party maps, say, removing the freeze time on fy_iceworld.

To do this, simply create a folder in amxmodx/configs called "maps" and place a .cfg file named after the map with the settings in it, for example, you might have amxmodx/configs/maps/fy_iceworld.cfg:

<pre>
mp_startmoney 16000
mp_freezetime 0
mp_timelimit 20
</pre>

=Menus=
==Client Commands==
:{|
|-
| class="t2th" | File:
| class="t2td" | addons\amxmodx\configs\clcmds.ini
|-
| class="t2th" | Format:
| class="t2td" | "Name" "Command" "Flags" "Access Level"
|-
| class="t2th" | Options:
| class="t2td" | Name is the name that will appear on the menu. 
Command is the format for the console command - you can use %userid% to insert the user's id. 
Flags are one of the following: 
a - execute from server console. 
b - execute from admin console. 
c - execute on selected player. 
d - display menu again once done
|-
| class="t2th" | Example:
| class="t2td" | "Slay player" "amx_slay #%userid%" "bd" "u"
|}

==Commands==
:{|
|-
| class="t2th" | File:
| class="t2td" | addons\amxmodx\configs\cmds.ini
|-
| class="t2th" | Format:
| class="t2td" | "Name" "Command" "Flags" "Access Level"
|-
| class="t2th" | Options:
| class="t2td" | Name is the name that will appear on the menu. 
Command is the format for the console command - you can use %userid% to insert the user's id. 
Flags are one of the following: 
a - execute from server console. 
b - execute from admin console. 
c - execute on selected player. 
d - display menu again once done
|-
| class="t2th" | Example:
| class="t2td" | "Pause" "amx_pause" "bd" "u"
|}

==Configs==
:{|
|-
| class="t2th" | File:
| class="t2td" | addons\amxmodx\configs\configs.ini
|-
| class="t2th" | Format:
| class="t2td" | "Name" "Command" "Flags" "Access Level"
|-
| class="t2th" | Options:
| class="t2td" | Name is the name that will appear on the menu. 
Command is the format for the console command.
Flags are one of the following: 
a - execute from server console. 
b - execute from admin console. 
d - display menu again once done
|-
| class="t2th" | Example:
| class="t2td" | "PUBLIC Settings" "servercfgfile server.cfg;exec server.cfg" "a" "u"
|}

==CVARs==
:{|
|-
| class="t2th" | File:
| class="t2td" | addons\amxmodx\configs\cvars.ini
|-
| class="t2th" | Format:
| class="t2td" | "CVAR" "Values" ... "Access Level"
|-
| class="t2th" | Options:
| class="t2td" | CVAR - the CVAR's name 
Values - list of space delimited, quotation enclosed values
|-
| class="t2th" | Example:
| class="t2td" | "mp_autoteambalance" "0" "1" "@" "u"
|}

==Speech==
:{|
|-
| class="t2th" | File:
| class="t2td" | addons\amxmodx\configs\speech.ini
|-
| class="t2th" | Format:
| class="t2td" | "Name" "Command" "Flags" "Access Level"
|-
| class="t2th" | Options:
| class="t2td" | Name is the name that will appear on the menu. 
Command is the format for the console command - you can use %userid% to insert the user's id. 
Flags are one of the following: 
a - execute from server console 
b - execute from admin console 
c - execute on selected player 
d - display menu again once done
|-
| class="t2th" | Example:
| class="t2td" | "Hello!" "spk \'vox/hello\'" "cd" "u"
|}

[[Category:Documentation (AMX Mod X)]]

AlliedModders Wiki:Site support

2006-01-26T08:00:44Z

Googol:

Currently a central hub in between projects is in the works.
In the meantime, you should use the donations link from the [http://www.sourcemod.net/ SourceMod] website.

AlliedModders Wiki - User contributions [en]

Configuring AMX Mod X

AlliedModders Wiki:Site support