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