Package: pyroids
pyroidsAsteroids game with features including:1 or 2 playerMultiple weaponsExpendable ammunitionSupply dropsRadiation exposureHighly customisable - you make the game!InstallationThe simplest way to install pyroids is directly from PyPI:$ pip install --upgrade pyroids --userAlternativelyInstall from the source distribution on github:$ pip install git+https//github.com/maread99/pyroids.git#egg=pyroidsInstall from a source distribution stored locally:$ python setup.py install --userRequirementspyroids requires Python 3.6+ (employs annotation syntax).The only dependency is pyglet 1.4 which, if not already installed, will be installed as part of the pyroids installation process.Play me!Once installed, pyroids can be launched directly from the command line or via the launch() function.From the command line:$ python -m pyroids.playTo launch with settings defined by a configuration file (seeGame Customisationsection), for example 'expert.py':$ python -m pyroids.play expertIf pyroids was installed via pip then the application *might also launch with default settings with a simple:$ pyroids* requires that theScriptsdirectory, of the python environment to which pyroids was installed, is included to the PATH environmental variable.Using launch function:>>> import pyroids
>>> pyroids.launch()To launch with settings as defined by a configuration file (seeGame Customisationsection), for example 'novice.py':>>> pyroids.launch('novice')Game CustomisationSettings that can be defined for each level include:Number of AsteroidsNumber of times each original asteroid will break up into smaller asteroidsNumber of smaller asteroids each asteroid breaks up intoAsteroid speedShip SpeedRadiation fieldRadiation exposure limitsNumber of supply dropsSettings that can be defined for the duration of an application instance include:Ship ControlsAsteroid behaviour on reaching window borderInitial ammunition stocks per weaponFrequency and number of supply dropsMin and Max ammunition stocks in each supply drop (per weapon)Cannon reload rateHigh Velocity Bullet speedShield durationNumber of LevelsNumber of LivesWindow dimensionsSettings can be customised by creating a configuration file and passing the configuration file's name when the application is run (seePlay me!section). If no configuration file is passed then the game will use default settings. Seepyroids\config\template.pydocumentation for instructions to set up configuration files.The following example configuration files are included as part of the pyroids'
distribution:novice.pyexpert.pyAside from the configuration files, the ship and asteroid images can be changed with a little investigation of the source code and some minimal hacks.Not feeling the love$ pip uninstall pyroidsLicensingCodeSeeLICENSE.txt.MediaSeepyroids\resources\README.md.Code DocumentationFunction and method documentation:does not by default list all optional and keyword arguments, for which signatures should be inspected.does not state argument types or return values, for which signatures' annotation should be inspected.Names referenced in documentation are surrounded by symbols that identify the nature of the assigned object:NameNature of assigned object+parameter_name+Parameter of documented function or method.++parameter_name++Parameter of class constructor method.-variable_name-Variable local to code being documented.--attribute_name--Instance attribute.--method_name(args, kwargs)--Instance method. Only args / kwargs referred to in the 		subseqeunt documentation are noted. Signature should be inspected for full parameters.---classmethod_name()---Class method or static method.----global_constant_name----Global constant.IssuesPlease use the project'sissue pageto report any issues.ContactMarcus Read