GarpBot/CS2-SimpleAdmin
1
0
Fork 0
mirror of https://github.com/daffyyyy/CS2-SimpleAdmin.git synced 2026-02-18 10:43:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add CS2-SimpleAdmin documentation site

Browse Source 
Introduces a new documentation site for CS2-SimpleAdmin using Docusaurus, including developer API references, tutorials, user guides, and module documentation. Removes the CleanModule example and updates FunCommands and ExampleModule. Also updates main plugin and API files to support new documentation and module structure.
This commit is contained in:
Dawid Bepierszcz
2025-10-20 01:27:01 +02:00
parent 21a5de6b3d
commit b0d8696756
74 changed files with 32732 additions and 279 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
Modules/CS2-SimpleAdmin_FunCommands/CS2-SimpleAdminApi.dll
View File

Binary file not shown.

2
Modules/CS2-SimpleAdmin_FunCommands/CS2-SimpleAdmin_FunCommands/CS2-SimpleAdmin_FunCommands.cs
View File

@@ -370,7 +370,7 @@ public partial class CS2_SimpleAdmin_FunCommands : BasePlugin, IPluginConfig<Con
// Register menus with command names for permission override support
// Server admins can override default permissions via CounterStrikeSharp admin system
// Example: If "css_god" is overridden to "@css/vip", only VIPs will see the God Mode menu
// Example: If "css_god" is overdden to "@css/vip", only VIPs will see the God Mode menu
if (Config.GodCommands.Count > 0)
_sharedApi.RegisterMenu("fun", "god",

91
Modules/CS2-SimpleAdmin_FunCommands/CS2-SimpleAdmin_FunCommands/Menus.cs
View File

@@ -27,6 +27,35 @@ namespace CS2_SimpleAdmin_FunCommands;
/// "css_god"); // Command name for override checking
///
/// This means developers don't need to manually check permissions in their menu factory methods!
///
/// MENU CONTEXT API (NEW!):
/// ========================
/// Menu factory methods now receive a MenuContext parameter that contains:
/// - CategoryId: The category this menu belongs to (e.g., "fun")
/// - MenuId: The unique identifier for this menu (e.g., "god")
/// - MenuTitle: The display title from registration (e.g., "God Mode")
/// - Permission: The default permission (e.g., "@css/cheats")
/// - CommandName: The command name for override checking (e.g., "css_god")
///
/// This eliminates duplication when creating menus - you no longer need to repeat
/// the title and category in both RegisterMenu() and CreateMenuWithPlayers()!
///
/// Before (old API):
/// private object CreateGodModeMenu(CCSPlayerController admin)
/// {
/// return _sharedApi.CreateMenuWithPlayers(
/// "God Mode", // ← Duplicated from RegisterMenu
/// "fun", // ← Duplicated from RegisterMenu
/// admin, filter, action);
/// }
///
/// After (new API with MenuContext):
/// private object CreateGodModeMenu(CCSPlayerController admin, MenuContext context)
/// {
/// return _sharedApi.CreateMenuWithPlayers(
/// context, // ← Contains both title and category automatically!
/// admin, filter, action);
/// }
/// </summary>
public partial class CS2_SimpleAdmin_FunCommands
{
@@ -39,22 +68,21 @@ public partial class CS2_SimpleAdmin_FunCommands
/// <summary>
/// Creates a simple player selection menu for god mode.
/// PATTERN: CreateMenuWithPlayers with method reference
/// IMPROVED: Uses MenuContext to eliminate duplication of title and category
/// </summary>
private object CreateGodModeMenu(CCSPlayerController admin)
private object CreateGodModeMenu(CCSPlayerController admin, CS2_SimpleAdminApi.MenuContext context)
{
return _sharedApi!.CreateMenuWithPlayers(
Localizer?["fun_menu_god"] ?? "God Mode", // Menu title from translation
"fun", // Category ID (for back button navigation)
context, // ← Context contains title & category automatically!
admin, // Admin opening the menu
player => player.PlayerPawn?.Value?.LifeState == (int)LifeState_t.LIFE_ALIVE && admin.CanTarget(player), // Filter: only alive, targetable players
God); // Action to execute (method reference)
}
private object CreateNoClipMenu(CCSPlayerController admin)
private object CreateNoClipMenu(CCSPlayerController admin, CS2_SimpleAdminApi.MenuContext context)
{
return _sharedApi!.CreateMenuWithPlayers(
Localizer?["fun_menu_noclip"] ?? "No Clip",
"fun",
context,
admin,
player => player.PlayerPawn?.Value?.LifeState == (int)LifeState_t.LIFE_ALIVE && admin.CanTarget(player),
NoClip);
@@ -63,13 +91,13 @@ public partial class CS2_SimpleAdmin_FunCommands
/// <summary>
/// Creates a player selection menu for respawn command.
/// PATTERN: CreateMenuWithPlayers with method reference
/// IMPROVED: Uses MenuContext to eliminate duplication
/// </summary>
private object CreateRespawnMenu(CCSPlayerController admin)
private object CreateRespawnMenu(CCSPlayerController admin, CS2_SimpleAdminApi.MenuContext context)
{
return _sharedApi!.CreateMenuWithPlayers(
Localizer?["fun_menu_respawn"] ?? "Respawn", // Menu title from translation
"fun", // Category ID
admin, // Admin
context,
admin,
admin.CanTarget, // Filter: only targetable players (no LifeState check - can respawn dead players)
Respawn); // Use the Respawn method which includes death position teleport
}
@@ -83,12 +111,12 @@ public partial class CS2_SimpleAdmin_FunCommands
/// <summary>
/// Creates a nested menu: Player selection → Weapon selection.
/// PATTERN: CreateMenuWithBack + foreach + AddSubMenu
/// IMPROVED: Uses MenuContext - no more duplication of title/category!
/// </summary>
private object CreateGiveWeaponMenu(CCSPlayerController admin)
private object CreateGiveWeaponMenu(CCSPlayerController admin, CS2_SimpleAdminApi.MenuContext context)
{
var menu = _sharedApi!.CreateMenuWithBack(
Localizer?["fun_menu_give"] ?? "Give Weapon",
"fun",
context, // ← Context contains title & category!
admin);
var players = _sharedApi.GetValidPlayers().Where(p =>
p.PlayerPawn?.Value?.LifeState == (int)LifeState_t.LIFE_ALIVE && admin.CanTarget(p));
@@ -134,11 +162,10 @@ public partial class CS2_SimpleAdmin_FunCommands
return weaponMenu;
}
private object CreateStripWeaponsMenu(CCSPlayerController admin)
private object CreateStripWeaponsMenu(CCSPlayerController admin, CS2_SimpleAdminApi.MenuContext context)
{
return _sharedApi!.CreateMenuWithPlayers(
Localizer?["fun_menu_strip"] ?? "Strip Weapons",
"fun",
context,
admin,
player => player.PlayerPawn?.Value?.LifeState == (int)LifeState_t.LIFE_ALIVE && admin.CanTarget(player),
(adminPlayer, targetPlayer) =>
@@ -148,11 +175,10 @@ public partial class CS2_SimpleAdmin_FunCommands
});
}
private object CreateFreezeMenu(CCSPlayerController admin)
private object CreateFreezeMenu(CCSPlayerController admin, CS2_SimpleAdminApi.MenuContext context)
{
return _sharedApi!.CreateMenuWithPlayers(
Localizer?["fun_menu_freeze"] ?? "Freeze",
"fun",
context,
admin,
player => player.PlayerPawn?.Value?.LifeState == (int)LifeState_t.LIFE_ALIVE && admin.CanTarget(player),
(adminPlayer, targetPlayer) => { Freeze(adminPlayer, targetPlayer, -1); });
@@ -161,13 +187,12 @@ public partial class CS2_SimpleAdmin_FunCommands
/// <summary>
/// Creates a nested menu for setting player HP with predefined values.
/// PATTERN: Same as Give Weapon (player selection → value selection)
/// This is a common pattern you'll use frequently!
/// IMPROVED: Uses MenuContext - cleaner and less error-prone!
/// </summary>
private object CreateSetHpMenu(CCSPlayerController admin)
private object CreateSetHpMenu(CCSPlayerController admin, CS2_SimpleAdminApi.MenuContext context)
{
var menu = _sharedApi!.CreateMenuWithBack(
Localizer?["fun_menu_hp"] ?? "Set HP",
"fun",
context,
admin);
var players = _sharedApi.GetValidPlayers().Where(p =>
p.PlayerPawn?.Value?.LifeState == (int)LifeState_t.LIFE_ALIVE && admin.CanTarget(p));
@@ -212,11 +237,10 @@ public partial class CS2_SimpleAdmin_FunCommands
return hpSelectionMenu;
}
private object CreateSetSpeedMenu(CCSPlayerController admin)
private object CreateSetSpeedMenu(CCSPlayerController admin, CS2_SimpleAdminApi.MenuContext context)
{
var menu = _sharedApi!.CreateMenuWithBack(
Localizer?["fun_menu_speed"] ?? "Set Speed",
"fun",
context,
admin);
var players = _sharedApi.GetValidPlayers().Where(p =>
p.PlayerPawn?.Value?.LifeState == (int)LifeState_t.LIFE_ALIVE && admin.CanTarget(p));
@@ -273,11 +297,10 @@ public partial class CS2_SimpleAdmin_FunCommands
return speedSelectionMenu;
}
private object CreateSetGravityMenu(CCSPlayerController admin)
private object CreateSetGravityMenu(CCSPlayerController admin, CS2_SimpleAdminApi.MenuContext context)
{
var menu = _sharedApi!.CreateMenuWithBack(
Localizer?["fun_menu_gravity"] ?? "Set Gravity",
"fun",
context,
admin);
var players = _sharedApi.GetValidPlayers().Where(p =>
p.PlayerPawn?.Value?.LifeState == (int)LifeState_t.LIFE_ALIVE && admin.CanTarget(p));
@@ -324,11 +347,10 @@ public partial class CS2_SimpleAdmin_FunCommands
return gravitySelectionMenu;
}
private object CreateSetMoneyMenu(CCSPlayerController admin)
private object CreateSetMoneyMenu(CCSPlayerController admin, CS2_SimpleAdminApi.MenuContext context)
{
var menu = _sharedApi!.CreateMenuWithBack(
Localizer?["fun_menu_money"] ?? "Set Money",
"fun",
context,
admin);
var players = _sharedApi.GetValidPlayers().Where(p => admin.CanTarget(p));
@@ -366,11 +388,10 @@ public partial class CS2_SimpleAdmin_FunCommands
return moneySelectionMenu;
}
private object CreateSetResizeMenu(CCSPlayerController admin)
private object CreateSetResizeMenu(CCSPlayerController admin, CS2_SimpleAdminApi.MenuContext context)
{
var menu = _sharedApi!.CreateMenuWithBack(
Localizer?["fun_menu_resize"] ?? "Resize Player",
"fun",
context,
admin);
var players = _sharedApi.GetValidPlayers().Where(p =>
p.PlayerPawn?.Value?.LifeState == (int)LifeState_t.LIFE_ALIVE && admin.CanTarget(p));

56
Modules/CS2-SimpleAdmin_FunCommands/README.md
View File

@@ -168,23 +168,35 @@ private void God(CCSPlayerController? caller, CCSPlayerController player)
**Key Concepts Demonstrated:**
#### Simple Player Selection Menu
#### Simple Player Selection Menu (NEW API with MenuContext!)
```csharp
private object CreateGodModeMenu(CCSPlayerController admin)
// 🆕 NEW: Factory receives MenuContext - no more duplication!
private object CreateGodModeMenu(CCSPlayerController admin, MenuContext context)
{
// ✅ BEST PRACTICE: Use CreateMenuWithPlayers for simple player selection
return _sharedApi!.CreateMenuWithPlayers("God Mode", "fun", admin,
// ✅ BEST PRACTICE: Use context instead of repeating title and category
return _sharedApi!.CreateMenuWithPlayers(
context, // ← Contains "God Mode" title and "fun" category automatically!
admin,
player => player.PlayerPawn?.Value?.LifeState == (int)LifeState_t.LIFE_ALIVE && admin.CanTarget(player),
God); // Direct method reference
God); // Direct method reference
}
```
#### Nested Menu with Value Selection
**Why MenuContext is better:**
- ❌ **Before:** You had to type `"God Mode"` and `"fun"` twice (in `RegisterMenu` and `CreateMenuWithPlayers`)
- ✅ **After:** Context contains these values automatically - no duplication!
- ✅ Less error-prone (can't accidentally use wrong category)
- ✅ Easier to refactor (change title in one place)
#### Nested Menu with Value Selection (NEW API!)
```csharp
private object CreateSetHpMenu(CCSPlayerController admin)
// 🆕 NEW: Uses MenuContext to eliminate duplication
private object CreateSetHpMenu(CCSPlayerController admin, MenuContext context)
{
// ✅ BEST PRACTICE: Use CreateMenuWithBack for menus with back button
var menu = _sharedApi!.CreateMenuWithBack("Set HP", "fun", admin);
// ✅ BEST PRACTICE: Use context instead of manual title/category
var menu = _sharedApi!.CreateMenuWithBack(context, admin);
var players = _sharedApi.GetValidPlayers().Where(p =>
p.PlayerPawn?.Value?.LifeState == (int)LifeState_t.LIFE_ALIVE && admin.CanTarget(p));
@@ -200,6 +212,7 @@ private object CreateSetHpMenu(CCSPlayerController admin)
private object CreateHpSelectionMenu(CCSPlayerController admin, CCSPlayerController target)
{
// Note: Submenus don't receive context - they create their own titles dynamically
var hpMenu = _sharedApi!.CreateMenuWithBack($"Set HP: {target.PlayerName}", "fun", admin);
var hpValues = new[] { 1, 10, 25, 50, 100, 200, 500, 999 };
@@ -221,6 +234,31 @@ private object CreateHpSelectionMenu(CCSPlayerController admin, CCSPlayerControl
}
```
**Comparison: Old vs New API**
```csharp
// ❌ OLD API - lots of duplication
_sharedApi.RegisterMenu("fun", "god", "God Mode", CreateGodModeMenu, "@css/cheats", "css_god");
private object CreateGodModeMenu(CCSPlayerController admin)
{
return _sharedApi.CreateMenuWithPlayers(
"God Mode", // ← Repeated from RegisterMenu
"fun", // ← Repeated from RegisterMenu
admin, filter, action);
}
// ✅ NEW API - no duplication!
_sharedApi.RegisterMenu("fun", "god", "God Mode", CreateGodModeMenu, "@css/cheats", "css_god");
private object CreateGodModeMenu(CCSPlayerController admin, MenuContext context)
{
return _sharedApi.CreateMenuWithPlayers(
context, // ← Contains title and category automatically!
admin, filter, action);
}
```
### 6. Translations
**Key Concept:** Module-specific translations