/K4-System

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.

Primary LanguageC#GNU General Public License v3.0GPL-3.0

GitHub tag (with filter) GitHub Repo stars GitHub issues GitHub GitHub contributors GitHub all releases GitHub last commit (branch)


K4ryuu

K4-System

An awesome CS2 server addon created with CounterStrikeSharp

Download · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

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.

(back to top)

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.

(back to top)

Support My Work

I offer various ways to support my journey:

  • 💬 Request Private Paid Jobs: Got a specific project in mind? Let's chat, and I'll provide a quote.
  • 🎁 Subscribe to My Tiers: Join one of my subscription tiers for exclusive benefits, early access to projects, and personalized support.
  • ☕ Buy Me a Coffee: One-time donations keep me motivated and my creativity flowing.
  • 💼 Shop from My Paid Resources: Explore and purchase resources I've crafted for private use.

Your support keeps my creative engine running and allows me to share knowledge with the community. Thanks for being part of my journey.

(back to top)

Getting Started

Follow these steps to install and use the addon:

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.

(back to top)

Installation

  1. Download the Addon: Start by downloading the addon from the GitHub Releases Page. Choose the latest release version.

  2. 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.

  3. Configuration: The config is being generated after the first start of the plugin, to configs/plugins/K4-System/ folder.

  4. Permissions: You can set the permissions as you need in the counterstrikesharp/configs/admins.json

(back to top)

Usage

The addon provides several commands and console variables (convars) to customize and interact with its features. Here is the list of the key commands and convars you can use:

Commands

  • !rank - Check the current rank and points
  • !ranktop, !top, !top5 - Check the top 5 players by points
  • !top10 - Check the top 10 players by points
  • !resetmyrank - Reset the players self rank and points
  • !resetrank "SteamID64" - Reset the rank of the target if its used by admin
  • !setpoints "SteamID64" 100 - Sets the targeted player's points to the given value if its used by admin
  • !givepoints "SteamID64" 100 - Gives points to the targeted player if its used by admin
  • !removepoints "SteamID64" 100 - Removes points from the targeted player if its used by admin
  • !stat, !statistics - Check your statistics
  • !time, !mytime, !playtime - Check the current playtime
  • !k4 - K4-System informational panel

(back to top)

Permissions

  • @k4system/vip/points-multiplier VIP Point Multiplier Permission

  • @k4system/admin All K4 Admin Commands

  • @css/config See debug prints in chat

  • (back to top)

Log Levels

If you set a loglevel only THAT or ABOVE logs will be printed and saved.

  • Debug (-1) Print debug logs to people's chat with @css/config permission and into console/log files (RESOURCE EXPENSIVE)

  • Info (0) Informational log/console messages

  • Warning (1) Warning log/console messages

  • Error (2) Error log/console messages

  • (back to top)

Roadmap

  • Config to disable modules fully
  • Automated Moderation System
  • VIP Clan Tag
  • Daily Rewards
  • More VIP perks
  • Point For Playtime
  • WebPanel (under development)

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE.md for more information.

(back to top)

Contact

(back to top)