Skip to content
K4ryuu edited this page Apr 16, 2024 · 1 revision

About The Project

K4-Arenas is a CounterStrike2 server add-on that let you use multi1v1 maps with some additional benefits. The plugin includes player preferences for round types and weapons. The plugin also support team based arenas, so you can setup 2v2, 3v3 or any team sized rounds. There is a really easy to use developer API also available for the plugin to create external round types.

Key Features​

  • Warmup arenas with "Smart Refill"
  • Challenge other players
  • Weapon and round preferences saved to MySQL
  • Developer API to create custom rounds (really easy + example available)
  • Compatibility mode for metamod skinchangers
  • Compatible with css skinchangers
  • Supports any team size dynamically depending on map support and player preferences (different arenas can have different team sizes)
  • All commands customisable
  • Support bots to play with
  • Waiting queue if too much players for spawns
  • Special round support (any, external plugins)
  • 100% Translatability

Dependencies​

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

  • CounterStrikeSharp (NET8): 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 directory on your server, because it is using both shared and plugins directory. You can follow the structure from the released zip file to not to make mistakes.
  • 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.

Updating

  • Download the Addon: Download the updated version from GitHub Releases Page. Choose the latest release version.
  • Replace the files: Replace the content of K4-Arenas in the counterstrikesharp 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.
  • 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.

Commands

Every command that is being used by the plugin can be changed and managed in the config file.

Clone this wiki locally