Adding Flying Digger and updating README.
[kxp.git] / README
1 KXP = KGoldRunner eXpansion Pack. This consists of games I've made for 
2 KGoldrunner.
3
4 To use them first catch your rabbit: Somehow get KGoldrunner 
5 installed. Your GNU/Linux distribution has probably already packaged 
6 it for easy installation.
7
8 Then place the .grl files in 
9 ~/.kde/share/apps/kgoldrunner/user/levels, creating this if it doesn't 
10 exist.
11
12 Edit or create ~/.kde/share/apps/kgoldrunner/user/games.dat and add 
13 these lines:
14
15 48 T bl Beginner's Luck
16 28 T fd Flying Digger
17
18 Now run KGoldrunner and when you select New Game from the Game menu, 
19 you should see both Beginner's Luck and Flying Digger listed.
20
21 Enjoy!
22
23 Surplus Levels Directory
24 This contains levels which may be used in other games in the future.
25
26
27 SOLUTIONS
28 =========
29
30 Stuck? Need help? Can't figure out how to pass a level? Normally I'd 
31 tell you to select Show A Solution from the Move menu but it appears 
32 that KGoldRunner doesn't allow third party level designers to provide 
33 their own solutions.
34
35 I've come up with a workaround using the fact that KGoldRunner records 
36 you as you play levels. The file rec_bl.txt contains recordings of my 
37 playing the levels from Beginner's Luck. Similiarly, the file 
38 rec_fd.txt contains that from Flying Digger.
39
40 If you'd like to see how I did something, move that file into 
41 ~/.kde/share/apps/kgoldrunner/user. However: Be aware that since 
42 KGoldRunner has been recording you playing the levels this will 
43 overwrite your recordings. You may want to back up your recordings 
44 file if you want to be able to keep it. Also, if you then go play a 
45 level it will overwrite my recording with yours. As a result, you may 
46 need to keep a "pristine" copy of my recordings file around so that it 
47 can be swapped in as needed if you want to see multiple solutions 
48 while playing levels in between them.
49
50 Hopefully these limitations will be addressed in a future version of 
51 KGoldRunner.
52
53 Thanks to Ian Wadham for all of his feedback and listening.
54
55 You can redistribute and/or modify these levels under the terms of the 
56 GNU General Public License as published by the Free Software 
57 Foundation, either version 3 of the License, or (at your option) any 
58 later version.
59
60 The levels are distributed in the hope that they will be useful, but 
61 WITHOUT ANY WARRANTY; without even the implied warranty of 
62 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
63 General Public License for more details.
64
65 You should have received a copy of the GNU General Public License 
66 along with these levels. If not, see <http://www.gnu.org/licenses/>.