README.txt

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