Mention BulletYAML support. (Fixes issue #6)
[python-bulletml.git] / bulletml / __init__.py
index 1e1dbcd..27faaf0 100644 (file)
@@ -6,6 +6,9 @@ Gigawing2, G DARIUS, XEVIOUS, ...) This module parses and executes
 BulletML scripts in Python. All data structures in it are
 renderer-agnostic.
 
+In addition to the standard BulletML XML format, this module supports
+an equivalent YAML format. See bulletml.bulletyaml for more details.
+
 More information is available at the BulletML homepage,
 http://www.asahi-net.or.jp/~cs8k-cyu/bulletml/index_e.html, or the
 python-bullet homepage, http://code.google.com/p/python-bulletml/.
@@ -16,7 +19,7 @@ Basic Usage:
     doc = Bulletml.BulletML.FromDocument(open("test.xml", "rU"))
     rank = 0.5    # Player difficulty, 0 to 1
     params = []   # Initial variable settings, usually empty
-    actions = [a(params, rank) for a in doc.top]
+    actions = [a(params, rank) for a in doc.actions]
     bullet = Bullet(x, y, target=player, actions=actions, rank=rank)
     bullets = [bullet]
     ...