README.md

   1 # python-bulletml - BulletML for Python
   2
   3 BulletML is the Bullet Markup Language. BulletML can describe the
   4 barrage of bullets in shooting games. (For example Progear, Psyvariar,
   5 Gigawing2, G DARIUS, XEVIOUS, ...) This module parses and executes
   6 BulletML scripts in Python. All data structures in it are
   7 renderer-agnostic. A sample renderer for Pygame is included. The full
   8 API documentation is contained in its Python docstrings.
   9
  10 In addition to the standard BulletML XML format, this module supports
  11 an equivalent YAML format. For convenience, two simple collision
  12 routines are provided, `bulletml.overlaps` for stationary circles and
  13 `bulletml.collides` for moving circles.
  14
  15 More information is available at
  16 [the BulletML homepage](http://www.asahi-net.or.jp/~cs8k-cyu/bulletml/index_e.html),
  17 or
  18 [the python-bulletml homepage](https://yukkurigames.com/python-bulletml/).
  19
  20     $ ./bulletml-runner examples/*/*.xml
  21
  22 Use Page Up and Page Down to switch between bullet definitions, S to
  23 respawn the bullet pattern, and Enter to restart it.
  24
  25
  26 ## Installing
  27
  28 BulletML requires Python 2.6 or later. It should work on Python 3. It
  29 has no dependencies outside the CPython standard library.
  30
  31     $ ./setup.py build
  32     $ sudo ./setup.py install
  33
  34
  35 ## License
  36
  37 The BulletML specification is the work of Kenta Cho.
  38
  39 All example BulletML files in the examples folder are released into
  40 the public domain. Everything else is covered by the following
  41 license:
  42
  43 Copyright 2010 Joe Wreschnig
  44
  45 Permission is hereby granted, free of charge, to any person obtaining a copy
  46 of this software and associated documentation files (the "Software"), to deal
  47 in the Software without restriction, including without limitation the rights
  48 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  49 copies of the Software, and to permit persons to whom the Software is
  50 furnished to do so, subject to the following conditions:
  51
  52 The above copyright notice and this permission notice shall be included in
  53 all copies or substantial portions of the Software.
  54
  55 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  56 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  57 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  58 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  59 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  60 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  61 THE SOFTWARE.