Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history 
Version 1.045* changes
  • Loading branch information
@nickj609
nickj609 authored Jun 27, 2024
1 parent 973c5e2 commit 05cc9f3
Showing 1 changed file with 170 additions and 78 deletions.
248 changes: 170 additions & 78 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Tired of manually managing game modes, settings, and maps?
GameModeManager simplifies server administration for Counter-Strike 2 by providing:

- **Admin menus** for modes, maps, and settings.
- **Automatic rotation** for maps and game modes.
- **Customizable rotation** of maps and game modes.
- **Player voting** for maps, settings, and game modes.
- **Seamless integration** with your existing Rock the Vote (RTV) plugin.
- **Dynamic map list and menu updates** based on the current game mode.
- **Customization options** for settings folders, voting styles, and languages.
- **Dynamic map lists and menus** based on the current game mode or all game modes.
- **Customization options** for rotation schedules, commands, voting styles, and languages.

This plugin is perfect for servers with a variety of custom content or those that want to give players more control over their experience.

Expand Down Expand Up @@ -130,7 +130,6 @@ This plugin is compatible with any RTV plugin using a `maplist.txt` file.

![Screenshot 2024-06-08 213008](https://github.com/nickj609/GameModeManager/assets/32173425/b6a34ec1-277f-4361-bd1c-0e405b20834f)


</details>

## Installation
Expand All @@ -147,8 +146,9 @@ This plugin is compatible with any RTV plugin using a `maplist.txt` file.
### RTV Settings
| Setting | Description |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Enabled | Enables RTV Compatibility. |
| Plugin | Default path for the desired RTV plugin. |
| Enabled | Enables RTV compatibility. |
| Mode | Changes the RTV mode. (0 = maps from current game mode, 1 = maps from all game modes.) |
| Plugin | Default path for the desired RTV plugin (i.e. `/addons/counterstrikesharp/plugins/plugin`) |
| MapList | Default path for the maplist.txt file to update when the map group or game mode changes. |
| DefaultMapFormat | Enables the default format for adding maps to the map list file: `ws:{workshopid}`. When disabled: `{mapname}:{workshopid}`. |

Expand All @@ -164,7 +164,7 @@ This plugin is compatible with any RTV plugin using a `maplist.txt` file.
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Enabled | Enables voting. |
| Maps | Enables map votes. |
| AllMaps | Enables all map votes. |
| AllMaps | Enables all maps votes. |
| GameModes | Enables game mode votes. |
| GameSettings | Enables game setting votes. |
| Style | Changes vote menu type (i.e. "chat" or "center"). |
Expand Down Expand Up @@ -212,123 +212,214 @@ This plugin is compatible with any RTV plugin using a `maplist.txt` file.
<summary><b>Click to see Default Values</b></summary>

```
// This configuration was automatically generated by CounterStrikeSharp for plugin 'GameModeManager', at 2024/06/23 02:51:06
// This configuration was automatically generated by CounterStrikeSharp for plugin 'GameModeManager', at 2024/06/26 03:02:03
{
"Version": 4,
"Version": 5,
"RTV": {
"Enabled": false,
"Mode": 0,
"MapFormat": false,
"Plugin": "addons/counterstrikesharp/plugins/RockTheVote/RockTheVote.dll",
"MapListFile": "addons/counterstrikesharp/plugins/RockTheVote/maplist.txt",
"DefaultMapFormat": false
"MapList": "addons/counterstrikesharp/plugins/RockTheVote/maplist.txt"
},
"Maps": {
"Delay": 2,
"Style": "center",
"Default": "de_dust2"
},
"Votes": {
"Enabled": true,
"Map": true,
"AllMap": true,
"GameMode": true,
"GameSetting": true,
"Enabled": false,
"Maps": false,
"AllMaps": false,
"GameModes": false,
"GameSettings": false,
"Style": "center"
},
"Settings": {
"Enabled": true,
"Folder": "settings",
"Style": "center"
"Style": "center",
"Folder": "settings"
},
"Commands": {
"Map": true
"Map": true,
"Maps": true,
"AllMaps": true,
"TimeLeft": true
},
"MapGroups": {
"Delay": 2,
"Default": "mg_active",
"DefaultMap": "de_dust2",
"Style": "center",
"File": "gamemodes_server.txt"
"Rotation": {
"Cycle": 0,
"MapGroups": [
"mg_active",
"mg_delta"
],
"ModeRotation": true,
"ModeInterval": 4,
"ModeSchedules": false,
"Schedule": [
{
"Time": "10:00",
"Mode": "Casual"
},
{
"Time": "15:00",
"Mode": "Practice"
},
{
"Time": "17:00",
"Mode": "Competitive"
}
]
},
"GameModes": {
"Rotation": true,
"Interval": 4,
"DefaultMode": "Casual",
"Delay": 2,
"Style": "center",
"List": {
"Casual": {
"casual.cfg": [
"Default": "Casual",
"MapGroupFile": "gamemodes_server.txt",
"List": [
{
"Name": "Casual",
"Config": "casual.cfg",
"MapGroups": [
"mg_active",
"mg_delta"
]
},
{
"Name": "Competitive",
"Config": "comp.cfg",
"MapGroups": [
"mg_active",
"mg_hostage"
"mg_delta"
]
},
"Competitive": {
"comp.cfg": [
{
"Name": "Wingman",
"Config": "wingman.cfg",
"MapGroups": [
"mg_active",
"mg_hostage"
"mg_delta"
]
},
"Wingman": {
"wingman.cfg": [
"mg_wingman"
{
"Name": "Practice",
"Config": "prac.cfg",
"MapGroups": [
"mg_prac"
]
},
"Deathmatch": {
"dm.cfg": [
{
"Name": "Deathmatch",
"Config": "dm.cfg",
"MapGroups": [
"mg_dm"
]
},
"Deathmatch Multicfg": {
"dm-multicfg.cfg": [
{
"Name": "Deathmatch Multicfg",
"Config": "dm-multicfg.cfg",
"MapGroups": [
"mg_dm"
]
},
"ArmsRace": {
"ar.cfg": [
"mg_armsrace"
{
"Name": "ArmsRace",
"Config": "armsrace.cfg",
"MapGroups": [
"mg_gg"
]
},
"GunGame": {
"gg.cfg": [
"mg_armsrace"
{
"Name": "GunGame",
"Config": "gg.cfg",
"MapGroups": [
"mg_gg"
]
},
"1v1": {
"1v1.cfg": [
{
"Name": "Retakes",
"Config": "retake.cfg",
"MapGroups": [
"mg_retake"
]
},
{
"Name": "Executes",
"Config": "executes.cfg",
"MapGroups": [
"mg_executes"
]
},
{
"Name": "1v1",
"Config": "1v1.cfg",
"MapGroups": [
"mg_1v1"
]
},
"Aim": {
"aim.cfg": [
{
"Name": "Aim",
"Config": "aim.cfg",
"MapGroups": [
"mg_aim"
]
},
"Bhop": {
"bhop.cfg": [
{
"Name": "Bhop",
"Config": "bhop.cfg",
"MapGroups": [
"mg_bhop"
]
},
"Surf": {
"surf.cfg": [
{
"Name": "Surf",
"Config": "surf.cfg",
"MapGroups": [
"mg_surf"
]
},
"Awp": {
"awp.cfg": [
{
"Name": "KreedZ",
"Config": "kz.cfg",
"MapGroups": [
"mg_kz"
]
},
{
"Name": "Awp",
"Config": "awp.cfg",
"MapGroups": [
"mg_awp"
]
},
"ScoutzKnivez": {
"scoutzknivez.cfg": [
"mg_scoutzknivez"
{
"Name": "Course",
"Config": "course.cfg",
"MapGroups": [
"mg_course"
]
},
"Soccer": {
"soccer.cfg": [
{
"Name": "Hide N Seek",
"Config": "hns.cfg",
"MapGroups": [
"mg_hns"
]
},
{
"Name": "Soccer",
"Config": "soccer.cfg",
"MapGroups": [
"mg_soccer"
]
},
"HE Only": {
"minigames.cfg": [
"mg_he"
{
"Name": "Minigames",
"Config": "minigames.cfg",
"MapGroups": [
"mg_minigames"
]
}
}
]
}
}
```
Expand All @@ -346,7 +437,7 @@ This plugin will display all in-game menus and messaging based on the player's p
"game.menu-title": "Game Commands",
"currentmap.message": "{RED}[Current Map]{DEFAULT} {0}",
"currentmode.message": "{GREEN}[Current Mode]{DEFAULT} {0}",
"changemap.message": "{LIGHTRED}{0}{DEFAULT} has changed the map to {LIGHTRED}{1}{DEFAULT}.",
"changemap.message": "Admin {LIGHTRED}{0}{DEFAULT} has changed the map to {LIGHTRED}{1}{DEFAULT}.",
"changemode.message": "Admin {LIGHTRED}{0}{DEFAULT} has changed the game mode to {LIGHTRED}{1}{DEFAULT}.",
"enable.changesetting.message": "Admin {LIGHTRED}{0}{DEFAULT} has {LIGHTRED}Enabled{DEFAULT} setting {LIGHTRED}{1}{DEFAULT}.",
"disable.changesetting.message": "Admin {LIGHTRED}{0}{DEFAULT} has {LIGHTRED}Disabled{DEFAULT} setting {LIGHTRED}{1}{DEFAULT}.",
Expand All @@ -364,7 +455,15 @@ This plugin will display all in-game menus and messaging based on the player's p
"setting.vote.menu-title": "Change setting {GOLD}{0}{DEFAULT}?",
"setting.show.menu-response": "Say {GREEN}!{0}{DEFAULT} to create a vote.",
"settings.menu-actions": "Setting Actions",
"settings.menu-title": "Setting List"
"settings.menu-title": "Setting List",
"timeleft.prefix": "{RED}[Timeleft]{DEFAULT}",
"timeleft.remaining-rounds": "{0} round(s) remaining",
"timeleft.remaining-time-hour": "Remaining time {0}:{1}:{2}",
"timeleft.remaining-time-minute": "Remaining time {0} minute(s) and {1} second(s)",
"timeleft.remaining-time-second": "Remaining time {0} second(s)",
"timeleft.no-time-limit": "There is no time limit",
"timeleft.remaining-last-round": "This is the last round",
"timeleft.remaining-time-over": "Time is over, this is the last round"
}
```

Expand All @@ -380,17 +479,10 @@ This plugin will display all in-game menus and messaging based on the player's p
<summary><b>Example Log</b></summary>

```
2024-06-08 22:59:32.805 +00:00 [INFO] plugin:GameModeManager Loading map groups...
2024-06-08 22:59:32.821 +00:00 [INFO] plugin:GameModeManager Creating game modes...
2024-06-08 22:59:32.823 +00:00 [INFO] plugin:GameModeManager Loading settings...
2024-06-08 22:59:32.827 +00:00 [WARN] plugin:GameModeManager Skipping random_setting.cfg because its missing the correct prefix.
2024-06-08 22:59:32.835 +00:00 [INFO] plugin:GameModeManager Enabling game mode and map rotations...
2024-06-08 22:59:34.096 +00:00 [INFO] plugin:GameModeManager Registering custom votes...
2024-06-08 23:01:12.832 +00:00 [WARN] plugin:GameModeManager New map group could not be found. Setting default map group.
2024-06-08 23:05:24.421 +00:00 [INFO] plugin:GameModeManager Current map group is mg_active.
2024-06-08 23:05:24.421 +00:00 [INFO] plugin:GameModeManager New map group is mg_active.
2024-06-08 24:15:47.044 +00:00 [INFO] plugin:GameModeManager Game has ended. Picking random map from current map group...
2024-06-08 24:17:76.044 +00:00 [INFO] plugin:GameModeManager Deregistering custom votes...
2024-06-08 23:05:24.421 +00:00 [INFO] plugin:GameModeManager New map group is mg_delta.
2024-06-08 24:15:47.044 +00:00 [INFO] plugin:GameModeManager Game has ended. Picking random map from current mode...
```

</details>
Expand Down

0 comments on commit 05cc9f3

Please sign in to comment.