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