menu.c: removed warnings
[k8opentitus.git] / readme.txt
blob24da244a95a6b72c608abf5dd695ae6c1e39c143
1 Readme for OpenTitus\r
2 Version 0.8.0\r
3 http://opentitus.sourceforge.net/\r
4 \r
5 OpenTitus is released under the Gnu GPL version 3 or (at your option) any later version of the license, and it is released "as is"; without any warranty.\r
6 \r
7 The OpenTitus team:\r
8 Eirik Stople - Main developer - eirik@pcfood.net\r
9 Eitan Tal - Valuable assistant, technical advisor\r
11 Thanks to:\r
12 Eric Zmiro and his team in Titus Interactive who made the great games Titus the Fox and Moktar!\r
13 Jesse, who made a fansite for the original game and an editor and provided me information how the original game files was built up, and assisted me with the makefile and MinGW!\r
14 The SDL project (LibSDL, LibSDL_mixer)!\r
15 The GNU project (GCC, GDB and GPL)!\r
16 MinGW/msys!\r
17 Ubuntu (programming environment)!\r
18 Linux!\r
19 Dosbox!\r
20 Dropbox!\r
21 GEdit!\r
22 Notepad++!\r
23 Google search!\r
24 Chocolate-Doom's great OPL (adlib) emulator!\r
25 Various tutorials/information sources on the net!\r
29 You need the original game files to make use of OpenTitus. OpenTitus parses the original files. It works with both Titus the Fox and Moktar.\r
30 Place the original game files in the "titus" or "moktar" folder. The files must be placed according to titus.conf.\r
32 Runtime dependencies:\r
33 SDL runtime library\r
34 SDL_mixer runtime library\r
36 To run the game, run opentitus (in Linux), opentitus.exe (windows) or opentitus_0.8.0.dge (dingux).\r
38 To quickly start up Titus, copy the game files from your original Titus game directory to the "titus" subfolder.\r
39 To quickly start up Moktar, copy the game files from your original Moktar game directory to the "moktar" subfolder. Rename "titus_moktar.conf" to "titus.conf" to play Moktar.\r
41 Compile instructions and platform specific information are available in the readme file for the target system (_linux, _win32, _dingux).\r
43 The game engine are ported from the original game, and modified to fit OpenTitus' level structure. If you find a bug or differences between OpenTitus and the original games, feel free to contact us.\r
45 Enjoy!\r
49 "Titus the Fox: To Marrakech and Back" (1992) and "Lagaf': Les Aventures de Moktar - Vol 1: La Zoubida" (1991)\r
50 was developed by, and is probably copyrighted by Titus Software, which, according to Wikipedia, stopped buisness in 2005.\r
51 OpenTitus is not affiliated with Titus Software.\r
53 The source code have been developed during several years, and some parts of the code are old. This code doesn't follow the more recent style, such as "unsigned char" instead of "uint8". As the old code still works, it's not that important to fix it.\r
55 OpenTitus is configured by a file in the same directory as the executable; "titus.conf". This file is parsed line by line, and lines starting with # will be skipped.\r
57 Keywords:\r
58 reswidth = Number of pixels wide, default 320 (originally 640, but the "pixels" in the original game was two pixels wide, so 320 should give the correct size)\r
59 resheight = Number of pixels height, default 200 (originally 400 (intro) or 384 (in-game), 200 should give the correct size)\r
60 bitdepth = Number of bits pr. pixel, default 32 (the game data files have a 16 colour palette, which means 4 bpp, but higher bpp will work as well)\r
61 ingamewidth = Numbers og pixels visible in-game, default 320.\r
62 ingameheight = Numbers og pixels visible in-game, default 192.\r
63 audiofile = Location of the audio file.\r
64 videomode = Video mode; 0 is window mode and 1 is fullscreen, default 0\r
65 levelcount = Number of levels, default 15 (15 in Titus the Fox and 16 in Moktar)\r
66 level 1-15 (1-16 for Moktar) = Location of the level files for all levels, default LEVELx.SQZ (the order is "0J123456789BCEFG" for Moktar, Titus is equal except it doesn't have level F)\r
67 sprites = Location of the sprite file, default SPREXP.SQZ (SPRITES.SQZ in Moktar)\r
68 game = The game opentitus will parse; 0 for Titus the Fox and 1 for Moktar. This is necessary because of different sprite sizes, different menus and different level titles.\r
69 logo = The company logo file, default TITUS.SQZ\r
70 intro = The game intro image file, default TITRE.SQZ\r
71 menu = The menu, default MENU.SQZ\r
72 finish = The image displayed when game is completed, default LEVELA.SQZ (this doesn't exist in Moktar)\r
73 *format = Image format. 0: 16-colour grayscale, 1: 16-colour (ordinary colours), 2: 256 colours + palette. Logo, intro and menu are 256 colour, *EGA files are 16-colour, and LEVELA.SQZ are grayscale\r
74 font = Font file, default FONTS.SQZ