From a987ed972a9b5eb1bb1ffe182bf0cb31edc5ef9e Mon Sep 17 00:00:00 2001 From: crashzk Date: Sun, 19 Nov 2023 19:20:33 -0300 Subject: [PATCH] Update README.md --- README.md | 59 +++++++++++++++++++++++++++---------------------------- 1 file changed, 29 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 2d8ec845..1b003152 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,30 @@ -# cs2-WeaponPaints +# CS2 Weapon Paints -### Description -Unfinished, unoptimized and not fully functional ugly demo weapon paints plugin for [CSSharp](https://docs.cssharp.dev/). -There will be a lot of frequent changes which may break functionality or compatibility. You have been warned! +## Description +Unfinished, unoptimized and not fully functional ugly demo weapon paints plugin for **[CSSharp](https://docs.cssharp.dev/)**. -## Created [Discord server](https://discord.gg/mwEQppJ5AT) where you can discus about plugin. +***Note: There will be a lot of frequent changes which may break functionality or compatibility. You have been warned!*** + +### Created [Discord server](https://discord.gg/mwEQppJ5AT) where you can discus about plugin. ### Consider to donate instead of buying from unknown sources. -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/E1E2G0P2O) or [Donate on Steam](https://steamcommunity.com/tradeoffer/new/?partner=41515647&token=gW2W-nXE) +[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/E1E2G0P2O) or [![Donate on Steam](https://github.com/Nereziel/cs2-WeaponPaints/assets/32937653/a0d53822-4ca7-4caf-83b4-e1a9b5f8c94e)](https://steamcommunity.com/tradeoffer/new/?partner=41515647&token=gW2W-nXE) -### Features -- changes only paint, seed and wear on weapons and knives -- mysql based or global website at [weaponpaints.fun](https://weaponpaints.fun/), so you dont need mysql/website -- data sync on player connect -- Added command `!wp` to refresh skins (with cooldown in second can be configured) -- Added command `!ws` to show website -- Added command `!knife` to show menu with knives -- Knife change is now limited to have these cvars empty `mp_t_default_melee ""` and `mp_ct_default_melee ""` +## Features +- Changes only paint, seed and wear on weapons and knives; +- MySQL based or global website at [weaponpaints.fun](https://weaponpaints.fun/), so you dont need MySQL/Website; +- Data sync on player connect; +- Added command **`!wp`** to refresh skins; ***(with cooldown in second can be configured)*** +- Added command **`!ws`** to show website; +- Added command **`!knife`** to show menu with knives; +- Knife change is now limited to have these cvars empty **`mp_t_default_melee ""`** and **`mp_ct_default_melee ""`**; -### CS2 server: -- compile and copy plugin to plugins. Info here [https://docs.cssharp.dev/guides/hello-world-plugin/](https://docs.cssharp.dev/guides/hello-world-plugin/) -- setup `addons/counterstrikesharp/configs/plugins/WeaponPaints/WeaponPaints.json` - set `GlobalShare` to true for global, or include database credentials -- in `addons/counterstrikesharp/configs/core.json` set **FollowCS2ServerGuidelines** to **false** +## CS2 Server +- Compile and copy plugin to plugins, [more info here](https://docs.cssharp.dev/guides/hello-world-plugin/); +- Setup **`addons/counterstrikesharp/configs/plugins/WeaponPaints/WeaponPaints.json`** set **`GlobalShare`** to **`true`** for global, or include database credentials; +- in **`addons/counterstrikesharp/configs/core.json`** set **FollowCS2ServerGuidelines** to **`false`**; -### Plugin configuration: +## Plugin Configuration
Spoiler warning 
{
@@ -65,19 +65,18 @@ There will be a lot of frequent changes which may break functionality or compati
 }
-### Web install: -- not needed if config `GlobalShare = true` -- requires PHP min v7.3 (tested on php ver `8.2.3` and nginx webserver) -- copy website to web server (img folder not needed) -- import `database.sql` to mysql -- get steam api key [https://steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey) -- fill in database credentials and api key in `class/config.php` -- visit website and login via steam +## Web install +Disregard if the config is **`GlobalShare = true`**; +- Requires PHP min v7.3; ***(Tested on php ver **`8.2.3`** and nginx webserver)*** +- Copy website to web server; ***(Folder `img` not needed)*** +- Get [Steam API Key](https://steamcommunity.com/dev/apikey); +- Fill in database credentials and api key in `class/config.php`; +- Visit website and login via steam; -### Known issues +## Known issues - Issue on Windows servers, no knives are given. ### Use this plugin at your own risk! Using this may lead to GSLT ban or something else Valve come with. [Valve Server guidelines](https://blog.counter-strike.net/index.php/server_guidelines/) -### Preview +## Preview ![preview](https://github.com/Nereziel/cs2-WeaponPaints/blob/main/website/preview.png?raw=true)