[!WARNING] This plugin has been moved to https://github.com/K4ryuu/K4-System
Table of Contents
About The Project
A CS2 server extension that allows you to create an unlimited number of ranks with customizable experience thresholds and rank colors. Players gain or lose experience during various in-game events, enabling them to advance or regress between ranks. The extension is fully configurable using ‘configs.json’ and utilizes MySQL to store data.
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.
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.
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.
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.
-
Configuration: The configuration file (if there is any), will be generated automatically to the same folder after the plugin firt started succesfully.
-
Admin Setup: The permission for admin commands: “@k4ranks/admin”. counterstrikesharp/configs contains a file, where you can set admins. Here you can add root (as the example given), but to give the exact permission use the given permission name by me above.
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 – Check the top 5 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
Roadmap
- [x] Minimum amount of players to modify points
- [x] Switch to MySQL wrapper
- [ ] Advanced Web Panel (whenever we reach the goal at https://www.buymeacoffee.com/k4ryuu/libahozaxu)
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the GPL-3.0 License. See LICENSE.md
for more information.
Contact
- Discord: k4ryuu
- Email: k4ryuu@icloud.com