Skip to content
This repository was archived by the owner on Jan 25, 2025. It is now read-only.

Commit 31c7dc1

Browse files
committed
chore: update README.md to use new team standards and fix broken links
1 parent f07ed39 commit 31c7dc1

File tree

2 files changed

+36
-72
lines changed

2 files changed

+36
-72
lines changed

CHANGELOG

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
- feat: ranks config self-repair added to prevent issues with them
44
- fix: death statistics counter from bots even if disabled
55
- fix: remove unused code part
6-
- fix: Disconnect message not shown even if enabled
6+
- fix: disconnect message not shown even if enabled
7+
- chore: update README.md to use new team standards and fix broken links
78

89
-- 2024.06.03 - V4.4.0
910

README.md

Lines changed: 34 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -4,122 +4,85 @@
44
![GitHub Repo stars](https://img.shields.io/github/stars/KitsuneLab-Development/K4-System?style=for-the-badge)
55
![GitHub issues](https://img.shields.io/github/issues/KitsuneLab-Development/K4-System?style=for-the-badge)
66
![GitHub](https://img.shields.io/github/license/KitsuneLab-Development/K4-System?style=for-the-badge)
7-
![GitHub contributors](https://img.shields.io/github/contributors/KitsuneLab-Development/K4-System?style=for-the-badge)
87
![GitHub all releases](https://img.shields.io/github/downloads/KitsuneLab-Development/K4-System/total?style=for-the-badge)
98
![GitHub last commit (branch)](https://img.shields.io/github/last-commit/KitsuneLab-Development/K4-System/dev?style=for-the-badge)
109

1110
<!-- PROJECT LOGO -->
1211
<br />
1312
<div align="center">
14-
<h1 align="center">KitsuneLab-Development</h1>
15-
<h3 align="center">K4-System</h3>
16-
13+
<a href="https://github.com/KitsuneLab-Development/K4-System">
14+
<img src="https://i.imgur.com/sej1ZzD.png" alt="Logo" width="400" height="256">
15+
</a>
16+
<h3 align="center">CounterStrike2 | K4-System</h3>
1717
<p align="center">
18-
An awesome CS2 server addon created with <a href="https://github.com/roflmuffin/CounterStrikeSharp"><strong>CounterStrikeSharp</strong></a>
19-
<br />
18+
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.
2019
<br />
2120
<a href="https://github.com/KitsuneLab-Development/K4-System/releases">Download</a>
2221
·
23-
<a href="/KitsuneLab-Development/K4-System/issues/new?assignees=KitsuneLab-Development&labels=bug&projects=&template=bug_report.md&title=%5BBUG%5D">Report Bug</a>
22+
<a href="/KitsuneLab-Development/K4-System/issues/new?assignees=KitsuneLab-Development&labels=bug&template=bug_report.md&title=%5BBUG%5D">Report Bug</a>
2423
·
25-
<a href="https://github.com/KitsuneLab-Development/K4-System/issues/new?assignees=KitsuneLab-Development&labels=enhancement&projects=&template=feature_request.md&title=%5BREQ%5D">Request Feature</a>
24+
<a href="https://github.com/KitsuneLab-Development/K4-System/issues/new?assignees=KitsuneLab-Development&labels=enhancement&template=feature_request.md&title=%5BREQ%5D">Request Feature</a>
25+
·
26+
<a href="https://kitsune-lab.com">Website</a>
27+
·
28+
<a href="https://nests.kitsune-lab.com/tickets/create?department_id=2">Hire Us</a>
2629
</p>
2730
</div>
2831

29-
<!-- TABLE OF CONTENTS -->
30-
<details>
31-
<summary>Table of Contents</summary>
32-
<ol>
33-
<li>
34-
<a href="#about-the-project">About The Project</a>
35-
<ul>
36-
<li><a href="#addons">Addons</a></li>
37-
<li><a href="#support-my-work">Support My Work</a></li>
38-
</ul>
39-
</li>
40-
<li><a href="#wiki">Wiki</a></li>
41-
<li><a href="#roadmap">Roadmap</a></li>
42-
<li><a href="#license">License</a></li>
43-
<li><a href="#contact">Contact</a></li>
44-
</ol>
45-
</details>
46-
4732
<!-- ABOUT THE PROJECT -->
4833

4934
## About The Project
5035

51-
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.
52-
53-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
36+
For guidance or detailed informations about settings, installation, api, update or much more, you should definitely cehck out the [Wikipedia](https://github.com/KitsuneLab-Development/K4-System/wiki) page of the project.
5437

55-
### Support My Work
38+
### Dependencies
5639

57-
I offer various ways to support my journey:
40+
To use this server addon, you'll need the following dependencies installed:
5841

59-
- 💬 **Request Private Paid Jobs:** Got a specific project in mind? Let's chat, and I'll provide a quote.
60-
- 🎁 **Subscribe to My Tiers:** Join one of my subscription tiers for exclusive benefits, early access to projects, and personalized support.
61-
-**Buy Me a Coffee:** One-time donations keep me motivated and my creativity flowing.
62-
- 💼 **Shop from My Paid Resources:** Explore and purchase resources I've crafted for private use.
63-
64-
Your support keeps my creative engine running and allows me to share knowledge with the community. Thanks for being part of my journey.
65-
66-
<p align="center">
67-
<a href="https://www.buymeacoffee.com/KitsuneLab-Development">
68-
<img src="https://img.buymeacoffee.com/button-api/?text=Support Me&emoji=☕&slug=KitsuneLab-Development&button_colour=FF5F5F&font_colour=ffffff&font_family=Inter&outline_colour=000000&coffee_colour=FFDD00" />
69-
</a>
70-
</p>
42+
- [**CounterStrikeSharp**](https://github.com/roflmuffin/CounterStrikeSharp/releases): CounterStrikeSharp allows you to write server plugins in C# for Counter-Strike 2/Source2/CS2.
7143

7244
<p align="right">(<a href="#readme-top">back to top</a>)</p>
7345

46+
<!-- ADDONS -->
47+
7448
### Official Addons
7549

7650
You can get these addons to make K4 and your server gameplay much better:
7751

78-
- [**K4-Missions**](https://www.buymeacoffee.com/KitsuneLab-Development/e/212956): This masterpiece lets you create your own missions to your server, through a really easy json file (5 line per mission). You don't have to configure big codes or so, just easily add few words and the mission is generated automatically. Normal players have less mission slots than VIPs so it's good to entertain your players and get more rank purchase possibly. The code is really really complex for the basic level of CSS scripts, because the hooks are made "dynamically" to support everything.
52+
- [**K4-Missions**](https://nests.kitsune-lab.com/store/view/16): This masterpiece lets you create your own missions to your server, through a really easy json file (5 line per mission). You don't have to configure big codes or so, just easily add few words and the mission is generated automatically. Normal players have less mission slots than VIPs so it's good to entertain your players and get more rank purchase possibly. Support every other plugin also which has any command to give something.
7953
- [**K4-System Matchmaking Ranks**](https://github.com/KitsuneLab-Development/K4-System-MMRanks): Display K4-System points as prime points or matchmaking ranks on scoreboard. Probably you have to install a metamod addon in order to reveal all player's rank, but you find that in the issues of that plugin.
8054

81-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
55+
<!-- ROADMAP -->
8256

83-
### Credits
57+
## Roadmap
8458

85-
- [**KillStr3aK**](https://github.com/KillStr3aK): Guided me through tons of questions and the dependency injection. A real hero...
59+
- [ ] No plans for now
8660

8761
<p align="right">(<a href="#readme-top">back to top</a>)</p>
8862

89-
### Third Party Addons
90-
91-
- **[CSS-BANS](https://github.com/counterstrikesharp-panel/css-bans):** This panel also supports K4-System, so you can have another web panel.
92-
- **[K4-System-Website](https://github.com/sdg12321/K4-System-Website):** This is a simple website that displays information from the K4-System and CS2-SimpleAdmin plugin database. MultiServer support.
93-
- **[K4-System-Time-Played-Website](https://github.com/PorcusorulMagic/K4-System-Time-Played-Website):** A website which connects to mysql stats from K4-System plugin.
94-
- The list of third party addons can be seen [here](https://github.com/KitsuneLab-Development/K4-System/wiki/Extensions) on the [Wikipedia of K4-System](https://github.com/KitsuneLab-Development/K4-System/wiki)
95-
96-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
63+
<!-- AUTHORS -->
9764

98-
### Translators
65+
## Authors
9966

100-
I really appreciate the help of the following people who translated the plugin into their language:
67+
- [**K4ryuu**](https://github.com/K4ryuu) - _Initial work_
68+
- [**KillStr3aK**](https://github.com/KillStr3aK): _Guided me through tons of questions when I started with CSS_
10169

102-
- **jinni**: German
103-
- **jinni**: Italian
104-
- [**onurcanertekin**](https://github.com/onurcanertekin): Turkish
105-
- [**ViTamin**](https://github.com/ezekutor): Russian
106-
- [**rcon420**](https://github.com/rcon420): Latvian
107-
- [**criskkky**](https://github.com/criskkky): Spanish
108-
- [**TianxSky**](https://github.com/TianxSky): Chinese (cn)
109-
- [**Gabriel 'sopax' Lima**](https://github.com/gabrielsdelima75) & [**crashzk**](https://github.com/crashzk): Brazilian Portuguese
70+
See also the list of [contributors](https://github.com/KitsuneLab-Development/K4-System/graphs/contributors) who participated in this project as an outside contributor.
11071

11172
<p align="right">(<a href="#readme-top">back to top</a>)</p>
11273

113-
<!-- Wiki -->
74+
<!-- LICENSE -->
11475

115-
## Wikipedia
76+
## License
11677

117-
If you need any help or information about settings, installation, api, update or much more, you should definitely cehck out the [Wikipedia](https://github.com/KitsuneLab-Development/K4-System/wiki) page of the project.
78+
Distributed under the GPL-3.0 License. See `LICENSE.md` for more information.
11879

119-
<!-- ROADMAP -->
80+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
12081

121-
## Roadmap
82+
<!-- CONTACT -->
83+
84+
## Contact
12285

123-
- [ ] Nothing planned yet
86+
- **KitsuneLab Team** - [contact@kitsune-lab.com](mailto:contact@kitsune-lab.com)
12487

12588
<p align="right">(<a href="#readme-top">back to top</a>)</p>

0 commit comments

Comments
 (0)