changed targetname
[lsystem3d.git] / README
CommitLineData
9469555e 1DESCRIPTION
2-----------
3
4LSystem3d is a experimental Lindenmayer System generator with 3d capabilities,
5whose main goal is to generate all kinds of plants or whatever fractal
6l-system structures the user desires. For now, LSystem3d is highly under
7development and is considered alpha, that is, lots of things are missing and
8it will probably not work 100% accurate.
9
10
11
12REQUIREMENTS
13------------
14
15Currently tested in Debian GNU/Linux (Sid) only, but should compile fine on
16other platforms without bigger modification.
17
18Necessary libs:
19
20OpenGL
21GLU
22GLUI User Interface Library
23GLUT (freeglut)
24libxml++
25glibmm
26
27
28
29USAGE
30-----
31
32Keys:
33
34Esc quit
35+ zoom in
36- zoom out
37y rotate around the y-axis
38Up move camera up
39Down move camera down
40Left move camera left
41Right move camera right
42PageUp move camera forth
43PageDown move camera back
44
45
46Rules:
47
48= name/rule separator
49A-Z rewrite operator, step forward
50+ turn left
51- turn right
52& pitch down
53^ pitch up
54\ roll left
55/ roll right
56| turn around 180 degrees
57[ save state to stack
58] restore state from stack
59{ first vertex of a filled surface
60} last vertex of a filled surface
61f one vertex of a filled surface
62! decrement diameter of segment
63
64
65Example:
66
67The GUI input
68
69Axiom: A
70Rule #1: A=A/[!+A&A]/A
71Angle: 30.0
72Iterations: 4
73
74will render a simple l-system and create the xml-structure
75
76<?xml version="1.0"?>
77<lsystem>
78 <axiom>A</axiom>
79 <rule name="A">A/[!+A&amp;A]/A</rule>
80 <angle>30.0</angle>
81 <iterations>4</iterations>
82</lsystem>
83
84and save it to the file named "lsystem.xml" when quitting. The same file will
85be initially loaded every time LSystem3d is started.