Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
oqyh authored May 18, 2024
1 parent 6fdf338 commit e5d3455
Showing 1 changed file with 89 additions and 41 deletions.
130 changes: 89 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,53 @@
# [CS2] Chat-Logger (1.0.6)
# [CS2] Chat-Logger-GoldKingZ (1.0.7)

### Log Any InGame Chat To Log Text Or Discord WebHook
### Log InGame Chat And Send It To Log Text Or Discord WebHook

![chat](https://github.com/oqyh/cs2-Chat-Logger/assets/48490385/1a57cca9-5892-4014-9587-6ab4f21480bb)
![log](https://github.com/oqyh/cs2-Chat-Logger/assets/48490385/b745d3e6-e78d-4d91-ab6e-e8cbd7864413)
![discord](https://github.com/oqyh/cs2-Chat-Logger/assets/48490385/61e35453-8cc5-440b-a457-51c468fd2f39)
![ingame](https://github.com/oqyh/cs2-Chat-Logger-GoldKingZ/assets/48490385/c9f6012b-06f2-4bd5-a215-2f49128d1cba)

![text](https://github.com/oqyh/cs2-Chat-Logger-GoldKingZ/assets/48490385/fade3be6-54a9-49e9-82e5-1b9c6cf55280)

![Mode1](https://github.com/oqyh/cs2-Chat-Logger-GoldKingZ/assets/48490385/fdae2251-9aea-45a8-a37c-5ec2de8bfbdd)

![Mode5](https://github.com/oqyh/cs2-Chat-Logger-GoldKingZ/assets/48490385/7811046a-2b76-4758-8298-f701b45c28a7)


## .:[ Dependencies ]:.
[Metamod:Source (2.x)](https://www.sourcemm.net/downloads.php/?branch=master)

[CounterStrikeSharp](https://github.com/roflmuffin/CounterStrikeSharp/releases)

[Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json) (Discord WebHook)

[Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json)

## .:[ Configuration ]:.

> [!CAUTION]
> Config Located In ..\addons\counterstrikesharp\plugins\Chat-Logger-GoldKingZ\config\config.json
>
```json
{
//Enable Logging Text Located In Chat-Logger-GoldKingZ/logs/ ?
"Text_EnableLoggingMessages": false,

//Log Only Team Chat Messages?
"Text_PrivateTeamMessagesOnly": false,

//Include These Group From Logging Only "" Means Everyone
"IncludeMessageGroups": "",
//Exclude These Group From Logging
"ExcludeMessageGroups": "#css/vip1,@css/vip1",
"Text_IncludeFlagsMessagesOnly": "",

//Exclude These Group From Logging Only "" Means Everyone
"Text_ExcludeFlagsMessages": "@css/exclude,#css/exclude",

//Exclude Message if begin "!" or "." or "/"
"ExcludeMessageContains": "!./",
"Text_ExcludeMessageContains": "!./",

//Exclude Message If Contains Less Than X Letters
"ExcludeMessageContainsLessThanXLetters": 0,
//Exclude Dublicated Messages
"ExcludeMessageDuplicate": false,
"Text_ExcludeMessageContainsLessThanXLetters": 0,

//-----------------------------------------------------------------------------------------
//Exclude Dublicated Messages
"Text_ExcludeMessageDuplicate": false,

// you can use these in LogChatFormat and LogDiscordChatFormat
//Log Message Format
//{TIME} == Time
//{DATE} == Date
//{MESSAGE} == Player Message
Expand All @@ -42,44 +58,76 @@
//{STEAMID32} = 245821265
//{STEAMID64} = 76561198206086993
//{IP} = 127.0.0.0
"Text_MessageFormat": "[{TIME}] [{STEAMID}] {TEAM} ({PLAYERNAME}) {MESSAGE}",

//If Its Enabled Logs Will Located in ../addons/counterstrikesharp/plugins/Chat_Logger/logs/
"SendLogToText": true,
//How Message You Wanted To Be
"LogChatFormat": "[{TIME}] [{STEAMID}] {TEAM} ({PLAYERNAME}) {MESSAGE}",
//Log File Format .txt or .pdf ect...
"LogFileFormat": ".txt",
//Date and Time Formate
"LogFileDateFormat": "MM-dd-yyyy",
"LogInsideFileTimeFormat": "HH:mm:ss",
"Text_DateFormat": "MM-dd-yyyy",
"Text_TimeFormat": "HH:mm:ss",

//Auto Delete Logs If More Than X (Days) Old
"AutoDeleteLogsMoreThanXdaysOld": 0,
"Text_AutoDeleteLogsMoreThanXdaysOld": 0,

//-----------------------------------------------------------------------------------------

//Send Log To Discord Via WebHookURL
//SendLogToWebHook (1) = Text Only
//SendLogToWebHook (2) = Text With + Name + Hyperlink To Steam Profile
//SendLogToWebHook (3) = Text With + Name + Hyperlink To Steam Profile + Profile Picture
"SendLogToWebHook": 0,
//If SendLogToWebHook (2) or SendLogToWebHook (3) How Would You Side Color Message To Be Check (https://www.color-hex.com/) For Colors
"SideColorMessage": "#00FFFF",
//Discord WebHook
"WebHookURL": "https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
//How Message You Wanted To Be
"LogDiscordChatFormat": "[{DATE} - {TIME}] {TEAM} {MESSAGE} (IpAddress: {IP})",
//If Player Doesnt Have Profile Picture
"UsersWithNoAvatarImage": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/b5/b5bd56c1aa4644a474a2e4972be27ef9e82e517e_full.jpg",

//-----------------------------------------------------------------------------------------
// (0) = Disable
// (1) = Text Only (Result Image : https://github.com/oqyh/cs2-Chat-Logger-GoldKingZ/blob/main/Resources/Mode1.png?raw=true)
// (2) = Text With + Name + Hyperlink To Steam Profile (Result Image : https://github.com/oqyh/cs2-Chat-Logger-GoldKingZ/blob/main/Resources/Mode2.png?raw=true)
// (3) = Text With + Name + Hyperlink To Steam Profile + Profile Picture (Result Image : https://github.com/oqyh/cs2-Chat-Logger-GoldKingZ/blob/main/Resources/Mode3.png?raw=true)
// (4) = Text With + Name + Hyperlink To Steam Profile + Profile Picture + Saparate Date And Time From Message (Result Image : https://github.com/oqyh/cs2-Chat-Logger-GoldKingZ/blob/main/Resources/Mode4.png?raw=true)
// (5) = Text With + Name + Hyperlink To Steam Profile + Profile Picture + Saparate Date And Time From Message + Server Ip In Footer (Result Image : https://github.com/oqyh/cs2-Chat-Logger-GoldKingZ/blob/main/Resources/Mode5.png?raw=true)
"Discord_EnableLoggingMessagesOnMode": 0,

//Send Only Team Chat Messages?
"Discord_PrivateTeamMessagesOnly": false,

//Include These Group From Logging Only "" Means Everyone
"Discord_IncludeFlagsMessagesOnly": "",

//Exclude These Group From Logging Only "" Means Everyone
"Discord_ExcludeFlagsMessages": "@css/exclude,#css/exclude",

//Exclude Message if begin "!" or "." or "/"
"Discord_ExcludeMessageContains": "!./",

//Exclude Message If Contains Less Than X Letters
"Discord_ExcludeMessageContainsLessThanXLetters": 0,

//Exclude Dublicated Messages
"Discord_ExcludeMessageDuplicate": false,

//Discord Message Format
"Discord_MessageFormat": "[{TIME}] [{STEAMID}] {TEAM} ({PLAYERNAME}) {MESSAGE}",

//Date and Time Formate
"Discord_DateFormat": "MM-dd-yyyy",
"Discord_TimeFormat": "HH:mm:ss",

//If Discord_EnableLoggingMessagesOnMode (2) or (3) or (4) or (5) How Would You Side Color Message To Be Check (https://www.color-hex.com/) For Colors
"Discord_SideColor": "00FFFF",

//Discord WebHookURL
"Discord_WebHookURL": "https://discord.com/api/webhooks/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

////If Discord_EnableLoggingMessagesOnMode (3) or (4) or (5) And Player Doesn't Have Profile Picture Which Picture Do You Like To Be Replaced
"Discord_UsersWithNoAvatarImage": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/b5/b5bd56c1aa4644a474a2e4972be27ef9e82e517e_full.jpg",

//If Discord_EnableLoggingMessagesOnMode (5) Image Url Footer
"Discord_FooterImage": "https://github.com/oqyh/cs2-Chat-Logger-GoldKingZ/blob/main/Resources/serverip.png?raw=true",

"ConfigVersion": 1
}
```


## .:[ Change Log ]:.
```
(1.0.7)
-Upgrade Net.7 To Net.8
-Fix Some Bugs
-Rework Chat Logger
-Added Modes To SendLogToWebHook 4 and 5
-Added Discord_FooterImage
-Saparate Discord Log From Text Log
(1.0.6)
-Fix Some Bugs
-Fix AutoDeleteLogsMoreThanXdaysOld
Expand Down

0 comments on commit e5d3455

Please sign in to comment.