Remove unused argument.
[python-bulletml.git] / 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.
12
13 A sample renderer for Pygame is included.
14
15 More information is available at the BulletML homepage,
16 http://www.asahi-net.or.jp/~cs8k-cyu/bulletml/index_e.html, or the
17 python-bullet homepage, http://code.google.com/p/python-bulletml/.
18
19 $ ./bulletml-runner examples/*/*.xml
20
21 Use Page Up and Page Down to switch between bullet definitions, S to
22 respawn the bullet pattern, and Enter to restart it.
23
24
25 Installing
26 ----------
27 $ ./setup.py build
28 $ sudo ./setup.py install
29
30
31 License
32 -------
33
34 The BulletML specification is the work of Kenta Cho.
35
36 All example BulletML files in the examples folder are released into
37 the public domain. Everything else is covered by the following
38 license:
39
40 Copyright 2010 Joe Wreschnig
41
42 Permission is hereby granted, free of charge, to any person obtaining a copy
43 of this software and associated documentation files (the "Software"), to deal
44 in the Software without restriction, including without limitation the rights
45 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
46 copies of the Software, and to permit persons to whom the Software is
47 furnished to do so, subject to the following conditions:
48
49 The above copyright notice and this permission notice shall be included in
50 all copies or substantial portions of the Software.
51
52 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
53 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
54 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
55 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
56 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
57 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
58 THE SOFTWARE.