Skip to content

Commit

Permalink
CI Build
Browse files Browse the repository at this point in the history
  • Loading branch information
PugSharp CI committed Nov 15, 2023
1 parent 0529fe9 commit 46eced8
Show file tree
Hide file tree
Showing 20 changed files with 734 additions and 5 deletions.
47 changes: 47 additions & 0 deletions docs/_sources/admin/commands.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
Commands
==================================================

Introduction
----------------------------------------
The commands listed below can be executed by either typing it into the ingame chat.

If you want to use them from your console, remove the ``!`` in front of them.


Player Commands
----------------------------------------

+--------------------------+-----------------------------------------------------------------------------------+
| Command | Description |
+==========================+===================================================================================+
| ``!ready`` | Mark the player as ready |
+--------------------------+-----------------------------------------------------------------------------------+
| ``!pause`` | Pause the match in the next freezetime |
+--------------------------+-----------------------------------------------------------------------------------+
| ``!unpause`` | Unpause the match. To continue the match, both teams have to ``!unpause``. |
+--------------------------+-----------------------------------------------------------------------------------+
| ``!kill``or ``!suicide`` | Kill the current player if allowed by the :ref:`admin/configuration:matchconfig`. |
+--------------------------+-----------------------------------------------------------------------------------+


Admin/Rcon Commands
-------------------

``<requiredParameter>`` marks parameters that are required for commands

``[optionalParameter]`` marks parameters that can be optionally be added to commands

+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| Command | Description |
+========================================+===================================================================================================================================================+
| ``!ps_loadconfig <url> [authToken]`` | Load a :ref:`admin/configuration:matchconfig` to initialize a match |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| ``!ps_loadconfigfile <filename>`` | Load a :ref:`admin/configuration:matchconfig` to initialize a match. The file path must be either rooted or relative to ``csgo/PugSharp/Config/`` |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| ``!ps_restorematch <matchId> <round>`` | Restores match in the given round. |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| ``!ps_stopmatch`` | Danger! Stops the current match immediately and resets the server. |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| ``!ps_dumpmatch`` | Dumps the current matchstate and config to console |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+

137 changes: 137 additions & 0 deletions docs/_sources/admin/configuration.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
Configuration
==================================================

Introduction
----------------------------------------
There are two types of configurations that are relevant for PugSharp.


PugSharp Configs
----------------------------------------

The configs for PugSharp wich are located in the subfolder ``PugSharp/Config`` on your cs2 server.

Matchconfig
........................
The matchconfig defines the current match. It is not loaded automatically, so you have to do that with one of the :ref:`admin/commands:Admin/Rcon Commands` ``ps_loadconfig`` or ``ps_loadconfigfile`` .

Matchconfig Fields
'''''''''''''''''''''
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| Field | DefaultValue | Description |
+==========================+=================+===========================================================================================+
| maplist | none (required) | List of available maps for the map vote |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| team1 | none (required) | Team declaration |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| team2 | none (required) | Team declaration |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| matchid | none (required) | Unique Identifier for the match |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| num_maps | 1 | Number of Maps to be played. This should be an odd number to determine a winner. |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| players_per_team | 5 | Maximum possible number of players per team. |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| min_players_to_ready | 5 | Number of players per team that have to be ready to start the game. |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| max_rounds | 24 | Maximum number of rounds played for the main match. |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| max_overtime_rounds | 6 | Maximum number of rounds played in overtime. |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| vote_timeout | 60000 (60s) | Timeout in milliseconds. If a team does not complete the vote within this timeout, the |
| | | map with the most votes gets banned. |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| eventula_apistats_url | (optional) | URL where the Game State has to be sent. |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| eventula_apistats_token | (optional) | Optional AuthToken used to authenticate on apistats upload. |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| eventula_demo_upload_url | (optional) | URL to upload the game demo to `eventula <https://github.com/Lan2Play/eventula-manager>`_ |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| g5_api_url | (optional) | URL to send the g5 events to. |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| g5_api_header | (optional) | Header that should be set to access the g5 events API. |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| g5_api_headervalue | (optional) | Header value that should be set to access the g5 events API. |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| allow_suicide | true | Flag to determine if players are allowed to suicide. |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+
| vote_map | de_dust2 | Map used during warm-up and voting. |
+--------------------------+-----------------+-------------------------------------------------------------------------------------------+

Matchconfig Example
'''''''''''''''''''''

.. code-block:: json
{
"maplist": ["de_vertigo", "de_dust2", "de_inferno", "de_mirage", "de_nuke", "de_overpass", "de_ancient"],
"team1": {
"name": "hallo",
"tag": "hallo",
"flag": "DE",
"players": {
"12345678901234567": "Apfelwurm",
"12345678901234568": "strange name"
}
},
"team2": {
"name": "asd",
"tag": "asd",
"flag": "DE",
"players": {
"12345678901234569": "BOT R00st3r",
"76561198064576360": "heatwave"
}
},
"matchid": "40",
"num_maps": 1,
"players_per_team": 2,
"min_players_to_ready": 2,
"max_rounds": 24,
"max_overtime_rounds": 6,
"vote_timeout": 60000,
"eventula_apistats_url": "https://dev.lan2play.de/api/matchmaking/40/",
"eventula_apistats_token": "Bearer S0XRU0UhIExFQ0tFUiEK",
"eventula_demo_upload_url": "https://dev.lan2play.de/api/matchmaking/40/demo",
"vote_map": "de_inferno"
}
Serverconfig
........................
The Serverconfig defines server wide PugSharp settings for your server. It is loaded automatically when PugSharp is loaded.

Serverconfig Fields
'''''''''''''''''''''
+--------+--------------------------------------------------------------------------------------------+
| Field | Description |
+========+============================================================================================+
| admins | List of admins with the steamId and a |
| | Name (enables the execution of the :ref:`admin/commands:Admin/Rcon Commands` for a player) |
+--------+--------------------------------------------------------------------------------------------+

Serverconfig Example
'''''''''''''''''''''

.. code-block:: json
{
"admins": {
"12345678901234569": "BOT R00st3r",
"12345678901234567": "Apfelwurm"
}
}
CS2 Server Configs
----------------------------------------

The sample configs for the CS2 Server itself wich are located in the subfolder ``cfg/PugSharp`` on your cs2 server.

+------------+--------------------------------------------------------------------------------+
| Config | Execution point in time |
+============+================================================================================+
| warmup.cfg | this config is loaded on every warmup in the game (pre Vote/ Vote / pre ready) |
+------------+--------------------------------------------------------------------------------+
| live.cfg | this config is loaded on the start of the actual game |
+------------+--------------------------------------------------------------------------------+
2 changes: 2 additions & 0 deletions docs/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ If you implement software to interface with PugSharp let us know please!
:maxdepth: 1

admin/quickstart
admin/commands
admin/configuration


.. toctree::
Expand Down
Loading

0 comments on commit 46eced8

Please sign in to comment.