Skip to content

Commit eb77ef8

Browse files
committed
misc: Updated README
1 parent b755537 commit eb77ef8

File tree

1 file changed

+50
-12
lines changed

1 file changed

+50
-12
lines changed

README.md

Lines changed: 50 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,16 @@
1-
# ClientCatcher
1+
![ClientCatcher](https://www.bisecthosting.com/images/CF/CLIENT_CATCHER/CLIENT_CATCHER_Header.webp)
2+
23
[![WorkFlow Status](https://img.shields.io/github/actions/workflow/status/4drian3d/ClientCatcher/ClientCatcherBuild.yml)](https://github.com/4drian3d/ClientCatcher/actions/workflows/ClientCatcherBuild.yml)
34
[![Version](https://img.shields.io/github/v/release/4drian3d/ClientCatcher?color=FFF0&style=flat-square)](https://github.com/4drian3d/ClientCatcher/releases)
5+
![](https://img.shields.io/github/downloads/4drian3d/ClientCatcher/total?logo=GitHub&style=flat-square)
46
[![Discord](https://img.shields.io/discord/899740810956910683?color=7289da&label=Discord)](https://discord.gg/5NMMzK5mAn)
5-
![Github Downloads](https://img.shields.io/github/downloads/4drian3d/ClientCatcher/total?logo=GitHub&style=flat-square)
6-
![Modrinth Downloads](https://img.shields.io/modrinth/dt/Dhqd1a7j?logo=Modrinth&style=flat-square)
7+
[![Telegram](https://img.shields.io/badge/Telegram-Support-229ED9)](https://t.me/Adrian3dSupport)
8+
[![Telegram](https://img.shields.io/badge/Telegram-Updates-229ED9)](https://t.me/Adrian3dUpdates)
79

10+
![Description Banner](https://www.bisecthosting.com/images/CF/CLIENT_CATCHER/CLIENT_CATCHER_Description.webp)
811

912
Simple Velocity plugin to get the client with which a player has connected to your server
1013

11-
The plugin is not fully effective, several malicious clients hide their client branding when entering the server or impersonate vanilla clients.
12-
However, the plugin can detect several clients such as Forge, Fabric, LiteLoader, Lunar, Vanilla, and others.
13-
It also detects Forge 1.7.10 - 1.12.2 mods.
14-
15-
If you want to use ClientCatcher in Fabric, you can try https://modrinth.com/mod/clientcatcher-fabric
16-
17-
[![](https://www.bisecthosting.com/partners/custom-banners/6fa909d5-ad2b-42c2-a7ec-1c51f8b6384f.webp)](https://www.bisecthosting.com/4drian3d)
18-
1914
## Commands
2015
#### Permission: `clientcatcher.command`
2116

@@ -34,9 +29,52 @@ Shows you the player's mods, in case he has any installed
3429

3530
Reloads the plugin
3631

32+
## Permissions
33+
34+
#### Bypass Client Detection
35+
36+
`clientcatcher.bypass.brand`
37+
38+
#### Bypass Mod Detection
39+
40+
`clientcatcher.bypass.mods`
41+
42+
![Instalation Banner](https://www.bisecthosting.com/images/CF/CLIENT_CATCHER/CLIENT_CATCHER_Installation.webp)
43+
44+
- Download it from Modrinth
45+
- Download MCKotlin
46+
- Put both plugins in your Velocity proxy
47+
- And configure the plugin to block the mods and clients of your choice
48+
49+
![FAQ Banner](https://www.bisecthosting.com/images/CF/CLIENT_CATCHER/CLIENT_CATCHER_Faq.webp)
50+
51+
The plugin is not fully effective, several malicious clients hide their client branding when entering the server or impersonate vanilla clients.
52+
However, the plugin can detect several clients such as Forge, Fabric, LiteLoader, Lunar, Vanilla, and others.
53+
54+
It also detects Forge 1.7.10 - 1.12.2 mods.
55+
56+
If you want to use ClientCatcher in Fabric, you can try https://modrinth.com/mod/clientcatcher-fabric
57+
3758
## Placeholders
3859

60+
ClientCatcher provides several placeholders for use in other [MiniPlaceholders](https://modrinth.com/plugin/miniplaceholders)-compatible plugins
61+
3962
- `<clientcatcher_client>`
4063
- `<clientcatcher_mods>`
4164
- `<clientcatcher_player_client:(player name)>`
42-
- `<clientcatcher_player_mods:(player name)>`
65+
- `<clientcatcher_player_mods:(player name)>`
66+
67+
## Discord WebHook Configuration
68+
69+
If you have a Discord server on which you want to show alerts of which clients your players are using, you can activate the webhooks module and configure it like this
70+
71+
1. Copy the URL of the WebHook.
72+
2. Extract the ID and Token from the URL.
73+
3. Put those fields in the specific configuration options.
74+
4. Restart your proxy
75+
76+
![Final Webhook result](https://cdn.modrinth.com/data/cached_images/0fe108e5ed7a5ecd33ee67c47798deff5c4d58e5.png)
77+
78+
[![Support Server](https://www.bisecthosting.com/images/CF/CLIENT_CATCHER/CLIENT_CATCHER_Discord.webp)](https://discord.gg/5NMMzK5mAn)
79+
80+
[![Bisect Promo](https://www.bisecthosting.com/images/CF/CLIENT_CATCHER/CLIENT_CATCHER_Promo.webp)](https://www.bisecthosting.com/4drian3d)

0 commit comments

Comments
 (0)