Skip to content
This repository has been archived by the owner on Oct 22, 2024. It is now read-only.

Home

Jump to bottom
K4ryuu edited this page May 3, 2024 · 13 revisions

About The Project

K4-Systems is a plugin that enhances the server with features such as a playtime tracker, statistical records, and player ranks. Additionally, it includes VIP functions and admin commands for added functionality.

Key Features​

  • 100% Translatable: Multiple languages are already included in the package.
  • Matchmaking Rank on Scoreboard: Use premier points or matchmaking ranks with the rank module.
  • Country Tags: GeoLocation based country tags to the scoreboard before the rank.
  • Playtime Tracker Module: Tracks playtime for CT, T, Alive, Death, and Spectator, providing overall statistics.
  • Ranks by Points: Numerous events added, allowing fully customizable points for ranking.
  • DynamicPoints: Offers fair point modifications to players based on their skill level.
  • Advanced Statistics: Includes a comprehensive list of statistics below.
  • Scoreboard Ranks: Points by rank points or permissions such as flags, groups or custom overrides
  • LevelRanks Database Support: Supported for old web panels.
  • Custom Web Panels: Designed by third-party authors; appreciation for their contributions.
  • Admin Commands: Modify ranks using commands such as @all, @t, @ct, @alive, with support for targeting by name.
  • Player Commands: Usefull commands for your player such as !admins with permission based admin name coloring and so
  • Full Free-For-All (FFA) Mode Support
  • Continuously Growing Feature List: Regularly updated and maintained to expand functionalities.
  • Optimized for High Player Load: Performance tailored to handle heavy player traffic and maintain stability.
  • Full MySQL Store Mechanism: Utilizes a complete MySQL storage system for efficient and reliable data management.
  • Online Admin Listing: Let your players list online admins. You can set colors for each admin rank separately In the list.

Dependencies​

To use this server addon, you'll need the following dependencies installed:

  • CounterStrikeSharp: CounterStrikeSharp allows you to write server plugins in C# for Counter-Strike 2/Source2/CS2
  • MySQL Database (Version 5.2 or higher): This project requires a MySQL database to store and manage data. You can host your own MySQL server or use a third-party hosting service. Make sure it's at least version 5.2 or higher.

Getting Started​​

Follow these steps in order to properly install the addon to your gameserver.

Prerequisites

Before you begin, ensure you have the following prerequisites:

  • A working CS2 (Counter-Strike 2) server.
  • CounterStrikeSharp is up to date and is running on your server.
  • A compatible MySQL database (Version 5.2 or higher) set up and configured properly.

Installation

  • Download the Addon: Start by downloading the addon from the GitHub Releases Page. Choose the latest release version.
  • Extract the Addon: After downloading, extract the contents of the addon to the counterstrikesharp/plugins directory on your server. Inside the plugins folder, you should have a folder named exactly as the project dll. From the releases, you find it pre zipped with the correct name already.
  • Configuration: The config is being generated after the first start of the plugin, to counterstrikesharp/configs/plugins/{plugin_name}/ folder. You have to setup the database connection by adding your details to the config. After you edit the config you have to restart the server or reload the plugin always.
  • Permissions: You can set the permissions as you need in the counterstrikesharp/configs/admins.json
  • CountryTags: Optionally if you want to use country based clantags, download the latest GeoLite2-Country.mmdb from https://github.com/P3TERX/GeoLite.mmdb/releases and put it to the plugin's folder, then reload the plugin or restart server.

Updating

  • Download the Addon: Download the updated version from GitHub Releases Page. Choose the latest release version.
  • Replace the files: Replace the content of the counterstrikesharp/plugins/{plugin_name} library with the downloaded ones. Make sure you update the translations too if there is any, because it may have changed. After the replace, if you have hotReload enabled on your sever (can be managed at counterstrikesharp/configs/core.json) the server is going to reload the plugin instantly on your server, but that may cause problems and duplicated commands, so I advise to disable that function and restart your server after you update a plugin.
  • Update configs: When the plugin loads and you see a message about the config is being outdated, you should rename the old configs to the current name + ".old". Let the plugin generate a new config file and copy your old values to that. Like this you will have to new config properties without anything missing and you don't have to remake your config.
  • Update GeoLocation Database: Download the latest GeoLite2-Country.mmdb from https://github.com/P3TERX/GeoLite.mmdb/releases and replace in the plugin folder.

Permissions

  • @k4system/vip/points-multiplier VIP Point Multiplier Permission
  • @k4system/admin All K4 Admin Commands

Commands

The commands, that are not listed here, can be managed through the config file.

  • css_givepoints (Admin/Server) > Give points to a player
  • css_removepoints (Admin/Server) > Remove points from a player
  • css_setpoints (Admin/Server) > Sets points a player
  • css_resetdata (Admin/Server) > Reset rank data for a player
  • css_toggletag (Player) > Toggle permission based clantag from being visible on the scoreboard.
  • css_togglepointmsg (Player) > Toggle point modification messages in chat.
Clone this wiki locally