From ac01b01c1150b3fc4ab2057f8bb2246156d621a0 Mon Sep 17 00:00:00 2001 From: Mooshua <43320783+mooshua@users.noreply.github.com> Date: Thu, 4 Jan 2024 12:22:02 -0800 Subject: [PATCH] Initial commit --- .gitattributes | 2 + .gitignore | 12 + Jailbreak.sln | 53 ++ LICENSE | 674 ++++++++++++++++++ README.md | 66 ++ assets/ego_text.webp | Bin 0 -> 1426 bytes global.json | 7 + mod/Jailbreak.Teams/Jailbreak.Teams.csproj | 13 + mod/Jailbreak.Teams/Queue/QueueBehavior.cs | 146 ++++ mod/Jailbreak.Teams/Queue/QueueState.cs | 19 + mod/Jailbreak.Teams/Ratio/RatioBehavior.cs | 109 +++ mod/Jailbreak.Teams/Ratio/RatioConfig.cs | 22 + mod/Jailbreak.Teams/TeamsServiceExtension.cs | 19 + .../Commands/WardenCommandsBehavior.cs | 94 +++ mod/Jailbreak.Warden/Global/WardenBehavior.cs | 114 +++ mod/Jailbreak.Warden/Jailbreak.Warden.csproj | 13 + .../Selection/QueueFavorState.cs | 19 + mod/Jailbreak.Warden/Selection/QueueState.cs | 11 + .../Selection/WardenSelectionBehavior.cs | 178 +++++ .../WardenServiceExtension.cs | 22 + .../Behaviors/IPluginBehavior.cs | 24 + .../Configuration/IConfigService.cs | 19 + .../Extensions/EnumerableExtensions.cs | 24 + .../Extensions/PlayerExtensions.cs | 12 + .../Extensions/ServerExtensions.cs | 13 + .../Extensions/ServiceCollectionExtensions.cs | 64 ++ .../Extensions/StringExtensions.cs | 10 + .../Jailbreak.Public/Generic/IPlayerState.cs | 16 + .../Generic/IPlayerStateFactory.cs | 30 + .../Jailbreak.Public/Jailbreak.Public.csproj | 18 + .../Jailbreak.Public/Mod/Teams/IGuardQueue.cs | 46 ++ .../Mod/Warden/IWardenSelectionService.cs | 30 + .../Mod/Warden/IWardenService.cs | 20 + .../GenericServiceExtension.cs | 21 + .../Jailbreak.Generic.csproj | 13 + .../Behaviors/AliveStateTracker.cs | 24 + .../PlayerState/Behaviors/BaseStateTracker.cs | 28 + .../Behaviors/GlobalStateTracker.cs | 26 + .../Behaviors/RoundStateTracker.cs | 27 + .../PlayerState/ITrackedPlayerState.cs | 17 + .../PlayerState/PlayerStateFactory.cs | 46 ++ .../PlayerState/PlayerStateImpl.cs | 25 + src/Jailbreak/Config/ConfigService.cs | 66 ++ src/Jailbreak/Jailbreak.cs | 70 ++ src/Jailbreak/Jailbreak.csproj | 41 ++ src/Jailbreak/JailbreakServiceCollection.cs | 32 + 46 files changed, 2355 insertions(+) create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 Jailbreak.sln create mode 100644 LICENSE create mode 100644 README.md create mode 100644 assets/ego_text.webp create mode 100644 global.json create mode 100644 mod/Jailbreak.Teams/Jailbreak.Teams.csproj create mode 100644 mod/Jailbreak.Teams/Queue/QueueBehavior.cs create mode 100644 mod/Jailbreak.Teams/Queue/QueueState.cs create mode 100644 mod/Jailbreak.Teams/Ratio/RatioBehavior.cs create mode 100644 mod/Jailbreak.Teams/Ratio/RatioConfig.cs create mode 100644 mod/Jailbreak.Teams/TeamsServiceExtension.cs create mode 100644 mod/Jailbreak.Warden/Commands/WardenCommandsBehavior.cs create mode 100644 mod/Jailbreak.Warden/Global/WardenBehavior.cs create mode 100644 mod/Jailbreak.Warden/Jailbreak.Warden.csproj create mode 100644 mod/Jailbreak.Warden/Selection/QueueFavorState.cs create mode 100644 mod/Jailbreak.Warden/Selection/QueueState.cs create mode 100644 mod/Jailbreak.Warden/Selection/WardenSelectionBehavior.cs create mode 100644 mod/Jailbreak.Warden/WardenServiceExtension.cs create mode 100644 public/Jailbreak.Public/Behaviors/IPluginBehavior.cs create mode 100644 public/Jailbreak.Public/Configuration/IConfigService.cs create mode 100644 public/Jailbreak.Public/Extensions/EnumerableExtensions.cs create mode 100644 public/Jailbreak.Public/Extensions/PlayerExtensions.cs create mode 100644 public/Jailbreak.Public/Extensions/ServerExtensions.cs create mode 100644 public/Jailbreak.Public/Extensions/ServiceCollectionExtensions.cs create mode 100644 public/Jailbreak.Public/Extensions/StringExtensions.cs create mode 100644 public/Jailbreak.Public/Generic/IPlayerState.cs create mode 100644 public/Jailbreak.Public/Generic/IPlayerStateFactory.cs create mode 100644 public/Jailbreak.Public/Jailbreak.Public.csproj create mode 100644 public/Jailbreak.Public/Mod/Teams/IGuardQueue.cs create mode 100644 public/Jailbreak.Public/Mod/Warden/IWardenSelectionService.cs create mode 100644 public/Jailbreak.Public/Mod/Warden/IWardenService.cs create mode 100644 src/Jailbreak.Generic/GenericServiceExtension.cs create mode 100644 src/Jailbreak.Generic/Jailbreak.Generic.csproj create mode 100644 src/Jailbreak.Generic/PlayerState/Behaviors/AliveStateTracker.cs create mode 100644 src/Jailbreak.Generic/PlayerState/Behaviors/BaseStateTracker.cs create mode 100644 src/Jailbreak.Generic/PlayerState/Behaviors/GlobalStateTracker.cs create mode 100644 src/Jailbreak.Generic/PlayerState/Behaviors/RoundStateTracker.cs create mode 100644 src/Jailbreak.Generic/PlayerState/ITrackedPlayerState.cs create mode 100644 src/Jailbreak.Generic/PlayerState/PlayerStateFactory.cs create mode 100644 src/Jailbreak.Generic/PlayerState/PlayerStateImpl.cs create mode 100644 src/Jailbreak/Config/ConfigService.cs create mode 100644 src/Jailbreak/Jailbreak.cs create mode 100644 src/Jailbreak/Jailbreak.csproj create mode 100644 src/Jailbreak/JailbreakServiceCollection.cs diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..dfe0770 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Auto detect text files and perform LF normalization +* text=auto diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..aad3b71 --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ + +# Repository build files +build/ +bin/ +obj/ + +Debug/ +Release/ + +# IDE files +.idea/ +.vs/ diff --git a/Jailbreak.sln b/Jailbreak.sln new file mode 100644 index 0000000..7dfd86e --- /dev/null +++ b/Jailbreak.sln @@ -0,0 +1,53 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{177DA48D-8306-4102-918D-992569878581}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Jailbreak", "src\Jailbreak\Jailbreak.csproj", "{9135CCC9-66C5-4A9C-AE3C-91475B5F0437}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "public", "public", "{59311734-3648-43C2-B43C-385718B0D103}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Jailbreak.Public", "public\Jailbreak.Public\Jailbreak.Public.csproj", "{51AF228F-27F2-4225-A387-FDEAD123FAC2}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "mod", "mod", "{36BA84C0-291C-4930-A7C6-97CDF8F7F0D7}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Jailbreak.Warden", "mod\Jailbreak.Warden\Jailbreak.Warden.csproj", "{E73417E7-D397-415B-B96F-BF43DAC511B8}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Jailbreak.Generic", "src\Jailbreak.Generic\Jailbreak.Generic.csproj", "{1D9CC1AC-4ABC-41A3-8CC7-6FB17E864C3F}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Jailbreak.Teams", "mod\Jailbreak.Teams\Jailbreak.Teams.csproj", "{28EE05E4-8FE3-4CC6-AA03-0C533EFBFBF2}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {9135CCC9-66C5-4A9C-AE3C-91475B5F0437}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {9135CCC9-66C5-4A9C-AE3C-91475B5F0437}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9135CCC9-66C5-4A9C-AE3C-91475B5F0437}.Release|Any CPU.ActiveCfg = Release|Any CPU + {9135CCC9-66C5-4A9C-AE3C-91475B5F0437}.Release|Any CPU.Build.0 = Release|Any CPU + {51AF228F-27F2-4225-A387-FDEAD123FAC2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {51AF228F-27F2-4225-A387-FDEAD123FAC2}.Debug|Any CPU.Build.0 = Debug|Any CPU + {51AF228F-27F2-4225-A387-FDEAD123FAC2}.Release|Any CPU.ActiveCfg = Release|Any CPU + {51AF228F-27F2-4225-A387-FDEAD123FAC2}.Release|Any CPU.Build.0 = Release|Any CPU + {E73417E7-D397-415B-B96F-BF43DAC511B8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E73417E7-D397-415B-B96F-BF43DAC511B8}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E73417E7-D397-415B-B96F-BF43DAC511B8}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E73417E7-D397-415B-B96F-BF43DAC511B8}.Release|Any CPU.Build.0 = Release|Any CPU + {1D9CC1AC-4ABC-41A3-8CC7-6FB17E864C3F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {1D9CC1AC-4ABC-41A3-8CC7-6FB17E864C3F}.Debug|Any CPU.Build.0 = Debug|Any CPU + {1D9CC1AC-4ABC-41A3-8CC7-6FB17E864C3F}.Release|Any CPU.ActiveCfg = Release|Any CPU + {1D9CC1AC-4ABC-41A3-8CC7-6FB17E864C3F}.Release|Any CPU.Build.0 = Release|Any CPU + {28EE05E4-8FE3-4CC6-AA03-0C533EFBFBF2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {28EE05E4-8FE3-4CC6-AA03-0C533EFBFBF2}.Debug|Any CPU.Build.0 = Debug|Any CPU + {28EE05E4-8FE3-4CC6-AA03-0C533EFBFBF2}.Release|Any CPU.ActiveCfg = Release|Any CPU + {28EE05E4-8FE3-4CC6-AA03-0C533EFBFBF2}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {9135CCC9-66C5-4A9C-AE3C-91475B5F0437} = {177DA48D-8306-4102-918D-992569878581} + {51AF228F-27F2-4225-A387-FDEAD123FAC2} = {59311734-3648-43C2-B43C-385718B0D103} + {E73417E7-D397-415B-B96F-BF43DAC511B8} = {36BA84C0-291C-4930-A7C6-97CDF8F7F0D7} + {1D9CC1AC-4ABC-41A3-8CC7-6FB17E864C3F} = {177DA48D-8306-4102-918D-992569878581} + {28EE05E4-8FE3-4CC6-AA03-0C533EFBFBF2} = {36BA84C0-291C-4930-A7C6-97CDF8F7F0D7} + EndGlobalSection +EndGlobal diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e62ec04 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ +GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f45a0d9 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# ![EdgeGamers](assets/ego_text.webp) Jailbreak + +[![Discord](https://img.shields.io/discord/161245089774043136?style=for-the-badge&logo=discord&logoColor=%23ffffff&label=Discord&color=%235865F2 +)](https://edgm.rs/discord) + +The classic Jail gamemode, ported to Counter-Strike 2. + +> [!WARNING] +> This plugin is in active development and may cause server crashes or stability issues. + +## Status + +- **⚙️ Server** + - [ ] Stats/Analytics Sinks + - [ ] Error reporting + - [ ] Configuration system + - Note: Passable, but in a terrible state. Needs TLC. +- **👮 Guards** + - [x] Warden Selection + - [ ] Special Days + - [ ] Ratio Enforcement + - Note: Mostly there, needs debug. + - [ ] Bans/Punishments +- **🎃 Prisoners** + - [ ] Last Request +- **🛕 Maps** + - [ ] Custom Entities + - [ ] Custom I/O + - [ ] Warden/Guard/Prisoner Filters + +## Contributing + +The jail plugin is currently in heavy development and all contributions are welcome! +Please make sure all contributions use the dependency injection system, or ask to have your contribution +ported if you don't know how. + +Ports to DI containers that have more verbose scoping systems for round-based or game-based scoping are welcome. + +> [!TIP] +> Microsoft has some good documentation on dependency injection here: +> [Overview](https://learn.microsoft.com/en-us/dotnet/core/extensions/dependency-injection), +> [Using Dependency Injection](https://learn.microsoft.com/en-us/dotnet/core/extensions/dependency-injection-usage), +> [Dependency Injection Guidelines](https://learn.microsoft.com/en-us/dotnet/core/extensions/dependency-injection-guidelines). + +All event handlers should derive from `IPluginBehavior` and be registered using +`IServiceCollection.AddPluginBehavior`. If your behavior also acts as a service, +make sure to use `IServiceCollection.AddPluginBehavior`. All `IPluginBehavior` objects +have their event handlers automatically registered. + +Code style should follow .NET conventions +(if you need help, make sure to check "enable edits from maintainers" and ask for a format) + +## Building + +The jailbreak plugin automatically builds to `build/Jailbreak` when using `dotnet publish src/Jailbreak/Jailbreak.csproj`. +Please use [SDK 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) or higher. + +Note that only the `src/Jailbreak` project is intended to be built directly. + +## Using + +Jailbreak requires Counter Strike Sharp. If you don't have that installed, [follow the +install instructions here](https://docs.cssharp.dev/docs/guides/getting-started.html). + +Install the plugin like any other Counter Strike Sharp plugin: drop the `Jailbreak` folder into +`game/csgo/addons/counterstrikesharp/plugins`. diff --git a/assets/ego_text.webp b/assets/ego_text.webp new file mode 100644 index 0000000000000000000000000000000000000000..6e0da7642d4756ae39f48f97212a4028ad4c9c17 GIT binary patch literal 1426 zcmYL}4K&kh9LN9vc@5Jzr)XVTvKF#7@)B~rXOjtIo0rY&giwxX+%B%Uw`ow?eh6@{*TcwB7&8J@-}!#d^ZcIg?>y%@=jTIkb33C102EiJ zL;i=XscHZK=t9W=06hS3Jb1`GToC|3Uh>5Fc0zeC>v?mp?u0OItA#KQ68TzboGe>z z|LYs#yq32X9$XS-k2ZS8Y_}vFyE2q-8zya6U#i?>0QYL>?DK+4*D?r_So56$Em053 zm93r~or=cezSK5KIxh`AJ5k+GAqzw%4?5hoHyfQ%v1r!-!$0mBnlEHyat?D&E7$fA zVr*vXj8rq72YHz2LB6^3UZQDl1Yoe=XOYRKTNzZli|AG@YfrOL$QfmGK|6EVVmN?h zppm6BWI|}U&y6?KEx1W3vZEB2)3uyiPyq_rIoywd@Mt@&G;b%qq=E|146FRukg+9`0SCo(bn9IJlsxxDg4V_O3 zm^32~+MY+FVTAmMtL>ele4@;!W(QO!(sK+cOoV^r%N>TDDJH# znw#}&9jizi?)-M&m*~@fPLcRVZ%0YBbU<;Z%$Fwk!{AscEvlSvJv+G3coQl6Q#Q6- z=}Kl3T;r2Jt;^;zRVbJiRA5_czMw}END+6qK?28tF!C>fw8S{|C_Bq-E?I~h*0Z}> zg8qqa?x-)qUT=35ay@8sZce}R_5Q?Bv8x+A%s$s66sV^_Hp$0^_Rd>;fwdu$Vqz4V z&}wV^INyCb0xh<9TRdXizLweT+dnS`VboJ%l60Y&;gSB8RcILb4TmsE3#Rq!?CFpO z%#1L~3Z6_VwZx<*NhkfTj-$1x=nt5GVtULjZk< zq1cGN67G2^1CYv|Kbx0txKasjqmU8^#(*lM%78Yg0Dut56A3DPSAU4Nt}`9tUF$V4 zi18o{(1Mf+Wps|>_xckM%OeCzxzB%kG&DLs2^$}ogtEZmuy{NGK*O?71%QSkfHO14 qfxQ2F!+1Zu + + + net7.0 + enable + enable + + + + + + + diff --git a/mod/Jailbreak.Teams/Queue/QueueBehavior.cs b/mod/Jailbreak.Teams/Queue/QueueBehavior.cs new file mode 100644 index 0000000..8e910ff --- /dev/null +++ b/mod/Jailbreak.Teams/Queue/QueueBehavior.cs @@ -0,0 +1,146 @@ +using CounterStrikeSharp.API; +using CounterStrikeSharp.API.Core; +using CounterStrikeSharp.API.Core.Attributes.Registration; +using CounterStrikeSharp.API.Modules.Utils; + +using Jailbreak.Public.Behaviors; +using Jailbreak.Public.Extensions; +using Jailbreak.Public.Generic; +using Jailbreak.Public.Mod.Teams; + +using Microsoft.VisualBasic.CompilerServices; + +using Serilog; + +namespace Jailbreak.Teams.Queue; + +public class QueueBehavior : IGuardQueue, IPluginBehavior +{ + private int _counter; + private IPlayerState _state; + + public QueueBehavior(IPlayerStateFactory factory) + { + _counter = 0; + _state = factory.Global(); + } + + public bool TryEnterQueue(CCSPlayerController player) + { + if (player.GetTeam() == CsTeam.CounterTerrorist) + return false; + + var state = _state.Get(player); + state.Position = ++_counter; + state.InQueue = true; + state.IsGuard = false; + + return true; + } + + public bool TryExitQueue(CCSPlayerController player) + { + var state = _state.Get(player); + state.InQueue = false; + + return true; + } + + public bool TryPop(int count) + { + Server.PrintToChatAll($"[Jail] Autobalancing is adding {count} guards."); + var queue = Queue.ToList(); + + if (queue.Count <= count) + { + Server.PrintToChatAll("[Jail] Not enough guards are in the queue!"); + Server.PrintToChatAll("[Jail] Type !guard in chat to join the queue"); + ServerExtensions.PrintToCenterAll("Type !guard to become a guard!"); + } + + Log.Information($"[Queue] {count}/{queue.Count}"); + for (int i = 0; i < Math.Min(queue.Count, count); i++) + { + Log.Information($"[Queue] Popping { queue[i].PlayerName }"); + + ForceGuard( queue[i] ); + } + + return true; + } + + public bool TryPush(int count) + { + Server.PrintToChatAll($"[Jail] Autobalancing is removing {count} guards."); + + var players = Utilities.GetPlayers() + .Where(player => player.GetTeam() == CsTeam.CounterTerrorist) + .Shuffle(Random.Shared) + .ToList(); + Log.Information($"[Queue] {count}/{players.Count}"); + + for (int i = 0; i < Math.Min(count, players.Count); i++) + { + var toSwap = players[i]; + Log.Information($"[Queue] Pushing {toSwap.PlayerName}"); + var state = _state.Get(toSwap); + + state.IsGuard = false; + toSwap.ChangeTeam(CsTeam.Terrorist); + + TryEnterQueue(toSwap); + + toSwap.PrintToCenter("You were autobalanced to the prisoner team!"); + } + + return true; + } + + public void ForceGuard(CCSPlayerController player) + { + // Set IsGuard so they won't be swapped back. + _state.Get(player).IsGuard = true; + + player.PrintToCenter("You are now a guard!"); + player.ChangeTeam(CsTeam.CounterTerrorist); + } + + [GameEventHandler] + public HookResult OnPlayerTeam(EventPlayerTeam ev, GameEventInfo info) + { + var state = _state.Get(ev.Userid); + var player = ev.Userid; + + if (ev.Team == (int)CsTeam.CounterTerrorist && !state.IsGuard) + { + player.SwitchTeam(CsTeam.Terrorist); + player.PrintToCenter("You were swapped to T!\nUse !guard to join the queue."); + + return HookResult.Handled; + } + + if (player.GetTeam() == CsTeam.Terrorist && state.IsGuard) + { + if (this.TryExitQueue(player)) + player.PrintToCenter("You were removed from the guard queue for switching to T.\nUse !guard to rejoin the queue!"); + } + + return HookResult.Continue; + } + + + + public int GetQueuePosition(CCSPlayerController player) + { + return Queue.ToList() + .FindIndex(controller => controller.Slot == player.Slot); + } + + public IEnumerable Queue + => Utilities.GetPlayers() + .Select(player => (Player: player, State: _state.Get(player))) + .Where(tuple => tuple.State.InQueue) // Exclude not in queue + .Where(tuple => !tuple.State.IsGuard) // Exclude current guards + .OrderBy(tuple => tuple.State.Position) // Order by counter value when joined queue + .Select(tuple => tuple.Player); +} diff --git a/mod/Jailbreak.Teams/Queue/QueueState.cs b/mod/Jailbreak.Teams/Queue/QueueState.cs new file mode 100644 index 0000000..46e1e5c --- /dev/null +++ b/mod/Jailbreak.Teams/Queue/QueueState.cs @@ -0,0 +1,19 @@ +namespace Jailbreak.Teams.Queue; + +public class QueueState +{ + + public QueueState() + { + } + + /// + /// The counter value when the player entered the queue + /// Lower = join CT sooner + /// + public int Position { get; set; } + + public bool InQueue { get; set; } + + public bool IsGuard { get; set; } +} diff --git a/mod/Jailbreak.Teams/Ratio/RatioBehavior.cs b/mod/Jailbreak.Teams/Ratio/RatioBehavior.cs new file mode 100644 index 0000000..d6cfaec --- /dev/null +++ b/mod/Jailbreak.Teams/Ratio/RatioBehavior.cs @@ -0,0 +1,109 @@ +using CounterStrikeSharp.API; +using CounterStrikeSharp.API.Core; +using CounterStrikeSharp.API.Core.Attributes.Registration; +using CounterStrikeSharp.API.Modules.Cvars; +using CounterStrikeSharp.API.Modules.Utils; + +using Jailbreak.Public.Behaviors; +using Jailbreak.Public.Extensions; +using Jailbreak.Public.Mod.Teams; + +namespace Jailbreak.Teams.Ratio; + +public class RatioBehavior : IPluginBehavior +{ + private IGuardQueue _guardQueue; + + public enum RatioActionType + { + Add, + Remove, + None, + } + + public struct RatioAction + { + public RatioActionType Type { get; init; } + public int Count { get; init; } + + public RatioAction(int count = 0, RatioActionType type = RatioActionType.None) + { + Count = count; + Type = type; + } + } + + private RatioConfig _config; + + public RatioBehavior(RatioConfig config, IGuardQueue guardQueue) + { + _config = config; + _guardQueue = guardQueue; + } + + /// + /// Evaluate whether the provided CT/T ratio needs + /// + /// + /// + /// + public RatioAction Evaluate(int ct, int t) + { + // No divide by zero errors today... + // Make value 0.01 so the decision will always be to add Ts + // 1 / 0.01 = 100, etc... + var normalized_ct = (ct == 0 ? 0.01 : (double)ct); + double ts_per_ct = t / (double)normalized_ct; + int target = (int)( (ct + t) / _config.Target ) + 1; + + Server.PrintToConsole($"[Ratio] Evaluating ratio of {ct}ct to {t}t: {ts_per_ct}t/ct ratio, {target} target."); + + if (_config.Maximum <= ts_per_ct) + { + // There are too many Ts per CT! + // Get more guards on the team + Server.PrintToConsole($"[Ratio] Decision: Not enough CTs: {_config.Maximum} <= {ts_per_ct}"); + return new(target - ct, RatioActionType.Add); + } + + if (ts_per_ct <= _config.Minimum) + { + // There are too many guards per T! + Server.PrintToConsole($"[Ratio] Decision: Too many CTs: {ts_per_ct} <= {_config.Minimum}"); + return new(ct - target, RatioActionType.Remove); + } + + Server.PrintToConsole($"[Ratio] Decision: Goldilocks: {_config.Maximum} (max) <= {ts_per_ct} (t/ct) <= {_config.Minimum} (min)"); + // Take no action + return new(); + } + + /// + /// When a round starts, balance out the teams + /// + [GameEventHandler(HookMode.Pre)] + public HookResult OnRoundStart(EventRoundStart ev, GameEventInfo info) + { + var counterTerrorists = Utilities.GetPlayers().Count(player => player.GetTeam() == CsTeam.CounterTerrorist); + var terrorists = Utilities.GetPlayers().Count(player => player.GetTeam() == CsTeam.Terrorist); + + var action = Evaluate(counterTerrorists, terrorists); + + var success = action.Type switch + { + RatioActionType.Add => _guardQueue.TryPop(action.Count), + RatioActionType.Remove => _guardQueue.TryPush(action.Count), + _ => true + }; + + if (!success) + Server.PrintToChatAll($"[BUG] Ratio enforcement failed :^( [RatioAction: {action.Type} @ {action.Count}]"); + + return HookResult.Continue; + } + + public void Dispose() + { + + } +} diff --git a/mod/Jailbreak.Teams/Ratio/RatioConfig.cs b/mod/Jailbreak.Teams/Ratio/RatioConfig.cs new file mode 100644 index 0000000..23c01db --- /dev/null +++ b/mod/Jailbreak.Teams/Ratio/RatioConfig.cs @@ -0,0 +1,22 @@ +namespace Jailbreak.Teams.Ratio; + +public class RatioConfig +{ + /// + /// The minimum amount of Ts per every CT. + /// When this is passed, CTs will be added until Target is reached. + /// + public double Minimum { get; set; } = 2.5; + + /// + /// The maximum amount of Ts per every CT. + /// When this is passed, CTs will be removed until Target is reached. + /// + public double Maximum { get; set; } = 4; + + /// + /// When the ratio is autobalanced, the amount of guards + /// should be total_players / target. + /// + public double Target { get; set; } = 4; +} diff --git a/mod/Jailbreak.Teams/TeamsServiceExtension.cs b/mod/Jailbreak.Teams/TeamsServiceExtension.cs new file mode 100644 index 0000000..bbc8330 --- /dev/null +++ b/mod/Jailbreak.Teams/TeamsServiceExtension.cs @@ -0,0 +1,19 @@ +using Jailbreak.Public.Extensions; +using Jailbreak.Public.Mod.Teams; +using Jailbreak.Teams.Queue; +using Jailbreak.Teams.Ratio; + +using Microsoft.Extensions.DependencyInjection; + +namespace Jailbreak.Teams; + +public static class TeamsServiceExtension +{ + public static void AddJailbreakTeams(this IServiceCollection collection) + { + collection.AddConfig("ratio"); + + collection.AddPluginBehavior(); + collection.AddPluginBehavior(); + } +} diff --git a/mod/Jailbreak.Warden/Commands/WardenCommandsBehavior.cs b/mod/Jailbreak.Warden/Commands/WardenCommandsBehavior.cs new file mode 100644 index 0000000..39e4039 --- /dev/null +++ b/mod/Jailbreak.Warden/Commands/WardenCommandsBehavior.cs @@ -0,0 +1,94 @@ +using CounterStrikeSharp.API; +using CounterStrikeSharp.API.Core; +using CounterStrikeSharp.API.Core.Attributes.Registration; +using CounterStrikeSharp.API.Modules.Utils; + +using Jailbreak.Public.Behaviors; +using Jailbreak.Public.Extensions; +using Jailbreak.Public.Mod.Warden; + +namespace Jailbreak.Warden.Commands; + +public class WardenCommandsBehavior : IPluginBehavior +{ + private IWardenSelectionService _queue; + private IWardenService _warden; + + public WardenCommandsBehavior(IWardenSelectionService queue, IWardenService warden) + { + _queue = queue; + _warden = warden; + } + + public HookResult HandleWarden(CCSPlayerController sender) + { + var isCt = sender.GetTeam() == CsTeam.CounterTerrorist; + + // Is a CT and queue is open + if (isCt && _queue.Active) + { + if (_queue.InQueue(sender)) + if (_queue.TryEnter(sender)) + sender.PrintToChat("[Warden] You've joined the queue!"); + + if (!_queue.InQueue(sender)) + if (_queue.TryExit(sender)) + sender.PrintToChat("[Warden] You've left the queue!"); + + return HookResult.Handled; + } + + // Is a CT and there is no warden + if (isCt && !_warden.HasWarden) + _warden.TrySetWarden(sender); + + // Respond to all other requests + if (_warden.HasWarden) + sender.PrintToChat($"[Warden] The current warden is {_warden.Warden.PlayerName}"); + else + sender.PrintToChat("[Warden] There is currently no warden!"); + + return HookResult.Handled; + } + + public HookResult HandlePass(CCSPlayerController sender) + { + var isCt = sender.GetTeam() == CsTeam.CounterTerrorist; + var isWarden = _warden.HasWarden && _warden.Warden?.Slot == sender.Slot; + + if (isWarden) + { + // Handle warden pass + Server.PrintToChatAll("[Warden] The warden has passed!"); + if (!_warden.TryRemoveWarden()) + Server.PrintToChatAll("[BUG] Couldn't remove warden :^("); + + return HookResult.Handled; + } + + return HookResult.Continue; + } + + [GameEventHandler(HookMode.Pre)] + public HookResult OnPlayerChat(EventPlayerChat chat, GameEventInfo info) + { + var sender = Utilities.GetPlayerFromUserid(chat.Userid); + var command = chat.Text.ToLowerInvariant(); + + if (!chat.Text.StartsWith("!")) + return HookResult.Continue; + + // Player is not sending a warden command + if (command == "!w" || command == "!warden") + return HandleWarden(sender); + + if (command == "!uw" || command == "!unwarden" || command == "!pass") + return HandlePass(sender); + + return HookResult.Continue; + } + + public void Dispose() + { + } +} diff --git a/mod/Jailbreak.Warden/Global/WardenBehavior.cs b/mod/Jailbreak.Warden/Global/WardenBehavior.cs new file mode 100644 index 0000000..173c20c --- /dev/null +++ b/mod/Jailbreak.Warden/Global/WardenBehavior.cs @@ -0,0 +1,114 @@ +using System.Reflection; + +using CounterStrikeSharp.API; +using CounterStrikeSharp.API.Core; +using CounterStrikeSharp.API.Core.Attributes.Registration; +using CounterStrikeSharp.API.Modules.Utils; + +using Jailbreak.Public.Behaviors; +using Jailbreak.Public.Extensions; +using Jailbreak.Public.Mod.Warden; + +namespace Jailbreak.Warden.Global; + +public class WardenBehavior : IPluginBehavior, IWardenService +{ + + public void Dispose() + { + } + + private bool _hasWarden; + private CCSPlayerController? _warden; + + /// + /// Get the current warden, if there is one. + /// + public CCSPlayerController? Warden => _warden; + + /// + /// Whether or not a warden is currently assigned + /// + public bool HasWarden => _hasWarden; + + public bool TrySetWarden(CCSPlayerController controller) + { + if (_hasWarden) + return false; + + // Verify player is a CT + if (controller.GetTeam() != CsTeam.CounterTerrorist) + return false; + + _hasWarden = true; + _warden = controller; + + Server.PrintToChatAll($"[Warden] {_warden.PlayerName.Sanitize()} is now the warden!"); + ServerExtensions.PrintToCenterAll($"{_warden.PlayerName.Sanitize()} is now the warden!"); + _warden.ClanName = "[WARDEN]"; + + return true; + } + + public bool TryRemoveWarden() + { + if (!_hasWarden) + return false; + + if (_warden != null) + _warden.ClanName = ""; + + _hasWarden = false; + _warden = null; + + return true; + } + + [GameEventHandler] + public HookResult OnDeath(EventPlayerDeath ev, GameEventInfo info) + { + if (!_hasWarden) + return HookResult.Continue; + + if (ev.Userid.UserId == _warden.UserId) + { + if (!this.TryRemoveWarden()) + Server.PrintToConsole("[Warden] BUG: Problem removing current warden :^("); + + // Warden died! + Server.PrintToChatAll("[Warden] The current warden has died!"); + Server.PrintToChatAll("[Warden] Type !warden to become the next warden"); + ServerExtensions.PrintToCenterAll("The warden has died!"); + } + + return HookResult.Continue; + } + + [GameEventHandler] + public HookResult OnRoundEnd(EventRoundEnd ev, GameEventInfo info) + { + this.TryRemoveWarden(); + + return HookResult.Continue; + } + + [GameEventHandler] + public HookResult OnPlayerDisconnect(EventPlayerDisconnect ev, GameEventInfo info) + { + if (!_hasWarden) + return HookResult.Continue; + + if (ev.Userid.UserId == _warden.UserId) + { + if (!this.TryRemoveWarden()) + Server.PrintToConsole("[Warden] BUG: Problem removing current warden :^("); + + // Warden died! + Server.PrintToChatAll("[Warden] The current warden has left the game!"); + Server.PrintToChatAll("[Warden] Type !warden to become the next warden"); + ServerExtensions.PrintToCenterAll("The warden has left!"); + } + + return HookResult.Continue; + } +} diff --git a/mod/Jailbreak.Warden/Jailbreak.Warden.csproj b/mod/Jailbreak.Warden/Jailbreak.Warden.csproj new file mode 100644 index 0000000..d809758 --- /dev/null +++ b/mod/Jailbreak.Warden/Jailbreak.Warden.csproj @@ -0,0 +1,13 @@ + + + + net7.0 + enable + enable + + + + + + + diff --git a/mod/Jailbreak.Warden/Selection/QueueFavorState.cs b/mod/Jailbreak.Warden/Selection/QueueFavorState.cs new file mode 100644 index 0000000..36ccbd2 --- /dev/null +++ b/mod/Jailbreak.Warden/Selection/QueueFavorState.cs @@ -0,0 +1,19 @@ +namespace Jailbreak.Warden.Queue; + +public class QueueFavorState +{ + + public const int BASE_TICKETS = 2; + + public int RoundsWithoutWarden { get; set; } = 0; + + public int Favor { get; set; } = 0; + + public int GetTickets() + { + return BASE_TICKETS + + Favor + + RoundsWithoutWarden; + } + +} diff --git a/mod/Jailbreak.Warden/Selection/QueueState.cs b/mod/Jailbreak.Warden/Selection/QueueState.cs new file mode 100644 index 0000000..19f7850 --- /dev/null +++ b/mod/Jailbreak.Warden/Selection/QueueState.cs @@ -0,0 +1,11 @@ +namespace Jailbreak.Warden.Queue; + +public class QueueState +{ + + /// + /// Whether or not this player is currently in the queue + /// + public bool InQueue { get; set; } = false; + +} diff --git a/mod/Jailbreak.Warden/Selection/WardenSelectionBehavior.cs b/mod/Jailbreak.Warden/Selection/WardenSelectionBehavior.cs new file mode 100644 index 0000000..4fd440e --- /dev/null +++ b/mod/Jailbreak.Warden/Selection/WardenSelectionBehavior.cs @@ -0,0 +1,178 @@ +using System.Reflection; +using System.Runtime.CompilerServices; + +using CounterStrikeSharp.API; +using CounterStrikeSharp.API.Core; +using CounterStrikeSharp.API.Core.Attributes.Registration; +using CounterStrikeSharp.API.Modules.Timers; +using CounterStrikeSharp.API.Modules.Utils; + +using Jailbreak.Public.Behaviors; +using Jailbreak.Public.Extensions; +using Jailbreak.Public.Generic; +using Jailbreak.Public.Mod.Warden; + +using Serilog; + +using Timer = CounterStrikeSharp.API.Modules.Timers.Timer; + +namespace Jailbreak.Warden.Queue; + +/// +/// Behavior responsible for choosing the next warden +/// +public class WardenSelectionBehavior : IPluginBehavior, IWardenSelectionService +{ + /// + /// A state dict that handles the player's current queue + /// enrollment and favor. Uses the Round reset mode. + /// + private IPlayerState _queue; + + private IPlayerState _favor; + + /// + /// Whether or not to use the queue. + /// When true, the queue should be skipped and turn to first-come-first-serve. + /// + private bool _queueInactive; + + private IWardenService _warden; + + public WardenSelectionBehavior(IPlayerStateFactory factory, IWardenService warden) + { + _warden = warden; + _queue = factory.Round(); + _favor = factory.Global(); + + _queueInactive = true; + } + + public void Start(BasePlugin parent) + { + + } + + public void Dispose() + { + + } + + [GameEventHandler] + public HookResult OnRoundStart(EventRoundStart ev, GameEventInfo info) + { + // Enable the warden queue + _queueInactive = false; + + Server.PrintToChatAll("[Warden] Picking a warden shortly."); + Server.PrintToChatAll("[Warden] To enter the warden queue, type !WARDEN in chat."); + + // Start a timer to pick the warden in 7 seconds + ScheduleChooseWarden(7.0f); + + return HookResult.Continue; + } + + [MethodImpl(MethodImplOptions.NoOptimization)] + public void ScheduleChooseWarden(float time = 5.0f) + { + var timer = new Timer(time, OnChooseWarden, TimerFlags.STOP_ON_MAPCHANGE); + } + + /// + /// Timer callback that states it's time to choose the warden. + /// + protected void OnChooseWarden() + { + var eligible = Utilities.GetPlayers() + .Where(player => player.PawnIsAlive) + .Where(player => player.GetTeam() == CsTeam.CounterTerrorist) + .Where(player => _queue.Get(player).InQueue) + .ToList(); + + Log.Information("[WardenSelectionBehavior] Picking warden from {@Eligible}", eligible); + + if (eligible.Count == 0) + { + Server.PrintToChatAll("[Warden] No Wardens in queue!"); + _queueInactive = true; + + return; + } + + var favors = eligible + .ToDictionary(player => player, player => _favor.Get(player)); + int tickets = favors.Sum(favor => favor.Value.GetTickets()); + int chosen = Random.Shared.Next(tickets); + + Server.PrintToConsole($"[Warden Raffle] Picking {chosen} out of {tickets}"); + + int pointer = 0; + foreach (var (player, favor) in favors) + { + int thisTickets = favor.GetTickets(); + Server.PrintToConsole($"[Warden Raffle] {pointer} -> {pointer + thisTickets}: #{player.Slot} {player.PlayerName}"); + + // If winning ticket belongs to this player, assign them as warden. + if (pointer <= chosen && chosen < (pointer + thisTickets)) + { + _warden.TrySetWarden(player); + favor.RoundsWithoutWarden = 0; + } + else + { + favor.RoundsWithoutWarden++; + } + + pointer += thisTickets; + } + + // Disable the warden raffle for future wardens + // (eg in the event of warden death) + _queueInactive = true; + } + + private bool CanEnterQueue(CCSPlayerController player) + { + if (player.GetTeam() != CsTeam.CounterTerrorist) + return false; + + if (!player.PawnIsAlive) + return false; + + // Cannot enter queue if queue is not running + if (_queueInactive) + return false; + + // Edge case: Is there already a warden? + if (_warden.HasWarden) + return false; + + return true; + } + + public bool TryEnter(CCSPlayerController player) + { + if (!CanEnterQueue(player)) + return false; + + _queue.Get(player).InQueue = true; + return true; + } + + public bool TryExit(CCSPlayerController player) + { + if (!CanEnterQueue(player)) + return false; + + _queue.Get(player).InQueue = false; + return true; + } + + public bool InQueue(CCSPlayerController player) + => _queue.Get(player).InQueue; + + public bool Active => !_queueInactive; + + +} diff --git a/mod/Jailbreak.Warden/WardenServiceExtension.cs b/mod/Jailbreak.Warden/WardenServiceExtension.cs new file mode 100644 index 0000000..d6f17af --- /dev/null +++ b/mod/Jailbreak.Warden/WardenServiceExtension.cs @@ -0,0 +1,22 @@ +using CounterStrikeSharp.API.Core; + +using Jailbreak.Public.Extensions; +using Jailbreak.Public.Mod.Warden; +using Jailbreak.Warden.Commands; +using Jailbreak.Warden.Global; +using Jailbreak.Warden.Queue; + +using Microsoft.Extensions.DependencyInjection; + +namespace Jailbreak.Warden; + +public static class WardenServiceExtension +{ + public static void AddJailbreakWarden(this IServiceCollection serviceCollection) + { + serviceCollection.AddPluginBehavior(); + serviceCollection.AddPluginBehavior(); + + serviceCollection.AddPluginBehavior(); + } +} diff --git a/public/Jailbreak.Public/Behaviors/IPluginBehavior.cs b/public/Jailbreak.Public/Behaviors/IPluginBehavior.cs new file mode 100644 index 0000000..137eb70 --- /dev/null +++ b/public/Jailbreak.Public/Behaviors/IPluginBehavior.cs @@ -0,0 +1,24 @@ +using CounterStrikeSharp.API.Core; + +namespace Jailbreak.Public.Behaviors; + +/// +/// A plugin extension class that is +/// +public interface IPluginBehavior : IDisposable +{ + + /// + /// Tells the plugin that it will be starting imminently + /// + void Start(BasePlugin parent) + { + + } + + void IDisposable.Dispose() + { + + } + +} diff --git a/public/Jailbreak.Public/Configuration/IConfigService.cs b/public/Jailbreak.Public/Configuration/IConfigService.cs new file mode 100644 index 0000000..7b690ec --- /dev/null +++ b/public/Jailbreak.Public/Configuration/IConfigService.cs @@ -0,0 +1,19 @@ +using CounterStrikeSharp.API; +using CounterStrikeSharp.API.Core; + +namespace Jailbreak.Public.Configuration; + +public interface IConfigService +{ + public const string CONFIG_PATH = "jailbreak.json"; + + /// + /// Get the configuration object with the provided name + /// + /// + /// If the configuration service would return the default value, fail instead. Loudly. + /// + /// + T Get(string path, bool failOnDefault = false) + where T: class, new(); +} diff --git a/public/Jailbreak.Public/Extensions/EnumerableExtensions.cs b/public/Jailbreak.Public/Extensions/EnumerableExtensions.cs new file mode 100644 index 0000000..1e10958 --- /dev/null +++ b/public/Jailbreak.Public/Extensions/EnumerableExtensions.cs @@ -0,0 +1,24 @@ +namespace Jailbreak.Public.Extensions; + +public static class EnumerableExtensions +{ + public static IEnumerable Shuffle(this IEnumerable source, Random rng) + { + // From https://stackoverflow.com/questions/1287567/is-using-random-and-orderby-a-good-shuffle-algorithm + // Yay stackoverflow :D + + T[] elements = source.ToArray(); + // Note i > 0 to avoid final pointless iteration + for (int i = elements.Length-1; i > 0; i--) + { + // Swap element "i" with a random earlier element it (or itself) + int swapIndex = rng.Next(i + 1); + (elements[i], elements[swapIndex]) = (elements[swapIndex], elements[i]); + } + // Lazily yield (avoiding aliasing issues etc) + foreach (T element in elements) + { + yield return element; + } + } +} diff --git a/public/Jailbreak.Public/Extensions/PlayerExtensions.cs b/public/Jailbreak.Public/Extensions/PlayerExtensions.cs new file mode 100644 index 0000000..2b842a2 --- /dev/null +++ b/public/Jailbreak.Public/Extensions/PlayerExtensions.cs @@ -0,0 +1,12 @@ +using CounterStrikeSharp.API.Core; +using CounterStrikeSharp.API.Modules.Utils; + +namespace Jailbreak.Public.Extensions; + +public static class PlayerExtensions +{ + public static CsTeam GetTeam(this CCSPlayerController controller) + { + return (CsTeam)controller.TeamNum; + } +} diff --git a/public/Jailbreak.Public/Extensions/ServerExtensions.cs b/public/Jailbreak.Public/Extensions/ServerExtensions.cs new file mode 100644 index 0000000..cd05827 --- /dev/null +++ b/public/Jailbreak.Public/Extensions/ServerExtensions.cs @@ -0,0 +1,13 @@ +using CounterStrikeSharp.API; +using CounterStrikeSharp.API.Modules.Memory; +using CounterStrikeSharp.API.Modules.Utils; + +namespace Jailbreak.Public.Extensions; + +public static class ServerExtensions +{ + public static void PrintToCenterAll(string message) + { + VirtualFunctions.ClientPrintAll(HudDestination.Center, message, 0, 0, 0, 0); + } +} diff --git a/public/Jailbreak.Public/Extensions/ServiceCollectionExtensions.cs b/public/Jailbreak.Public/Extensions/ServiceCollectionExtensions.cs new file mode 100644 index 0000000..ea3f949 --- /dev/null +++ b/public/Jailbreak.Public/Extensions/ServiceCollectionExtensions.cs @@ -0,0 +1,64 @@ +using Jailbreak.Public.Behaviors; +using Jailbreak.Public.Configuration; + +using Microsoft.Extensions.DependencyInjection; + +namespace Jailbreak.Public.Extensions; + +public static class ServiceCollectionExtensions +{ + /// + /// Add a to the global service collection + /// + /// + /// + public static void AddPluginBehavior(this IServiceCollection collection) + where TExtension: class, IPluginBehavior + { + // Add the root extension itself as a scoped service. + // This means every time Load is called in the main Jailbreak loader, + // the extension will be fetched and kept as a singleton for the duration + // until "Unload" is called. + collection.AddScoped(); + + collection.AddTransient(provider => provider.GetRequiredService()); + } + + /// + /// Add a to the global service collection + /// + /// + /// + /// + public static void AddPluginBehavior(this IServiceCollection collection) + where TExtension: class, IPluginBehavior, TInterface + where TInterface : class + { + // Add the root extension itself as a scoped service. + // This means every time Load is called in the main Jailbreak loader, + // the extension will be fetched and kept as a singleton for the duration + // until "Unload" is called. + collection.AddScoped(); + + collection.AddTransient(provider => provider.GetRequiredService()); + collection.AddTransient(provider => provider.GetRequiredService()); + } + + /// + /// Add an object to be loaded from the configuration file + /// + /// + /// The section where the configuration object will be loaded from + /// The configuration object. Must auto-fill all default values! + public static void AddConfig(this IServiceCollection collection, string sectionName) + where TConfig : class, new() + { + // Get the object by resolving IConfigService + // and use the Get() method. + + // Not *really* important... but do we want to fail here or return default if section + // isn't available? + collection.AddTransient(provider => provider.GetRequiredService() + .Get(sectionName, /*failOnDefault*/ false)); + } +} diff --git a/public/Jailbreak.Public/Extensions/StringExtensions.cs b/public/Jailbreak.Public/Extensions/StringExtensions.cs new file mode 100644 index 0000000..cce35f8 --- /dev/null +++ b/public/Jailbreak.Public/Extensions/StringExtensions.cs @@ -0,0 +1,10 @@ +namespace Jailbreak.Public.Extensions; + +public static class StringExtensions +{ + public static string Sanitize(this string unknown) + { + return unknown + .Replace("<", "<"); + } +} diff --git a/public/Jailbreak.Public/Generic/IPlayerState.cs b/public/Jailbreak.Public/Generic/IPlayerState.cs new file mode 100644 index 0000000..fa903c7 --- /dev/null +++ b/public/Jailbreak.Public/Generic/IPlayerState.cs @@ -0,0 +1,16 @@ +using CounterStrikeSharp.API.Core; + +namespace Jailbreak.Public.Generic; + +/// +/// A player state dictionary that automatically deletes stale states +/// and translates between different client formats. +/// +/// +public interface IPlayerState + where TState: class, new() +{ + + TState Get(CCSPlayerController controller); + +} diff --git a/public/Jailbreak.Public/Generic/IPlayerStateFactory.cs b/public/Jailbreak.Public/Generic/IPlayerStateFactory.cs new file mode 100644 index 0000000..7e9872f --- /dev/null +++ b/public/Jailbreak.Public/Generic/IPlayerStateFactory.cs @@ -0,0 +1,30 @@ +namespace Jailbreak.Public.Generic; + +public interface IPlayerStateFactory +{ + + /// + /// This state lasts from when the player connect to until the player disconnects. + /// + /// + /// + IPlayerState Global() + where T : class, new(); + + /// + /// This state resets when the player dies + /// + /// + /// + IPlayerState Alive() + where T : class, new(); + + /// + /// This state resets when the round ends or begins. + /// + /// + /// + IPlayerState Round() + where T : class, new(); + +} diff --git a/public/Jailbreak.Public/Jailbreak.Public.csproj b/public/Jailbreak.Public/Jailbreak.Public.csproj new file mode 100644 index 0000000..2dd2d58 --- /dev/null +++ b/public/Jailbreak.Public/Jailbreak.Public.csproj @@ -0,0 +1,18 @@ + + + + net7.0 + enable + enable + + + + + + + + + + + + diff --git a/public/Jailbreak.Public/Mod/Teams/IGuardQueue.cs b/public/Jailbreak.Public/Mod/Teams/IGuardQueue.cs new file mode 100644 index 0000000..cb374be --- /dev/null +++ b/public/Jailbreak.Public/Mod/Teams/IGuardQueue.cs @@ -0,0 +1,46 @@ +using CounterStrikeSharp.API.Core; + +namespace Jailbreak.Public.Mod.Teams; + +public interface IGuardQueue +{ + + + bool TryEnterQueue(CCSPlayerController player); + + bool TryExitQueue(CCSPlayerController player); + + /// + /// Pop the provided amount of players from the queue + /// and put them on the CT team + /// + /// + /// + bool TryPop(int count); + + /// + /// Pull the provided amount of players from the CT team + /// and put them back in the queue. + /// + /// + /// + bool TryPush(int count); + + /// + /// Force the player to join CT, without being pushed back to T. + /// + /// + void ForceGuard(CCSPlayerController player); + + /// + /// Get this player's position in the queue + /// + /// + /// + int GetQueuePosition(CCSPlayerController player); + + /// + /// Get all players in the queue + /// + IEnumerable Queue { get; } +} diff --git a/public/Jailbreak.Public/Mod/Warden/IWardenSelectionService.cs b/public/Jailbreak.Public/Mod/Warden/IWardenSelectionService.cs new file mode 100644 index 0000000..4f5a88a --- /dev/null +++ b/public/Jailbreak.Public/Mod/Warden/IWardenSelectionService.cs @@ -0,0 +1,30 @@ +using CounterStrikeSharp.API.Core; + +namespace Jailbreak.Public.Mod.Warden; + +public interface IWardenSelectionService +{ + /// + /// Enter this player into the warden queue + /// + /// + bool TryEnter(CCSPlayerController player); + + /// + /// Remove this player from the warden queue + /// + /// + bool TryExit(CCSPlayerController player); + + /// + /// Determine whether this player is in the queue or not + /// + /// + /// + bool InQueue(CCSPlayerController player); + + /// + /// Whether or not the warden queue is currently in use + /// + bool Active {get;} +} diff --git a/public/Jailbreak.Public/Mod/Warden/IWardenService.cs b/public/Jailbreak.Public/Mod/Warden/IWardenService.cs new file mode 100644 index 0000000..097efd3 --- /dev/null +++ b/public/Jailbreak.Public/Mod/Warden/IWardenService.cs @@ -0,0 +1,20 @@ +using CounterStrikeSharp.API.Core; + +namespace Jailbreak.Public.Mod.Warden; + +public interface IWardenService +{ + + CCSPlayerController? Warden { get; } + + /// + /// Whether or not a warden is currently assigned + /// + bool HasWarden { get; } + + + bool TrySetWarden(CCSPlayerController warden); + + bool TryRemoveWarden(); + +} diff --git a/src/Jailbreak.Generic/GenericServiceExtension.cs b/src/Jailbreak.Generic/GenericServiceExtension.cs new file mode 100644 index 0000000..0dd96e1 --- /dev/null +++ b/src/Jailbreak.Generic/GenericServiceExtension.cs @@ -0,0 +1,21 @@ +using CounterStrikeSharp.API.Core; + +using Jailbreak.Generic.Behaviors; +using Jailbreak.Public.Extensions; +using Jailbreak.Public.Generic; + +using Microsoft.Extensions.DependencyInjection; + +namespace Jailbreak.Generic; + +public static class GenericServiceExtension +{ + public static void AddJailbreakGeneric(this IServiceCollection serviceCollection) + { + serviceCollection.AddPluginBehavior(); + serviceCollection.AddPluginBehavior(); + serviceCollection.AddPluginBehavior(); + + serviceCollection.AddTransient(); + } +} diff --git a/src/Jailbreak.Generic/Jailbreak.Generic.csproj b/src/Jailbreak.Generic/Jailbreak.Generic.csproj new file mode 100644 index 0000000..d809758 --- /dev/null +++ b/src/Jailbreak.Generic/Jailbreak.Generic.csproj @@ -0,0 +1,13 @@ + + + + net7.0 + enable + enable + + + + + + + diff --git a/src/Jailbreak.Generic/PlayerState/Behaviors/AliveStateTracker.cs b/src/Jailbreak.Generic/PlayerState/Behaviors/AliveStateTracker.cs new file mode 100644 index 0000000..1ff3c8d --- /dev/null +++ b/src/Jailbreak.Generic/PlayerState/Behaviors/AliveStateTracker.cs @@ -0,0 +1,24 @@ +using System.Reflection; + +using CounterStrikeSharp.API.Core; +using CounterStrikeSharp.API.Core.Attributes.Registration; + +using Jailbreak.Public.Behaviors; + +namespace Jailbreak.Generic.Behaviors; + +public class AliveStateTracker : BaseStateTracker, IPluginBehavior +{ + public void Start(BasePlugin parent) + { + + } + + [GameEventHandler] + public HookResult OnDeath(EventPlayerDeath ev, GameEventInfo info) + { + Reset(ev.Userid); + + return HookResult.Continue; + } +} diff --git a/src/Jailbreak.Generic/PlayerState/Behaviors/BaseStateTracker.cs b/src/Jailbreak.Generic/PlayerState/Behaviors/BaseStateTracker.cs new file mode 100644 index 0000000..ef84674 --- /dev/null +++ b/src/Jailbreak.Generic/PlayerState/Behaviors/BaseStateTracker.cs @@ -0,0 +1,28 @@ +using CounterStrikeSharp.API.Core; + +namespace Jailbreak.Generic.Behaviors; + +public class BaseStateTracker : IDisposable +{ + private List _trackedPlayerStates = new(); + + protected void Reset(CCSPlayerController controller) + { + foreach (ITrackedPlayerState trackedPlayerState in _trackedPlayerStates) + trackedPlayerState.Reset(controller); + } + + protected void ResetAll() + { + foreach (ITrackedPlayerState trackedPlayerState in _trackedPlayerStates) + trackedPlayerState.Drop(); + } + + public void Track(ITrackedPlayerState state) + { + _trackedPlayerStates.Add(state); + } + + public void Dispose() + => ResetAll(); +} diff --git a/src/Jailbreak.Generic/PlayerState/Behaviors/GlobalStateTracker.cs b/src/Jailbreak.Generic/PlayerState/Behaviors/GlobalStateTracker.cs new file mode 100644 index 0000000..b15ca77 --- /dev/null +++ b/src/Jailbreak.Generic/PlayerState/Behaviors/GlobalStateTracker.cs @@ -0,0 +1,26 @@ +using CounterStrikeSharp.API.Core; +using CounterStrikeSharp.API.Core.Attributes.Registration; + +using Jailbreak.Public.Behaviors; + +namespace Jailbreak.Generic.Behaviors; + +public class GlobalStateTracker : BaseStateTracker, IPluginBehavior +{ + public void Start(BasePlugin parent) + { + + } + + /// + /// Disconnect handler to reset states on user leave + /// + /// + /// + [GameEventHandler] + public HookResult OnDisconnect(EventPlayerDisconnect ev, GameEventInfo info) + { + Reset(ev.Userid); + return HookResult.Continue; + } +} diff --git a/src/Jailbreak.Generic/PlayerState/Behaviors/RoundStateTracker.cs b/src/Jailbreak.Generic/PlayerState/Behaviors/RoundStateTracker.cs new file mode 100644 index 0000000..f10d278 --- /dev/null +++ b/src/Jailbreak.Generic/PlayerState/Behaviors/RoundStateTracker.cs @@ -0,0 +1,27 @@ +using System.Reflection; + +using CounterStrikeSharp.API.Core; +using CounterStrikeSharp.API.Core.Attributes.Registration; + +using Jailbreak.Public.Behaviors; + +using Serilog; + +namespace Jailbreak.Generic.Behaviors; + +public class RoundStateTracker : BaseStateTracker, IPluginBehavior +{ + public void Start(BasePlugin parent) + { + + } + + [GameEventHandler] + public HookResult OnRoundEnd(EventRoundEnd ev, GameEventInfo info) + { + Log.Debug("[RoundStateTracker] Resetting all tracked states"); + ResetAll(); + + return HookResult.Continue; + } +} diff --git a/src/Jailbreak.Generic/PlayerState/ITrackedPlayerState.cs b/src/Jailbreak.Generic/PlayerState/ITrackedPlayerState.cs new file mode 100644 index 0000000..73a0af5 --- /dev/null +++ b/src/Jailbreak.Generic/PlayerState/ITrackedPlayerState.cs @@ -0,0 +1,17 @@ +using CounterStrikeSharp.API.Core; + +namespace Jailbreak.Generic; + +public interface ITrackedPlayerState +{ + /// + /// Reset a state for a specific player + /// + /// + void Reset(CCSPlayerController controller); + + /// + /// Reset states for all players + /// + void Drop(); +} diff --git a/src/Jailbreak.Generic/PlayerState/PlayerStateFactory.cs b/src/Jailbreak.Generic/PlayerState/PlayerStateFactory.cs new file mode 100644 index 0000000..fdd4c73 --- /dev/null +++ b/src/Jailbreak.Generic/PlayerState/PlayerStateFactory.cs @@ -0,0 +1,46 @@ +using Jailbreak.Generic.Behaviors; +using Jailbreak.Public.Generic; + +namespace Jailbreak.Generic; + +public class PlayerStateFactory : IPlayerStateFactory +{ + private GlobalStateTracker _global; + private AliveStateTracker _alive; + private RoundStateTracker _round; + + public PlayerStateFactory(GlobalStateTracker global, AliveStateTracker alive, RoundStateTracker round) + { + _global = global; + _alive = alive; + _round = round; + } + + public IPlayerState Global() where T : class, new() + { + var state = new PlayerStateImpl(); + + _global.Track(state); + + return state; + } + + public IPlayerState Alive() where T : class, new() + { + var state = new PlayerStateImpl(); + + _global.Track(state); + _alive.Track(state); + + return state; } + + public IPlayerState Round() where T : class, new() + { + var state = new PlayerStateImpl(); + + _global.Track(state); + _round.Track(state); + + return state; + } +} diff --git a/src/Jailbreak.Generic/PlayerState/PlayerStateImpl.cs b/src/Jailbreak.Generic/PlayerState/PlayerStateImpl.cs new file mode 100644 index 0000000..1e9b442 --- /dev/null +++ b/src/Jailbreak.Generic/PlayerState/PlayerStateImpl.cs @@ -0,0 +1,25 @@ +using CounterStrikeSharp.API.Core; + +using Jailbreak.Public.Generic; + +namespace Jailbreak.Generic; + +public class PlayerStateImpl : IPlayerState, ITrackedPlayerState + where TState : class, new() +{ + private Dictionary _states = new(); + + public TState Get(CCSPlayerController controller) + { + // If the state doesn't exist, create it :^) + _states.TryAdd(controller.Slot, new TState()); + + return _states[controller.Slot]; + } + + public void Reset(CCSPlayerController controller) + => _states.Remove(controller.Slot); + + public void Drop() + => _states.Clear(); +} diff --git a/src/Jailbreak/Config/ConfigService.cs b/src/Jailbreak/Config/ConfigService.cs new file mode 100644 index 0000000..446531d --- /dev/null +++ b/src/Jailbreak/Config/ConfigService.cs @@ -0,0 +1,66 @@ +using System.Text.Json; +using System.Text.Json.Nodes; + +using CounterStrikeSharp.API; + +using Jailbreak.Public.Configuration; + +using Microsoft.Extensions.Logging; + + +namespace Jailbreak.Config; + +public class ConfigService : IConfigService +{ + private ILogger _logger; + + public ConfigService(ILogger logger) + { + _logger = logger; + } + + private T Fail(bool fail, string message) + where T: class, new() + { + // We would be returning default. + // Check if caller wants us to cry and scream instead. + if (fail) + throw new InvalidOperationException(message); + + _logger.LogWarning("[Config] Tripped load fail state with message: {@Message}", message); + + return new T(); + } + + /// + /// + /// + /// + /// + /// + /// + public T Get(string path, bool fail = false) + where T : class, new() + { + var jsonPath = Path.Combine(Server.GameDirectory, IConfigService.CONFIG_PATH); + + if (!File.Exists(jsonPath)) + return Fail(fail, "Config file does not exist"); + + var jsonText = File.ReadAllText(jsonPath); + + var jsonObject = JsonObject.Parse(jsonText); + if (jsonObject == null) + return Fail(fail, $"Unable to parse configuration file at {jsonPath}"); + + var configObject = jsonObject[path]; + if (configObject == null) + return Fail(fail, $"Unable to navigate to config section {path}"); + + var config = configObject.Deserialize(); + if (config == null) + return Fail(fail, $"Unable to deserialize ({configObject.ToJsonString()}) into {typeof(T).FullName}."); + + return config; + } +} diff --git a/src/Jailbreak/Jailbreak.cs b/src/Jailbreak/Jailbreak.cs new file mode 100644 index 0000000..de0352d --- /dev/null +++ b/src/Jailbreak/Jailbreak.cs @@ -0,0 +1,70 @@ +using System.Collections.Immutable; +using System.Reflection; + +using CounterStrikeSharp.API; +using CounterStrikeSharp.API.Core; + +using Jailbreak.Public.Behaviors; + +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; + +using Serilog; + +namespace Jailbreak; + +public class Jailbreak : BasePlugin +{ + public override string ModuleName => "Jailbreak"; + public override string ModuleVersion => "0.1.0"; + public override string ModuleAuthor => "EdgeGamers Development"; + + private IServiceProvider _provider; + private IServiceScope _scope; + private IReadOnlyList _extensions; + + public Jailbreak(IServiceProvider provider) + { + _provider = provider; + } + + public override void Load(bool hotReload) + { + Logger.LogInformation("[Jailbreak] Loading..."); + + _scope = _provider.CreateScope(); + _extensions = _scope.ServiceProvider.GetServices() + .ToImmutableList(); + + Logger.LogInformation("[Jailbreak] Found {@BehaviorCount} behaviors.", _extensions.Count); + + foreach (IPluginBehavior extension in _extensions) + { + // Register all event handlers on the extension object + RegisterAllAttributes(extension); + + // Tell the extension to start it's magic + extension.Start(this); + + Logger.LogInformation("[Jailbreak] Loaded behavior {@Behavior}", extension.GetType().FullName); + } + + base.Load(hotReload); + } + + public override void Unload(bool hotReload) + { + Logger.LogInformation("[Jailbreak] Shutting down..."); + + foreach (IPluginBehavior extension in _extensions) + { + extension.Dispose(); + } + + // Dispose of original extensions scope + // When loading again we will get a new scope to avoid leaking state. + _scope.Dispose(); + + base.Unload(hotReload); + } +} diff --git a/src/Jailbreak/Jailbreak.csproj b/src/Jailbreak/Jailbreak.csproj new file mode 100644 index 0000000..1908843 --- /dev/null +++ b/src/Jailbreak/Jailbreak.csproj @@ -0,0 +1,41 @@ + + + + + net7.0 + + + enable + enable + true + + + + EdgeGamers.Jailbreak + + + + + true + + + + + $(MSBuildThisFileDirectory)/../../build/Jailbreak + false + false + true + + + Major + false + + + + + + + + + + diff --git a/src/Jailbreak/JailbreakServiceCollection.cs b/src/Jailbreak/JailbreakServiceCollection.cs new file mode 100644 index 0000000..1c7c775 --- /dev/null +++ b/src/Jailbreak/JailbreakServiceCollection.cs @@ -0,0 +1,32 @@ +using System.Reflection; + +using CounterStrikeSharp.API.Core; + +using Jailbreak.Config; +using Jailbreak.Generic; +using Jailbreak.Public.Configuration; +using Jailbreak.Teams; +using Jailbreak.Warden; + +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; + +namespace Jailbreak; + +/// +/// Class that auto-registers all jailbreak services and classes. +/// +public class JailbreakServiceCollection : IPluginServiceCollection +{ + /// + public void ConfigureServices(IServiceCollection serviceCollection) + { + // Do we want to make this scoped? + // Not sure how this will behave with multiple rounds and whatnot. + serviceCollection.AddTransient(); + + serviceCollection.AddJailbreakGeneric(); + serviceCollection.AddJailbreakWarden(); + serviceCollection.AddJailbreakTeams(); + } +}