Skip to content

Commit 965bec3

Browse files
committed
Updated the README
1 parent 285dd6f commit 965bec3

1 file changed

Lines changed: 20 additions & 14 deletions

File tree

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,19 @@ This is a list of menus that implement the UniversalMenuAPI interface natively.
2222

2323
- [CsGals.TeamDeathmatch](https://github.com/CSGALS/CsGals.TeamDeathmatch)
2424

25-
## What about MenuManagerCS2/CS2ScreenMenuAPI/...?
25+
## What about MenuManager/ScreenMenuAPI/...?
2626

27-
Compatibility plugins are provided adapting plugins using other menu APIs to CSSUniversalMenuAPI.
27+
Compatibility plugins are provided, adapting existing plugins that use other menu APIs to CSSUniversalMenuAPI.
28+
Driver plugins are provided, adapting CSSUniversalMenuAPI to other menu APIs.
2829

29-
| Menu API | Compatibility plugin |
30-
|----------|----------------------|
31-
|[CounterStrikeSharp.MenuManager](https://docs.cssharp.dev/api/CounterStrikeSharp.API.Modules.Menu.MenuManager.html)|UniversalMenu.Compat.CSSharp|
32-
|[MenuManagerCS2](https://github.com/NickFox007/MenuManagerCS2)|UniversalMenu.Compat.MenuManagerApi|
33-
|[CS2ScreenMenuAPI](https://github.com/T3Marius/CS2ScreenMenuAPI)|*Not supported*|
34-
|[CS2MenuManager](https://github.com/schwarper/CS2MenuManager)|*Not supported*|
35-
|[WASDMenuAPI](https://github.com/Interesting-exe/WASDMenuAPI)|*Not supported*|
36-
|[oscar-wos/Menu](https://github.com/oscar-wos/Menu)|*Not supported*|
30+
| Menu API | Compatibility plugin | Driver plugin |
31+
|----------|----------------------|---------------|
32+
|[CounterStrikeSharp.MenuManager](https://docs.cssharp.dev/api/CounterStrikeSharp.API.Modules.Menu.MenuManager.html)|UniversalMenu.Compat.CSSharp|*Not supported*|
33+
|[MenuManagerCS2](https://github.com/NickFox007/MenuManagerCS2)|UniversalMenu.Compat.MenuManagerCS2|UniversalMenu.Driver.MenuManagerCS2|
34+
|[CS2ScreenMenuAPI](https://github.com/T3Marius/CS2ScreenMenuAPI)|*Not supported*|UniversalMenu.Compat.ScreenMenuAPI|
35+
|[CS2MenuManager](https://github.com/schwarper/CS2MenuManager)|*Not supported*|*Not supported*|
36+
|[WASDMenuAPI](https://github.com/Interesting-exe/WASDMenuAPI)|*Not supported*|*Not supported*|
37+
|[oscar-wos/Menu](https://github.com/oscar-wos/Menu)|*Not supported*|*Not supported*|
3738

3839
## Where and what to download?
3940

@@ -43,12 +44,17 @@ If all of your server's plugins are all CSSUniversalMenuAPI-native, then you onl
4344

4445
If your server's plugins use other menu APIs, then **either**:
4546

46-
- Download `CSSUniversalMenuAPI.Compat.All.zip` which includes all compatibility plugins for all supported third party APIs.
47+
- Download `CSSUniversalMenuAPI.Compat.All.zip` which includes all compatibility plugins. Use only with native menus installed.
4748
- Download `CSSUniversalMenuAPI.zip` and any appropriate compatibility plugin for the third party menu API you want to support.
4849

49-
> [!WARNING]
50-
> Do not install the compatibility plugins alongside the third party menu plugin, as they will conflict.
51-
> For example, do not install `MenuManagerCS2` and `UniversalMenu.Compat.MenuManagerApi` at the same time.
50+
> [!WARNING]
51+
> Do not install the compat plugin alongside the menu plugin it provides compatibility for.
52+
> Do not install the compat plugin alongside the driver plugin.
53+
>
54+
> Failure to do so will result in conflicts. As an example:
55+
> **Do not** install `UniversalMenu.Compat.MenuManagerCS2` alongside `MenuManagerCS2`.
56+
> **Do not** install `UniversalMenu.Compat.MenuManagerCS2` alongside `UniversalMenu.Driver.MenuManagerCS2`.
57+
> **Do** install `UniversalMenu.Driver.MenuManagerCS2` alongside `MenuManagerCS2`.
5258
5359
## Sample implementations
5460

0 commit comments

Comments
 (0)