Package: sc2ladderMgmt
sc2ladderMgmtDefine available servers for Starcraft 2 AI & bot matches.AboutA ladder system that allows you to play Starcraft2 outside of battle.net on your local machine or across the internet
playing as a human, AI or scripted bot.PurposeThe ladderMgmt package primarily ensures that thescgameLobbyunderstands
which ladder servers that are available. It should also be the basic definitions for any actual ladder server
implementation.  If there is a ladder server that allows human and AI Starcraft 2 matches over a network, that
definition ishould be made here.RationaleBecause this package is tied to thesc2gameLobby,  its rationale for existing
is also for thesame reason that sc2gaemLobby is developed.
Also, sc2ladderMgmt is separated into its own package for the sake of being more modular and extensible by other
packages independently from the sc2gameLobby.Functional OverviewAsimple interfaceis provided to add,
retrieve and remove available ladders.  The package then accesses its own internal storage system (a json file) to
perform the specified action without requiring manual edits.  That's it.  Not much to it.InstallationReference this packagehosted on pypi.orgwhich is installed viapip.EXAMPLE:pip install sc2ladderMgmtA Note to Bot and AI developers or human playersIf your primary interest is in playing on the ladders either as yourself or with an AI / bot you developed, this package
should install automatically with thesc2gameLobby.  There really isn't
anything you shouldneedto do with this package.UsageFor general use, unless incorporated into external python code, the command-line interface is the primary means to
acquire player information.  After specifying the command to invoke this package, the remaining parameters specify the
operation to be performed and any parameters for that operation.  Only the --add option accepts additional parameters to
define the properties of the to-be-added ladder. (NOTE:specifying no arguments after the package name simply
displays all known ladders.)EXAMPLE:python -m sc2ladderMgmt <operation <parameters>EXAMPLE:python -m sc2ladderMgmt --helpLocalityBy default, all get/add/remove actions are performed on the user's local installation.  If changes are made, they affect
no other users.  To ensure these changes are available for other users or publically available packages,the sc2ladderMgmt GitHub source projectmust be updated.  Kindly make your change and submit a pull request.Create your own ladder serverCreate and host the ladder functionality on the internet.This new ladder server implementation must follow the protocol established bysc2gameLobby connections to the server.Create the ladder definition.  Each possible criteria definition is shown below.  Only specify items that are
applicable to the new server.  The parametersname,ipAddressandserverPortare required.  The rest are
optionally defined.  If undefined, they acquire default values.name                    the name of the ladder server.
ipAddress               the IPV4 or IPV6 address where the ladder server exists and is publically accessible.
serverPort              the TCP port the server listens on.
allowNewPlayers         whether previously unknown players specified in the ladder request may be accepted and created on the remote server. (Default: enabled)
maxLocalGamesAllowed    the maximum number of games that the server can host at any given time. (Default: 0)
inactivePurge           whether players that haven't played in a while are automatically forgotten. (Default: disabled)
inactiveScan            whether inactive player detection is enabled. (Default: enabled)EXAMPLE:python -m sc2ladderMgmt --add name=stairs ipAddress=1.2.3.4 serverPort=27182Publicize your new ladder by issuing a pull request atsc2ladderMgmt.Modify or delete a ladder definitionFeel free to modify the definitions as you like.  This effectively only changes your own system's knowledge of the
Starcraft 2 AI/human ladder ecosystem.  If these changes should be available publicly, a pull request must be made.  The
currently available ladder definitions are availablehere.