Skip to content

CS2MenuManager is a flexible and user-friendly menu system developed for Counter-Strike 2 using the CounterStrikeSharp library. This project provides server administrators and developers with the ability to create customisable menus. It is easy to use for players and easy to configure and extend for administrators.

License

Notifications You must be signed in to change notification settings

schwarper/CS2MenuManager

Repository files navigation

CS2MenuManager is a modern, extensible and easy to use menu system for Counter-Strike 2 based on the CounterStrikeSharp library. It provides server administrators and developers with powerful tools to create interactive and customisable menu interfaces. Designed for both ease of use and flexibility, it provides intuitive controls for players and easy configuration for administrators.

If you would like to donate or need assistance with the plugin, feel free to contact me via Discord, either privately or on my server.

Discord nickname: schwarper

Discord link : Discord server

You can buy me a coffee

Nuget

NuGet Badge NuGet-Badge

Installation

  1. Download:
  1. Install the files:
  • Extract the contents of the downloaded ZIP file to the addons/counterstrikesharp/ folder.
  1. Configure the settings:
  • Adjust the settings in the config.toml file in the addons/counterstrikesharp/shared/CS2MenuManager/ directory.
  1. Restart server:
  • Restart your server for the changes to take effect. You will need to use this API in your plugins.

Creating Menus

You can create any type of menu. All menu types have a similar structure. Here's an example of how to create a Chat Menu:

Supported menus: ChatMenu, ConsoleMenu, CenterHtmlMenu, WasdMenu, PanoramaVote, PlayerMenu

ChatMenu menu = new("Title", this);

menu.AddItem("Option 1", (p, o) =>
{
    p.PrintToChat("You selected option 1");
});

menu.AddItem("Option 2X", DisableOption.DisableShowNumber);
menu.AddItem("Option 3X", DisableOption.DisableHideNumber);

menu.Display(player);

Adding Submenus

You can add submenus to any menu. Here's how to link a submenu:

menu.PrevMenu = AnySubMenu();

private static CenterHtmlMenu AnySubMenu()
{
    CenterHtmlMenu menu = new("Title", this);
    //...
    return menu;
}

Post-Select Actions

You can set the behavior after selecting an option using PostSelectAction. The default is to close the menu after selection.

menu.AddItem("Option After Reset", (p, o) =>
{
    o.PostSelectAction = PostSelectAction.Reset;
});

Setting Menu Time

You can set the time for the menu. When the time is up, the menu is automatically closed.

menu.Display(menu, 10);
// OR
ConsoleMenu menu = new("Console Menu", this)
{
    MenuTime = 20
};

Creating and opening the menu selected by the player

The title may not be very descriptive. You can use the PlayerMenu class to show the player the menu that the player has chosen. In other words, the player chooses which menu to open. He can do this with !mm or the command you set. You need to have the CS2MenuManager_MenuManager plugin installed and a database connection.

PlayerMenu menu = new(Localizer.ForPlayer(player, "MenuManager Title"), this);

menu.AddItem(Localizer.ForPlayer(player, "Change Resolution"), (p, o) =>
{
    ResolutionManager.ResolutionMenuByType(typeof(PlayerMenu), player, this, menu)
        .Display(player, 0);
});

menu.AddItem(Localizer.ForPlayer(player, "Change Menu Type"), (p, o) =>
{
    MenuTypeManager.MenuTypeMenuByType(typeof(PlayerMenu), player, this, menu)
        .Display(player, 0);
});

menu.Display(player, 0);

Panorama Vote Menu

The PanoramaVote menu allows you to create interactive vote menus using the Panorama UI. Here's an example:

var menu = new PanoramaVote("#SFUI_vote_panorama_vote_default", "Hold on, Let me Cook", VoteResultCallback, VoteHandlerCallback, this)
{
    VoteCaller = player // null is the server.
};

menu.DisplayVoteToAll(20);

And callbacks

public bool VoteResultCallback(YesNoVoteInfo info)
{
    /*
    public int TotalVotes;
    public int YesVotes;
    public int NoVotes;
    public int TotalClients;
    public Dictionary<int, (int, int)> ClientInfo = [];
    */

    if (info.YesVotes > info.NoVotes)
    {
        Server.PrintToChatAll("Vote passed!");
        return true;
    }
    
    Server.PrintToChatAll("Vote failed!");
    return false;
}

public void VoteHandlerCallback(YesNoVoteAction action, int param1, CastVote param2)
{
    switch (action)
    {
        case YesNoVoteAction.VoteAction_Start:
            Server.PrintToChatAll("Vote started!");
            break;

        case YesNoVoteAction.VoteAction_Vote:
            var player = Utilities.GetPlayerFromSlot(param1);
            if (player == null) return;
            player.PrintToChat("You voted: " + (param2 == CastVote.VOTE_OPTION1 ? "Yes" : "No"));
            break;

        case YesNoVoteAction.VoteAction_End:
            switch ((YesNoVoteEndReason)param1)
            {
                case YesNoVoteEndReason.VoteEnd_Cancelled:
                    Server.PrintToChatAll("Vote Ended! Cancelled");
                    break;
                case YesNoVoteEndReason.VoteEnd_AllVotes:
                    Server.PrintToChatAll("Vote Ended! Thank you for participating.");
                    break;
                case YesNoVoteEndReason.VoteEnd_TimeUp:
                    Server.PrintToChatAll("Vote Ended! Time is up.");
                    break;
            }
            break;
    }
}

References

This project was prepared with the help of the following sources.

Images

Chat Menu

Chat Menu

Console Menu

Console Menu

CenterHtmlMenu

CenterHtmlMenu

Wasd Menu

Wasd Menu

Panorama Vote

Panorama Vote

About

CS2MenuManager is a flexible and user-friendly menu system developed for Counter-Strike 2 using the CounterStrikeSharp library. This project provides server administrators and developers with the ability to create customisable menus. It is easy to use for players and easy to configure and extend for administrators.

Resources

License

Stars

Watchers

Forks

Languages