README
1Quantum Minigolf - a computer game visualizing quantum mechanics
2----------------------------------------------------------------
3
4Copyright 2007, Friedemann Reinhard, friedemann.reinhard@ens.fr
5
6Overview:
7---------
8
9Quantum minigolf is a minigolf simulation, in which the ball
10behaves according to the laws of quantum mechanics. Such a quantum
11ball can be at several places at once and diffract around obstacles.
12
13Quantum minigolf exists in two versions
14 - the sofware-only version, which you have most probably in
15 front of you when you read this file
16 - a virtual-reality version. Here the user plays with a real
17 club which is marked by an infrared LED and tracked by a
18 webcam. The ball is projected to the ground by a video
19 projector mounted on the ceiling.
20 Basically, the software release contains all the neccessary
21 code to build the virtual-reality version. However building
22 it will not (yet) be easy, since it is not documented yet :-(
23
24You can find further information and the latest version of quantum
25minigolf at
26http://www.sourceforge.net/projects/quantumminigolf
27
28Copyright Notice:
29-----------------
30
31Quantum minigolf uses several GPLed libraries. Their source code can
32be found at the following locations
33
34 * fftw3f - the single precision (!) version of libfftw
35 http://www.fftw.org/
36
37 * SDL
38 http://www.libsdl.org
39 * SDL_ttf
40 http://www.libsdl.org/projects/SDL_ttf/
41
42 * freetype
43 http://www.freetype.org/
44
45 * Linux Libertine open fonts
46 http://sourceforge.net/projects/linuxlibertine/
47
48Installation:
49-------------
50
51*Win32
52 Binary packages:
53 Double-click on setup.msi or quantumminigolf_win32.exe
54
55 Source packages:
56 Open the supplied Visual C++ Project file. It works with Visual C++
57 2005 Express Edition, which is free of charge. However, you might need
58 to update the library paths according to your needs.
59
60*Linux / others
61 Edit the Makefile according to your needs and compile
62
63
64Creating Tracks:
65----------------
66
67Quantum minigolf allows you to easily create your own tracks. Just
68open tracks/empty.bmp with your favorite graphics software and add
69some obstacles. Purely white obstacles (i.e. obstacles with color
70rgb(255,255,255)) are infinitely high. Gray obstacles have a finite
71height proportional to their intensity.
72
73When you have finished a track, add its name in a new line of
74tracks/tracks.cfg.
75
76If you want to use your new track also with the classical simulator,
77create two hard- and softcore bitmaps using the Matlab/Octave file
78tracks/q2c.m and add their names to the tracks.cfg file.
79If you do not create the hard- and softcore bitmaps, the quantum
80simulator will nevertheless be able to use your new track.
81
82
83
84
85
