Difference between revisions of "UMC Plugin"
(Created page with "This plugin is design to be a more complex mapchooser plugin that can be used to create various map lists to vote from. While it has all the standard map voting items (rtv, no...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 2: | Line 2: | ||
== How It Works == | == How It Works == | ||
| + | This plugin and its associated modules can be used to create a much more diverse set of map choices for players based on factors like player numbers on the server, map weight (which can be tied to a plugin that allows users to rate maps), prefixes/postfixes of map names, and even map groups that help group together similar maps. This plugin also features the ability for nominated maps to appear at the top or bottom of the vote list once rtv is called (provided someone nominated a map!) to decide the next map. This map chooser has been updated to support ZPS, but it can also be used in other games. | ||
| + | To know all the ins and outs about this plugin, refer to the thread on UMC here on the AlliedModder's forums. It has information on the original plugin and what most of the modules are supposed to do: https://forums.alliedmods.net/showthread.php?t=134190?t=134190 | ||
| + | |||
| + | The Google Code archive is still around and has all the wiki pages for each module. You can also find that information here: https://code.google.com/archive/p/sourcemod-ultimate-mapchooser/wikis | ||
== Code and Plugin Download == | == Code and Plugin Download == | ||
| − | |||
Below is the download link and code for the plugin: | Below is the download link and code for the plugin: | ||
*[https://github.com/Silenci0/UMC UMC (Ultimate Map Chooser) Plugin] | *[https://github.com/Silenci0/UMC UMC (Ultimate Map Chooser) Plugin] | ||
| − | == | + | == How To Install Plugin == |
| + | To install the plugin, simply download the files, unzip them, and then copy the addons and cfg folders into your game server's main directory. This will add ALL of the files into your game's "addons/sourcemod" directories. If asked to merge folders, click yes. If asked to overwrite, click yes. Each module/plugin has its own configuration file that will generate if not present, but for convenience, the configuration files have been included. | ||
| + | |||
| + | The map file you need to use is called umc_mapcycle.txt (which is also provided) and it will be where you place all of your maps and any of the options/configurations for the maps. This file can be used to create multiple map groups or give some maps the ability to appear under certain conditions in the map votes/nominations list. This file MUST exist in the main directory of your game's server installation (in this case, it should exist in the zps directory next to the addons and cfg directories) as that is where the plugin looks for this file by default. You may rename the umc_mapcycle.txt file to something else or make another mapcycle file (will obviously need to have a different name), you'll just need to specify in the appropriate configuration files (such as umc_votecommand.cfg) the name of the file you want to use. But by default, it uses umc_mapcycle.txt. For more in depth information on each of these modules and their functions, see the links in the How It Works section and/or look at each configuration file's explanation on what each cvar is. | ||
| + | |||
| + | Due to the complexity of this plugin, there is a lot of information and it can be somewhat confusing to get started. To get the most out of this plugin and its various options, you'll need to understand how each module works with one another and how it is used by the umc_mapcycle.txt to create map groups/votes that will be used in game. Also, please be sure to disable any other mapchooser/nominate/rtv plugins including the ones that come wwith Sourcemod if you plan on using this plugin! | ||
| + | |||
| + | The following are recommended/have been tested in ZPS: | ||
| + | |||
| + | *umc-core.smx (You MUST have this plugin as it enables all the other plugin modules. UMC modules ARE NOT standalone!) | ||
| + | *umc-adminmenu.smx (Enables the admin menu under the sm_admin cvar) | ||
| + | *umc-endvote.smx (Necessary for creating a vote that appears at the end of a map) | ||
| + | *umc-rockthevote.smx (Required to enable UMC's rtv.) | ||
| + | *umc-nominate.smx (Required to allow players to nominate maps) | ||
| + | *umc-endvote-warnings.smx (Warnings players when a map vote will take place at the end of a map. Optional, but recommended.) | ||
| + | *umc-votecommand.smx (Required to allow map voting. Dictates how votes should work). | ||
| + | *umc-randomcycle.smx (Optional. Use this if you want the mapchooser to randomly choose the next map) | ||
| + | *umc-echonextmap.smx (Optional. Echos the next map that is chosen by the mapchooser) | ||
| + | *umc-playerlimits.smx (Optional, though recommended if you want to specify which maps appear in a vote based on how many players are on the server) | ||
| − | + | Also, keep in mind that UMC was developed on later versions of the Source engine and NOT on the 2007 version. While it has been updated to work with ZPS (and thus older 2007 games/mods), not everything works correctly. For example, using the umc-echonextmap.smx plugin to display the next map on the center of the screen does not work as the call to display text on the screen's center does not work with ZPS (not sure why, it is still being looked into). It doesn't harm the server, but it will leave errorlogs. It is advised to only use player chat or the hint message to display in-game text for things like nextmap. | |
| − | This version of the plugin was compiled on SM 1.7.3, so it should work for Sourcemod 1.7.3 or later. If you need this for an older/specialized version of Sourcemod, you may want to compile the plugin (script files are included) for your version of Sourcemod. | + | This guide also assumes you are using Sourcemod/Metamod, so if you haven't installed those, do so before adding the plugin files to your server! This version of the plugin was compiled on SM 1.7.3, so it should work for Sourcemod 1.7.3 or later. If you need this for an older/specialized version of Sourcemod, you may want to compile the plugin (script files are included) for your version of Sourcemod. |
All of this is provided "as is". While this plugin should not cause harm, any harm caused by the plugin, user handling, or anything else Vertigo Gaming and all associated coders are not responsible for it. Use at your own risk! | All of this is provided "as is". While this plugin should not cause harm, any harm caused by the plugin, user handling, or anything else Vertigo Gaming and all associated coders are not responsible for it. Use at your own risk! | ||
Latest revision as of 17:37, 1 April 2017
This plugin is design to be a more complex mapchooser plugin that can be used to create various map lists to vote from. While it has all the standard map voting items (rtv, nominate, etc.) it also has some complexity in that you can set special conditions (such as player thresholds) for certain maps, which can help introduce some maps when a server is more full or allow users to pick ones based on map prefix, gamemode, and other such things.
How It Works
This plugin and its associated modules can be used to create a much more diverse set of map choices for players based on factors like player numbers on the server, map weight (which can be tied to a plugin that allows users to rate maps), prefixes/postfixes of map names, and even map groups that help group together similar maps. This plugin also features the ability for nominated maps to appear at the top or bottom of the vote list once rtv is called (provided someone nominated a map!) to decide the next map. This map chooser has been updated to support ZPS, but it can also be used in other games.
To know all the ins and outs about this plugin, refer to the thread on UMC here on the AlliedModder's forums. It has information on the original plugin and what most of the modules are supposed to do: https://forums.alliedmods.net/showthread.php?t=134190?t=134190
The Google Code archive is still around and has all the wiki pages for each module. You can also find that information here: https://code.google.com/archive/p/sourcemod-ultimate-mapchooser/wikis
Code and Plugin Download
Below is the download link and code for the plugin:
How To Install Plugin
To install the plugin, simply download the files, unzip them, and then copy the addons and cfg folders into your game server's main directory. This will add ALL of the files into your game's "addons/sourcemod" directories. If asked to merge folders, click yes. If asked to overwrite, click yes. Each module/plugin has its own configuration file that will generate if not present, but for convenience, the configuration files have been included.
The map file you need to use is called umc_mapcycle.txt (which is also provided) and it will be where you place all of your maps and any of the options/configurations for the maps. This file can be used to create multiple map groups or give some maps the ability to appear under certain conditions in the map votes/nominations list. This file MUST exist in the main directory of your game's server installation (in this case, it should exist in the zps directory next to the addons and cfg directories) as that is where the plugin looks for this file by default. You may rename the umc_mapcycle.txt file to something else or make another mapcycle file (will obviously need to have a different name), you'll just need to specify in the appropriate configuration files (such as umc_votecommand.cfg) the name of the file you want to use. But by default, it uses umc_mapcycle.txt. For more in depth information on each of these modules and their functions, see the links in the How It Works section and/or look at each configuration file's explanation on what each cvar is.
Due to the complexity of this plugin, there is a lot of information and it can be somewhat confusing to get started. To get the most out of this plugin and its various options, you'll need to understand how each module works with one another and how it is used by the umc_mapcycle.txt to create map groups/votes that will be used in game. Also, please be sure to disable any other mapchooser/nominate/rtv plugins including the ones that come wwith Sourcemod if you plan on using this plugin!
The following are recommended/have been tested in ZPS:
- umc-core.smx (You MUST have this plugin as it enables all the other plugin modules. UMC modules ARE NOT standalone!)
- umc-adminmenu.smx (Enables the admin menu under the sm_admin cvar)
- umc-endvote.smx (Necessary for creating a vote that appears at the end of a map)
- umc-rockthevote.smx (Required to enable UMC's rtv.)
- umc-nominate.smx (Required to allow players to nominate maps)
- umc-endvote-warnings.smx (Warnings players when a map vote will take place at the end of a map. Optional, but recommended.)
- umc-votecommand.smx (Required to allow map voting. Dictates how votes should work).
- umc-randomcycle.smx (Optional. Use this if you want the mapchooser to randomly choose the next map)
- umc-echonextmap.smx (Optional. Echos the next map that is chosen by the mapchooser)
- umc-playerlimits.smx (Optional, though recommended if you want to specify which maps appear in a vote based on how many players are on the server)
Also, keep in mind that UMC was developed on later versions of the Source engine and NOT on the 2007 version. While it has been updated to work with ZPS (and thus older 2007 games/mods), not everything works correctly. For example, using the umc-echonextmap.smx plugin to display the next map on the center of the screen does not work as the call to display text on the screen's center does not work with ZPS (not sure why, it is still being looked into). It doesn't harm the server, but it will leave errorlogs. It is advised to only use player chat or the hint message to display in-game text for things like nextmap.
This guide also assumes you are using Sourcemod/Metamod, so if you haven't installed those, do so before adding the plugin files to your server! This version of the plugin was compiled on SM 1.7.3, so it should work for Sourcemod 1.7.3 or later. If you need this for an older/specialized version of Sourcemod, you may want to compile the plugin (script files are included) for your version of Sourcemod.
All of this is provided "as is". While this plugin should not cause harm, any harm caused by the plugin, user handling, or anything else Vertigo Gaming and all associated coders are not responsible for it. Use at your own risk!
