3 * =============================================================================
4 * SourceMod Rock The Vote Plugin
5 * Creates a map vote when the required number of players have requested one.
7 * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
8 * =============================================================================
10 * This program is free software; you can redistribute it and/or modify it under
11 * the terms of the GNU General Public License, version 3.0, as published by the
12 * Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License along with
20 * this program. If not, see <http://www.gnu.org/licenses/>.
22 * As a special exception, AlliedModders LLC gives you permission to link the
23 * code of this program (as well as its derivative works) to "Half-Life 2," the
24 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
25 * by the Valve Corporation. You must obey the GNU General Public License in
26 * all respects for all other code used. Additionally, AlliedModders LLC grants
27 * this exception to all derivative works. AlliedModders LLC defines further
28 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
29 * or <http://www.sourcemod.net/license.php>.
38 public Plugin:myinfo =
40 name = "Rock The Vote",
41 author = "AlliedModders LLC",
42 description = "Provides RTV Map Voting",
43 version = SOURCEMOD_VERSION,
44 url = "http://www.sourcemod.net/"
47 new Handle:g_Cvar_Needed = INVALID_HANDLE;
48 new Handle:g_Cvar_File = INVALID_HANDLE;
49 new Handle:g_Cvar_Maps = INVALID_HANDLE;
50 new Handle:g_Cvar_Nominate = INVALID_HANDLE;
51 new Handle:g_Cvar_MinPlayers = INVALID_HANDLE;
53 new Handle:g_MapList = INVALID_HANDLE;
54 new Handle:g_RTVMapList = INVALID_HANDLE;
55 new Handle:g_MapMenu = INVALID_HANDLE;
56 new Handle:g_RetryTimer = INVALID_HANDLE;
59 new bool:g_CanRTV = false; // True if RTV loaded maps and is active.
60 new bool:g_RTVAllowed = false; // True if RTV is available to players. Used to delay rtv votes.
61 new bool:g_RTVStarted = false; // Indicates that the actual map vote has started
62 new bool:g_RTVEnded = false; // Indicates that the actual map vote has concluded
63 new g_Voters = 0; // Total voters connected. Doesn't include fake clients.
64 new g_Votes = 0; // Total number of "say rtv" votes
65 new g_VotesNeeded = 0; // Necessary votes before map vote begins. (voters * percent_needed)
66 new bool:g_Voted[MAXPLAYERS+1] = {false, ...};
67 new bool:g_Nominated[MAXPLAYERS+1] = {false, ...};
69 public OnPluginStart()
71 LoadTranslations("common.phrases");
72 LoadTranslations("rockthevote.phrases");
74 g_MapList = CreateArray(33);
75 g_RTVMapList = CreateArray(33);
77 g_Cvar_Needed = CreateConVar("sm_rtv_needed", "0.60", "Percentage of players needed to rockthevote (Def 60%)", 0, true, 0.05, true, 1.0);
78 g_Cvar_File = CreateConVar("sm_rtv_file", "configs/maps.ini", "Map file to use. (Def configs/maps.ini)");
79 g_Cvar_Maps = CreateConVar("sm_rtv_maps", "4", "Number of maps to be voted on. 2 to 6. (Def 4)", 0, true, 2.0, true, 6.0);
80 g_Cvar_Nominate = CreateConVar("sm_rtv_nominate", "1", "Enables nomination system.", 0, true, 0.0, true, 1.0);
81 g_Cvar_MinPlayers = CreateConVar("sm_rtv_minplayers", "0", "Number of players required before RTV will be enabled.", 0, true, 0.0, true, float(MAXPLAYERS));
83 RegConsoleCmd("say", Command_Say);
84 RegConsoleCmd("say_team", Command_Say);
86 RegAdminCmd("sm_rtv_addmap", Command_Addmap, ADMFLAG_CHANGEMAP, "sm_rtv_addmap <mapname> - Forces a map to be on the RTV, and lowers the allowed nominations.");
88 AutoExecConfig(true, "rtv");
93 if (g_RTVMapList != INVALID_HANDLE)
95 ClearArray(g_RTVMapList);
101 g_RTVStarted = false;
108 CreateTimer(30.0, Timer_DelayRTV);
112 LogMessage("[SM] Cannot find map cycle file, RTV not active.");
119 g_RTVAllowed = false;
123 public bool:OnClientConnect(client, String:rejectmsg[], maxlen)
125 if(IsFakeClient(client))
128 g_Voted[client] = false;
129 g_Nominated[client] = false;
132 g_VotesNeeded = RoundToFloor(float(g_Voters) * GetConVarFloat(g_Cvar_Needed));
137 public OnClientDisconnect(client)
139 if(IsFakeClient(client))
149 g_VotesNeeded = RoundToFloor(float(g_Voters) * GetConVarFloat(g_Cvar_Needed));
151 if (g_Votes && g_Voters && g_Votes >= g_VotesNeeded && g_RTVAllowed)
153 CreateTimer(2.0, Timer_StartRTV, TIMER_FLAG_NO_MAPCHANGE);
157 public Action:Command_Addmap(client, args)
161 ReplyToCommand(client, "[SM] Usage: sm_rtv_addmap <mapname>");
162 return Plugin_Handled;
165 decl String:mapname[64];
166 GetCmdArg(1, mapname, sizeof(mapname));
168 if (!IsStringInArray(g_MapList, mapname))
170 ReplyToCommand(client, "%t", "Map was not found", mapname);
171 return Plugin_Handled;
174 if (GetArraySize(g_RTVMapList) > 0)
176 for (new i = 0; i < GetArraySize(g_RTVMapList); i++)
178 decl String:nextmap[64];
179 GetArrayString(g_RTVMapList, i, nextmap, sizeof(nextmap));
180 if (strcmp(mapname, nextmap, false) == 0)
182 ReplyToCommand(client, "%t", "Map Already In Vote", mapname);
183 return Plugin_Handled;
187 ShiftArrayUp(g_RTVMapList, 0);
188 SetArrayString(g_RTVMapList, 0, mapname);
190 while (GetArraySize(g_RTVMapList) > GetConVarInt(g_Cvar_Maps))
192 RemoveFromArray(g_RTVMapList, GetConVarInt(g_Cvar_Maps));
197 PushArrayString(g_RTVMapList, mapname);
200 decl String:item[64];
201 for (new i = 0; i < GetMenuItemCount(g_MapMenu); i++)
203 GetMenuItem(g_MapMenu, i, item, sizeof(item));
204 if (strcmp(item, mapname) == 0)
206 RemoveMenuItem(g_MapMenu, i);
211 ReplyToCommand(client, "%t", "Map Inserted", mapname);
212 LogAction(client, -1, "\"%L\" inserted map \"%s\".", client, mapname);
214 return Plugin_Handled;
217 public Action:Command_Say(client, args)
219 if (!g_CanRTV || !client)
220 return Plugin_Continue;
222 decl String:text[192];
223 if (!GetCmdArgString(text, sizeof(text)))
225 return Plugin_Continue;
229 if(text[strlen(text)-1] == '"')
231 text[strlen(text)-1] = '\0';
235 if (strcmp(text[startidx], "rtv", false) == 0 || strcmp(text[startidx], "rockthevote", false) == 0)
239 PrintToChat(client, "[SM] %t", "RTV Not Allowed");
240 return Plugin_Continue;
245 PrintToChat(client, "[SM] %t", "RTV Ended");
246 return Plugin_Continue;
251 PrintToChat(client, "[SM] %t", "RTV Started");
252 return Plugin_Continue;
255 if (GetClientCount(true) < GetConVarInt(g_Cvar_MinPlayers) && g_Votes == 0) // Should we keep checking g_Votes here?
257 PrintToChat(client, "[SM] %t", "Minimal Players Not Met");
258 return Plugin_Continue;
263 PrintToChat(client, "[SM] %t", "Already Voted");
264 return Plugin_Continue;
268 GetClientName(client, name, sizeof(name));
271 g_Voted[client] = true;
273 PrintToChatAll("[SM] %t", "RTV Requested", name, g_Votes, g_VotesNeeded);
275 if (g_Votes >= g_VotesNeeded)
277 CreateTimer(2.0, Timer_StartRTV, TIMER_FLAG_NO_MAPCHANGE);
280 else if (GetConVarBool(g_Cvar_Nominate) && strcmp(text[startidx], "nominate", false) == 0)
284 PrintToChat(client, "[SM] %t", "RTV Ended");
285 return Plugin_Continue;
290 PrintToChat(client, "[SM] %t", "RTV Started");
291 return Plugin_Continue;
294 if (g_Nominated[client])
296 PrintToChat(client, "[SM] %t", "Already Nominated");
297 return Plugin_Continue;
300 if (GetArraySize(g_RTVMapList) >= GetConVarInt(g_Cvar_Maps))
302 PrintToChat(client, "[SM] %t", "Max Nominations");
303 return Plugin_Continue;
306 DisplayMenu(g_MapMenu, client, MENU_TIME_FOREVER);
309 return Plugin_Continue;
312 public Action:Timer_DelayRTV(Handle:timer)
317 public Action:Timer_StartRTV(Handle:timer)
319 if (timer == g_RetryTimer)
321 g_RetryTimer = INVALID_HANDLE;
324 if (g_RetryTimer != INVALID_HANDLE)
331 if (IsVoteInProgress())
333 // Can't start a vote, try again in 5 seconds.
334 g_RetryTimer = CreateTimer(5.0, Timer_StartRTV, TIMER_FLAG_NO_MAPCHANGE);
338 PrintToChatAll("[SM] %t", "RTV Vote Ready");
340 new Handle:MapVoteMenu = CreateMenu(Handler_MapMapVoteMenu, MenuAction:MENU_ACTIONS_ALL);
341 SetMenuTitle(MapVoteMenu, "Rock The Vote");
343 new Handle:tempMaps = CreateArray(33);
345 for (new i = 0; i < GetArraySize(g_MapList); i++)
347 GetArrayString(g_MapList, i, map, sizeof(map));
348 PushArrayString(tempMaps, map);
351 // We assume that g_RTVMapList is within the correct limits, based on the logic for nominations
352 for (new i = 0; i < GetArraySize(g_RTVMapList); i++)
354 GetArrayString(g_RTVMapList, i, map, sizeof(map));
355 AddMenuItem(MapVoteMenu, map, map);
357 for (new j = 0; j < GetArraySize(tempMaps); j++)
359 decl String:temp[32];
360 GetArrayString(tempMaps, j, temp, sizeof(temp));
361 if (strcmp(map, temp) == 0)
363 RemoveFromArray(tempMaps, j);
369 new limit = GetConVarInt(g_Cvar_Maps) - GetArraySize(g_RTVMapList);
370 if (limit > GetArraySize(tempMaps))
372 limit = GetArraySize(tempMaps);
375 for (new i = 0; i < limit; i++)
377 new b = GetRandomInt(0, GetArraySize(tempMaps) - 1);
378 GetArrayString(tempMaps, b, map, sizeof(map));
379 PushArrayString(g_RTVMapList, map);
380 AddMenuItem(MapVoteMenu, map, map);
381 RemoveFromArray(tempMaps, b);
384 AddMenuItem(MapVoteMenu, "Don't Change", "Don't Change");
386 SetMenuExitButton(MapVoteMenu, false);
387 VoteMenuToAll(MapVoteMenu, 20);
389 LogMessage("[SM] Rockthevote was successfully started.");
392 public Action:Timer_ChangeMap(Handle:hTimer, Handle:dp)
397 ReadPackString(dp, map, sizeof(map));
399 ServerCommand("changelevel \"%s\"", map);
404 public Handler_MapMapVoteMenu(Handle:menu, MenuAction:action, param1, param2)
413 case MenuAction_Display:
415 decl String:oldTitle[255], String:buffer[255];
416 GetMenuTitle(menu, oldTitle, sizeof(oldTitle));
417 Format(buffer, sizeof(buffer), "%T", oldTitle, param1);
419 new Handle:panel = Handle:param2;
420 SetPanelTitle(panel, buffer);
423 case MenuAction_DisplayItem:
425 if (GetMenuItemCount(menu) - 1 == param2)
427 decl String:buffer[255];
428 Format(buffer, sizeof(buffer), "%T", "Don't Change", param1);
429 return RedrawMenuItem(buffer);
433 // Why am I commented out? Because BAIL hasn't decided yet if
434 // vote notification will be built into the Vote API.
435 /*case MenuAction_Select:
437 decl String:Name[32], String:Map[32];
438 GetClientName(param1, Name, sizeof(Name));
439 GetMenuItem(menu, param2, Map, sizeof(Map));
441 PrintToChatAll("[SM] %s has voted for map '%s'", Name, Map);
444 case MenuAction_VoteCancel:
446 if (param1 == VoteCancel_NoVotes)
448 PrintToChatAll("[SM] %t", "No Votes");
452 case MenuAction_VoteEnd:
456 GetMenuItem(menu, param1, map, sizeof(map));
458 if (GetMenuItemCount(menu) - 1 == param1) // This should always match the "Keep Current" option
460 PrintToChatAll("[SM] %t", "Current Map Stays");
461 LogMessage("[SM] Rockthevote has ended, current map kept.");
465 PrintToChatAll("[SM] %t", "Changing Maps", map);
466 LogMessage("[SM] Rockthevote has ended, changing to map %s.", map);
468 CreateDataTimer(5.0, Timer_ChangeMap, dp);
469 WritePackString(dp, map);
479 public Handler_MapSelectMenu(Handle:menu, MenuAction:action, param1, param2)
483 case MenuAction_Select:
485 if (GetArraySize(g_RTVMapList) >= GetConVarInt(g_Cvar_Maps))
487 PrintToChat(param1, "[SM] %t", "Max Nominations");
491 decl String:map[64], String:name[64];
492 GetMenuItem(menu, param2, map, sizeof(map));
494 if (IsStringInArray(g_RTVMapList, map))
496 PrintToChat(param1, "[SM] %t", "Map Already Nominated");
500 GetClientName(param1, name, 64);
502 PushArrayString(g_RTVMapList, map);
503 RemoveMenuItem(menu, param2);
505 g_Nominated[param1] = true;
507 PrintToChatAll("[SM] %t", "Map Nominated", name, map);
514 if (g_MapMenu != INVALID_HANDLE)
516 CloseHandle(g_MapMenu);
517 g_MapMenu = INVALID_HANDLE;
520 g_MapMenu = CreateMenu(Handler_MapSelectMenu);
521 SetMenuTitle(g_MapMenu, "%t", "Nominate Title");
524 for (new i = 0; i < GetArraySize(g_MapList); i++)
526 GetArrayString(g_MapList, i, map, sizeof(map));
527 AddMenuItem(g_MapMenu, map, map);
530 SetMenuExitButton(g_MapMenu, false);
537 decl String:mapPath[256], String:mapFile[64];
538 GetConVarString(g_Cvar_File, mapFile, 64);
539 BuildPath(Path_SM, mapPath, sizeof(mapPath), mapFile);
540 fileFound = FileExists(mapPath);
543 new Handle:mapCycleFile = FindConVar("mapcyclefile");
544 GetConVarString(mapCycleFile, mapPath, sizeof(mapPath));
545 fileFound = FileExists(mapPath);
550 LogError("Unable to locate sm_rtv_file or mapcyclefile, no maps loaded.");
552 if (g_MapList != INVALID_HANDLE)
554 ClearArray(g_MapList);
560 // If the file hasn't changed, there's no reason to reload
562 new fileTime = GetFileTime(mapPath, FileTime_LastChange);
563 if (g_mapFileTime == fileTime)
565 return GetArraySize(g_MapList);
568 g_mapFileTime = fileTime;
571 if (g_MapList != INVALID_HANDLE)
573 ClearArray(g_MapList);
576 LogMessage("[SM] Loading RTV map file [%s]", mapPath);
578 decl String:currentMap[32];
579 GetCurrentMap(currentMap, sizeof(currentMap));
581 new Handle:file = OpenFile(mapPath, "rt");
582 if (file == INVALID_HANDLE)
584 LogError("[SM] Could not open file: %s", mapPath);
588 decl String:buffer[64], len;
589 while (!IsEndOfFile(file) && ReadFileLine(file, buffer, sizeof(buffer)))
593 if ((len = StrContains(buffer, ".bsp", false)) != -1)
598 if (buffer[0] == '\0' || !IsValidConVarChar(buffer[0]) || !IsMapValid(buffer)
599 || strcmp(currentMap, buffer, false) == 0)
604 PushArrayString(g_MapList, buffer);
608 return GetArraySize(g_MapList);