{ "info": { "author": "Versentiedge LLC", "author_email": "help.fool@versentiedge.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: Apache Software License", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Games/Entertainment :: Real Time Strategy", "Topic :: Scientific/Engineering :: Artificial Intelligence" ], "description": "\n[![PyPI](https://img.shields.io/pypi/v/sc2ladderMgmt.svg)](https://pypi.org/project/sc2ladderMgmt/)\n[![Build Status](https://travis-ci.org/ttinies/sc2ladderMgmt.svg?branch=master)](https://travis-ci.org/ttinies/sc2ladderMgmt)\n[![Coverage Status](https://coveralls.io/repos/github/ttinies/sc2ladderMgmt/badge.svg?branch=master)](https://coveralls.io/github/ttinies/sc2ladderMgmt?branch=master)\n![Crates.io](https://img.shields.io/crates/l/rustc-serialize.svg)\n\n# sc2ladderMgmt\n\nDefine available servers for Starcraft 2 AI & bot matches.\n\n### About\nA ladder system that allows you to play Starcraft2 outside of battle.net on your local machine or across the internet\nplaying as a human, AI or scripted bot.\n\n### Purpose\nThe ladderMgmt package primarily ensures that the [scgameLobby](https://github.com/ttinies/sc2gameLobby) understands\nwhich ladder servers that are available. It should also be the basic definitions for any actual ladder server\nimplementation. If there is a ladder server that allows human and AI Starcraft 2 matches over a network, that\ndefinition ishould be made here. \n\n### Rationale\n\nBecause this package is tied to the [sc2gameLobby](https://github.com/ttinies/sc2gameLobby), its rationale for existing\nis also for the [same reason that sc2gaemLobby is developed](https://github.com/ttinies/sc2gameLobby#rationale-why-create-this-repository).\nAlso, sc2ladderMgmt is separated into its own package for the sake of being more modular and extensible by other\npackages independently from the sc2gameLobby.\n\n### Functional Overview\n\nA [simple interface](https://github.com/ttinies/sc2ladderMgmt/sc2ladderMgmt/blob/master/__init__.py) is provided to add,\nretrieve and remove available ladders. The package then accesses its own internal storage system (a json file) to\nperform the specified action without requiring manual edits. That's it. Not much to it.\n\n# Installation\n\nReference this package [hosted on pypi.org]() which is installed via [pip](https://en.wikipedia.org/wiki/Pip_(package_manager)).\n\n> EXAMPLE: `pip install sc2ladderMgmt`\n\n#### A Note to Bot and AI developers or human players\n\nIf your primary interest is in playing on the ladders either as yourself or with an AI / bot you developed, this package\nshould install automatically with the [sc2gameLobby](https://github.com/ttinies/sc2gameLobby). There really isn't\nanything you should _need_ to do with this package.\n\n# Usage\n\nFor general use, unless incorporated into external python code, the command-line interface is the primary means to\nacquire player information. After specifying the command to invoke this package, the remaining parameters specify the\noperation to be performed and any parameters for that operation. Only the --add option accepts additional parameters to\ndefine the properties of the to-be-added ladder. (**NOTE:** specifying no arguments after the package name simply\ndisplays all known ladders.)\n\n> EXAMPLE: `python -m sc2ladderMgmt `\n\n> EXAMPLE: `python -m sc2ladderMgmt --help`\n\n#### Locality\n\nBy default, all get/add/remove actions are performed on the user's local installation. If changes are made, they affect\nno other users. To ensure these changes are available for other users or publically available packages, [the sc2ladderMgmt GitHub source project](https://github.com/ttinies/sc2ladderMgmt)\nmust be updated. Kindly make your change and submit a pull request.\n\n#### Create your own ladder server\n\n1. Create and host the ladder functionality on the internet.\n\t* This new ladder server implementation must follow the protocol established by [sc2gameLobby connections to the server](https://github.com/ttinies/sc2gameLobby/blob/master/sc2gameLobby/connectToServer.py).\n\n2. Create the ladder definition. Each possible criteria definition is shown below. Only specify items that are\napplicable to the new server. The parameters `name`, `ipAddress` and `serverPort` are required. The rest are\noptionally defined. If undefined, they acquire default values.\n```\nname the name of the ladder server.\nipAddress the IPV4 or IPV6 address where the ladder server exists and is publically accessible.\nserverPort the TCP port the server listens on.\nallowNewPlayers whether previously unknown players specified in the ladder request may be accepted and created on the remote server. (Default: enabled)\nmaxLocalGamesAllowed the maximum number of games that the server can host at any given time. (Default: 0)\ninactivePurge whether players that haven't played in a while are automatically forgotten. (Default: disabled)\ninactiveScan whether inactive player detection is enabled. (Default: enabled)\n```\n> EXAMPLE: `python -m sc2ladderMgmt --add name=stairs ipAddress=1.2.3.4 serverPort=27182`\n\n3. Publicize your new ladder by issuing a pull request at [sc2ladderMgmt](https://github.com/ttinies/sc2ladderMgmt).\n\n\n#### Modify or delete a ladder definition\n\nFeel free to modify the definitions as you like. This effectively only changes your own system's knowledge of the\nStarcraft 2 AI/human ladder ecosystem. If these changes should be available publicly, a pull request must be made. The\ncurrently available ladder definitions are available [here](https://github.com/ttinies/sc2ladderMgmt/tree/master/dataLadder).\n\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ttinies/sc2ladderMgmt", "keywords": "", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "sc2ladderMgmt", "package_url": "https://pypi.org/project/sc2ladderMgmt/", "platform": "", "project_url": "https://pypi.org/project/sc2ladderMgmt/", "project_urls": { "Homepage": "https://github.com/ttinies/sc2ladderMgmt" }, "release_url": "https://pypi.org/project/sc2ladderMgmt/0.1.5/", "requires_dist": null, "requires_python": ">2.6", "summary": "A system for managing ladder profiles for AI, bot and human Starcraft 2 matches.", "version": "0.1.5" }, "last_serial": 4192966, "releases": { "0.1.4": [ { "comment_text": "", "digests": { "md5": "6269a765f2a24d1e979c445ee5516122", "sha256": "932b58634a9b63e5c57a6f360f805681b4d3016468a9c1f2cc2bba1255184b5f" }, "downloads": -1, "filename": "sc2ladderMgmt-0.1.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6269a765f2a24d1e979c445ee5516122", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">2.6", "size": 10030, "upload_time": "2018-07-13T05:26:43", "url": "https://files.pythonhosted.org/packages/09/97/124c2afe654371594636d93f2923b479fc0f38d048ed6f0eff9396a8172a/sc2ladderMgmt-0.1.4-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ee7212626638be921e2195c4c767619b", "sha256": "6865636a971fb53a40fcebca625ba36777a1faeead7221b66c13fb99a0165991" }, "downloads": -1, "filename": "sc2ladderMgmt-0.1.4-py3.6.egg", "has_sig": false, "md5_digest": "ee7212626638be921e2195c4c767619b", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": ">2.6", "size": 16738, "upload_time": "2018-08-12T21:28:28", "url": "https://files.pythonhosted.org/packages/89/8f/1f26c024b2303653177929aafc6d5558559c469d15acf82858cb649ca178/sc2ladderMgmt-0.1.4-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "e84a8d9030bd3f3525a9ef7da13cffd2", "sha256": "4f07483755e20ec7108920802b032264df2b5180c211aaa65b7e267dd8febc0f" }, "downloads": -1, "filename": "sc2ladderMgmt-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "e84a8d9030bd3f3525a9ef7da13cffd2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">2.6", "size": 10171, "upload_time": "2018-08-12T21:28:26", "url": "https://files.pythonhosted.org/packages/91/66/e28c765ec00bf0d0220bc806194fe1a462fc15185828f86e0a5bdaf80443/sc2ladderMgmt-0.1.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9f5ca082ac8d2c71c33e53ea3b546050", "sha256": "5960eee46acce330189cd46a1f322c15a5f13725cd0b8d24db596db59d679eef" }, "downloads": -1, "filename": "sc2ladderMgmt-0.1.4.tar.gz", "has_sig": false, "md5_digest": "9f5ca082ac8d2c71c33e53ea3b546050", "packagetype": "sdist", "python_version": "source", "requires_python": ">2.6", "size": 12298, "upload_time": "2018-07-13T05:26:44", "url": "https://files.pythonhosted.org/packages/63/94/f0cb94d6c64ff7ed6e7dbbb374f7b5a64318f44cdc8adca60f341d949244/sc2ladderMgmt-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "011b9c898250680ee3e1f21e6e593541", "sha256": "f25991b96a2daac0600ef2518acc073493b512466757888aa36f544ddb1d0b8a" }, "downloads": -1, "filename": "sc2ladderMgmt-0.1.5-py3.6.egg", "has_sig": false, "md5_digest": "011b9c898250680ee3e1f21e6e593541", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": ">2.6", "size": 16748, "upload_time": "2018-08-21T15:22:27", "url": "https://files.pythonhosted.org/packages/91/ff/f145add1c2e04cd6e18f12462a157203eaac43e5561234f8066f842ba0a3/sc2ladderMgmt-0.1.5-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "fdf98cfb8a53e36980e8d4c1284228a2", "sha256": "3af3452eda781669343de1356c59bbca72812b3d7e34c83bfd03af56dc01b3c7" }, "downloads": -1, "filename": "sc2ladderMgmt-0.1.5-py3-none-any.whl", "has_sig": false, "md5_digest": "fdf98cfb8a53e36980e8d4c1284228a2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">2.6", "size": 10169, "upload_time": "2018-08-21T15:22:26", "url": "https://files.pythonhosted.org/packages/f6/4e/ed947826382d71b8983e830f9e0931784d66f15ace9b93ee73376d311d1c/sc2ladderMgmt-0.1.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5ea3e2f5d1fb36390da9d4fc52eb94a0", "sha256": "b471ff13d90dad3739f3882aefb79108407de380253403435e81d8811bab08e3" }, "downloads": -1, "filename": "sc2ladderMgmt-0.1.5.tar.gz", "has_sig": false, "md5_digest": "5ea3e2f5d1fb36390da9d4fc52eb94a0", "packagetype": "sdist", "python_version": "source", "requires_python": ">2.6", "size": 12494, "upload_time": "2018-08-21T15:22:29", "url": "https://files.pythonhosted.org/packages/4a/b5/6905e65975d07e22ac8536e20049243b28c60ac34784250fad4851370228/sc2ladderMgmt-0.1.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "011b9c898250680ee3e1f21e6e593541", "sha256": "f25991b96a2daac0600ef2518acc073493b512466757888aa36f544ddb1d0b8a" }, "downloads": -1, "filename": "sc2ladderMgmt-0.1.5-py3.6.egg", "has_sig": false, "md5_digest": "011b9c898250680ee3e1f21e6e593541", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": ">2.6", "size": 16748, "upload_time": "2018-08-21T15:22:27", "url": "https://files.pythonhosted.org/packages/91/ff/f145add1c2e04cd6e18f12462a157203eaac43e5561234f8066f842ba0a3/sc2ladderMgmt-0.1.5-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "fdf98cfb8a53e36980e8d4c1284228a2", "sha256": "3af3452eda781669343de1356c59bbca72812b3d7e34c83bfd03af56dc01b3c7" }, "downloads": -1, "filename": "sc2ladderMgmt-0.1.5-py3-none-any.whl", "has_sig": false, "md5_digest": "fdf98cfb8a53e36980e8d4c1284228a2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">2.6", "size": 10169, "upload_time": "2018-08-21T15:22:26", "url": "https://files.pythonhosted.org/packages/f6/4e/ed947826382d71b8983e830f9e0931784d66f15ace9b93ee73376d311d1c/sc2ladderMgmt-0.1.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5ea3e2f5d1fb36390da9d4fc52eb94a0", "sha256": "b471ff13d90dad3739f3882aefb79108407de380253403435e81d8811bab08e3" }, "downloads": -1, "filename": "sc2ladderMgmt-0.1.5.tar.gz", "has_sig": false, "md5_digest": "5ea3e2f5d1fb36390da9d4fc52eb94a0", "packagetype": "sdist", "python_version": "source", "requires_python": ">2.6", "size": 12494, "upload_time": "2018-08-21T15:22:29", "url": "https://files.pythonhosted.org/packages/4a/b5/6905e65975d07e22ac8536e20049243b28c60ac34784250fad4851370228/sc2ladderMgmt-0.1.5.tar.gz" } ] }