Unified · Split
| @@ -1,42 +1,41 @@ | ||
| 1 | −/* _______ ____ __ ___ ___ | |
| 2 | − * \ _ \ \ / \ / \ \ / / ' ' ' | |
| 3 | − * | | \ \ | | || | \/ | . . | |
| 4 | − * | | | | | | || ||\ /| | | |
| 5 | − * | | | | | | || || \/ | | ' ' ' | |
| 6 | − * | | | | | | || || | | . . | |
| 7 | − * | |_/ / \ \__// || | | | |
| 8 | − * /_______/ynamic \____/niversal /__\ /____\usic /| . . ibliotheque | |
| 9 | − * / \ | |
| 10 | − * / . \ | |
| 11 | − * readme.txt - General information on DUMB. / / \ \ | |
| 12 | − * | < / \_ | |
| 13 | − * | \/ /\ / | |
| 14 | − * \_ / > / | |
| 15 | − * | \ / / | |
| 16 | − * | ' / | |
| 17 | − * \__/ | |
| 18 | − */ | |
| 19 | − | |
| 20 | − | |
| 21 | −******************** | |
| 22 | −*** Introduction *** | |
| 23 | −******************** | |
| 24 | − | |
| 1 | +# Dynamic Universal Music Bibliotheque (libdumb) | |
| 2 | + | |
| 3 | + _______ ____ __ ___ ___ | |
| 4 | + \ _ \ \ / \ / \ \ / / ' ' ' | |
| 5 | + | | \ \ | | || | \/ | . . | |
| 6 | + | | | | | | || ||\ /| | | |
| 7 | + | | | | | | || || \/ | | ' ' ' | |
| 8 | + | | | | | | || || | | . . | |
| 9 | + | |_/ / \ \__// || | | | |
| 10 | + /_______/ynamic \____/niversal /__\ /____\usic /| . . ibliotheque | |
| 11 | + / \ | |
| 12 | + / . \ | |
| 13 | + / / \ \ | |
| 14 | + | < / \_ | |
| 15 | + | \/ /\ / | |
| 16 | + \_ / > / | |
| 17 | + | \ / / | |
| 18 | + | ' / | |
| 19 | + \__/ | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | +## Introduction | |
| 25 | 24 | |
| 26 | 25 | Thank you for downloading DUMB v0.9.3! You should have the following |
| 27 | 26 | documentation: |
| 28 | 27 | |
| 29 | − readme.txt - This file | |
| 30 | − licence.txt - Conditions for the use of this software | |
| 31 | − release.txt - Release notes and changes for this and past releases | |
| 32 | − docs/ | |
| 33 | − howto.txt - Step-by-step instructions on adding DUMB to your project | |
| 34 | − faq.txt - Frequently asked questions and answers to them | |
| 35 | − dumb.txt - DUMB library reference | |
| 36 | − deprec.txt - Information about deprecated parts of the API | |
| 37 | − ptr.txt - Quick introduction to pointers for those who need it | |
| 38 | − fnptr.txt - Explanation of function pointers for those who need it | |
| 39 | − modplug.txt - Our official position regarding ModPlug Tracker | |
| 28 | + * readme.txt - This file | |
| 29 | + * licence.txt - Conditions for the use of this software | |
| 30 | + * release.txt - Release notes and changes for this and past releases | |
| 31 | + * docs/ | |
| 32 | + * howto.txt - Step-by-step instructions on adding DUMB to your project | |
| 33 | + * faq.txt - Frequently asked questions and answers to them | |
| 34 | + * dumb.txt - DUMB library reference | |
| 35 | + * deprec.txt - Information about deprecated parts of the API | |
| 36 | + * ptr.txt - Quick introduction to pointers for those who need it | |
| 37 | + * fnptr.txt - Explanation of function pointers for those who need it | |
| 38 | + * modplug.txt - Our official position regarding ModPlug Tracker | |
| 40 | 39 | |
| 41 | 40 | This file will help you get DUMB set up. If you have not yet done so, please |
| 42 | 41 | read licence.txt and release.txt before proceeding. After you've got DUMB set |
| @@ -44,10 +43,7 @@ up, please refer to the files in the docs/ directory at your convenience. I · 1 unmodified line | ||
| 44 | 43 | recommend you start with howto.txt. |
| 45 | 44 | |
| 46 | 45 | |
| 47 | −**************** | |
| 48 | −*** Features *** | |
| 49 | −**************** | |
| 50 | − | |
| 46 | +## Features | |
| 51 | 47 | |
| 52 | 48 | Here is the statutory feature list: |
| 53 | 49 | |
| @@ -97,10 +93,7 @@ Here is the statutory feature list: · 43 unmodified lines | ||
| 97 | 93 | compiling it manually are available further down |
| 98 | 94 | |
| 99 | 95 | |
| 100 | −********************* | |
| 101 | −*** What you need *** | |
| 102 | −********************* | |
| 103 | − | |
| 96 | +## What you need | |
| 104 | 97 | |
| 105 | 98 | To use DUMB, you need a 32-bit C compiler (GCC and MSVC are fine). If you |
| 106 | 99 | have Allegro, DUMB can integrate with its audio streams and datafiles, making |
| @@ -111,9 +104,7 @@ Allegro. · 4 unmodified lines | ||
| 111 | 104 | Allegro - http://alleg.sf.net/ |
| 112 | 105 | |
| 113 | 106 | |
| 114 | −********************************************** | |
| 115 | −*** How to set DUMB up with DJGPP or MinGW *** | |
| 116 | −********************************************** | |
| 107 | +## How to set DUMB up with DJGPP or MinGW | |
| 117 | 108 | |
| 118 | 109 | |
| 119 | 110 | You should have got the .zip version. If for some reason you got the .tar.gz |
| @@ -134,11 +125,11 @@ Change to the directory into which you unzipped DUMB. · 14 unmodified lines | ||
| 134 | 125 | |
| 135 | 126 | If you are using MinGW (and you haven't renamed 'mingw32-make'), type: |
| 136 | 127 | |
| 137 | − mingw32-make | |
| 128 | + mingw32-make | |
| 138 | 129 | |
| 139 | 130 | Otherwise, type the following: |
| 140 | 131 | |
| 141 | − make | |
| 132 | + make | |
| 142 | 133 | |
| 143 | 134 | DUMB will ask you whether you wish to compile for DJGPP or MinGW. Then it |
| 144 | 135 | will ask you whether you want support for Allegro. (You have to have made and |
| @@ -147,15 +138,15 @@ compile optimised and debugging builds of DUMB, along with the example · 2 unmodified lines | ||
| 147 | 138 | programs. When it has finished, run one of the following to install the |
| 148 | 139 | libraries: |
| 149 | 140 | |
| 150 | − make install | |
| 151 | − mingw32-make install | |
| 141 | + make install | |
| 142 | + mingw32-make install | |
| 152 | 143 | |
| 153 | 144 | All done! If you ever need the configuration again (e.g. if you compiled for |
| 154 | 145 | DJGPP before and you want to compile for MinGW now), run one of the |
| 155 | 146 | following: |
| 156 | 147 | |
| 157 | − make config | |
| 158 | − mingw32-make config | |
| 148 | + make config | |
| 149 | + mingw32-make config | |
| 159 | 150 | |
| 160 | 151 | See the comments in the Makefile for other targets. |
| 161 | 152 | |
| @@ -178,10 +169,7 @@ when you are ready to start programming with DUMB. If you use DUMB in a game, · 16 unmodified lines | ||
| 178 | 169 | let me know - I might decide to place a link to your game on DUMB's website! |
| 179 | 170 | |
| 180 | 171 | |
| 181 | −****************************************************** | |
| 182 | −*** How to set DUMB up with Microsoft Visual C++ 6 *** | |
| 183 | −****************************************************** | |
| 184 | − | |
| 172 | +## How to set DUMB up with Microsoft Visual C++ 6 | |
| 185 | 173 | |
| 186 | 174 | If you have a newer version of Microsoft Visual C++ or Visual Something that |
| 187 | 175 | supports C++, please try these instructions and let me know if it works. |
| @@ -266,10 +254,7 @@ start using DUMB, refer to docs/howto.txt. If you use DUMB in a game, let me · 78 unmodified lines | ||
| 266 | 254 | know - I might decide to place a link to your game on DUMB's website! |
| 267 | 255 | |
| 268 | 256 | |
| 269 | −****************************************************** | |
| 270 | −*** How to set DUMB up on Linux, BeOS and Mac OS X *** | |
| 271 | −****************************************************** | |
| 272 | − | |
| 257 | +## How to set DUMB up on Linux, BeOS and Mac OS X | |
| 273 | 258 | |
| 274 | 259 | You should have got the .tar.gz version. If for some reason you got the .zip |
| 275 | 260 | version instead, you may have to strip all characters with ASCII code 13 from |
| @@ -288,7 +273,7 @@ If you are not using the configure script, the procedure is as follows. · 12 unmodified lines | ||
| 288 | 273 | |
| 289 | 274 | First, run the following command as a normal user: |
| 290 | 275 | |
| 291 | − make | |
| 276 | + make | |
| 292 | 277 | |
| 293 | 278 | You will be asked whether you want Allegro support. Then, unless you are on |
| 294 | 279 | BeOS, you will be asked where you'd like DUMB to install its headers, |
| @@ -299,7 +284,7 @@ not work. Once you have specified these pieces of information, the optimised · 4 unmodified lines | ||
| 299 | 284 | and debugging builds of DUMB will be compiled, along with the examples. When |
| 300 | 285 | it has finished, you can install them with: |
| 301 | 286 | |
| 302 | − make install | |
| 287 | + make install | |
| 303 | 288 | |
| 304 | 289 | You may need to be root for this to work. It depends on the prefix you chose. |
| 305 | 290 | |
| @@ -324,7 +309,7 @@ The default Makefile is a copy of Makefile.rdy (short for 'ready'), and it · 18 unmodified lines | ||
| 324 | 309 | must exist with the name Makefile.rdy in order to work. The configure script |
| 325 | 310 | will overwrite Makefile, so if you want the default Makefile back, just run: |
| 326 | 311 | |
| 327 | − cp Makefile.rdy Makefile | |
| 312 | + cp Makefile.rdy Makefile | |
| 328 | 313 | |
| 329 | 314 | Do not use a symlink, as that would result in Makefile.rdy getting |
| 330 | 315 | overwritten next time the configure script is run! |
| @@ -333,10 +318,7 @@ You can also access the usual build system by passing '-f Makefile.rdy' to · 2 unmodified lines | ||
| 333 | 318 | Make. |
| 334 | 319 | |
| 335 | 320 | |
| 336 | −******************************************************** | |
| 337 | −*** How to build DUMB manually if nothing else works *** | |
| 338 | −******************************************************** | |
| 339 | − | |
| 321 | +## How to build DUMB manually if nothing else works | |
| 340 | 322 | |
| 341 | 323 | Those porting to platforms without floating point support should be aware |
| 342 | 324 | that DUMB does use floating point operations but not in the inner loops. They |
| @@ -387,16 +369,14 @@ by simple name with no path, then that is ideal. · 44 unmodified lines | ||
| 387 | 369 | If you successfully port DUMB to a new platform, please let me know! |
| 388 | 370 | |
| 389 | 371 | |
| 390 | −**************************** | |
| 391 | −*** The example programs *** | |
| 392 | −**************************** | |
| 393 | − | |
| 372 | +## The example programs | |
| 394 | 373 | |
| 395 | 374 | Three example programs are provided. On DOS and Windows, you can find them in |
| 396 | 375 | the examples subdirectory. On other systems they will be installed system- |
| 397 | 376 | wide. |
| 398 | 377 | |
| 399 | −dumbplay | |
| 378 | + | |
| 379 | +### dumbplay | |
| 400 | 380 | This program will only be built if you have Allegro. Pass it the filename |
| 401 | 381 | of an IT, XM, S3M or MOD file, and it will play it. It's not a polished |
| 402 | 382 | player with real-time threading or anything - so don't complain about it |
| @@ -406,7 +386,9 @@ dumbplay · 3 unmodified lines | ||
| 406 | 386 | where the program is installed system-wide, but it is non-fatal.) Have a |
| 407 | 387 | look at the examples/dumb.ini file for further information. |
| 408 | 388 | |
| 409 | −dumbout | |
| 389 | + | |
| 390 | +### dumbout | |
| 391 | + | |
| 410 | 392 | This program does not need Allegro. You can use it to stream an IT, XM, |
| 411 | 393 | S3M or MOD file to raw PCM. This can be used as input to an encoder like |
| 412 | 394 | oggenc (with appropriate command-line options), or it can be sent to a |
| @@ -415,15 +397,14 @@ dumbout · 2 unmodified lines | ||
| 415 | 397 | render a module with the module's playing time! dumbout doesn't try to |
| 416 | 398 | read any configuration file; the options are set on the command line. |
| 417 | 399 | |
| 418 | −dumb2wav | |
| 400 | + | |
| 401 | +### dumb2wav | |
| 402 | + | |
| 419 | 403 | This program is much the same as dumbout, but it writes a .wav file with |
| 420 | 404 | the appropriate header. Thanks go to Chad Austin for this useful tool. |
| 421 | 405 | |
| 422 | 406 | |
| 423 | −********************************************* | |
| 424 | −*** Downloading music or writing your own *** | |
| 425 | −********************************************* | |
| 426 | − | |
| 407 | +## Downloading music or writing your own | |
| 427 | 408 | |
| 428 | 409 | If you would like to compose your own music modules, then this section should |
| 429 | 410 | help get you started. |
| @@ -431,9 +412,9 @@ help get you started. · 1 unmodified line | ||
| 431 | 412 | The best programs for the job are the trackers that pioneered the file |
| 432 | 413 | formats: |
| 433 | 414 | |
| 434 | − Impulse Tracker - IT files - http://www.lim.com.au/ImpulseTracker/ | |
| 435 | − Fast Tracker II - XM files - http://www.fasttracker2.com/ | |
| 436 | − Scream Tracker 3 - S3M files - No official site known, please use Google | |
| 415 | +* Impulse Tracker - IT files - http://www.lim.com.au/ImpulseTracker/ | |
| 416 | +* Fast Tracker II - XM files - http://www.fasttracker2.com/ | |
| 417 | +* Scream Tracker 3 - S3M files - No official site known, please use Google | |
| 437 | 418 | |
| 438 | 419 | MOD files come from the Amiga; I do not know what PC tracker to recommend for |
| 439 | 420 | editing these. If you know of one, let me know! In the meantime, I would |
| @@ -472,6 +453,7 @@ with it. There are plug-ins available to improve Winamp's module support, for · 32 unmodified lines | ||
| 472 | 453 | example WSP. |
| 473 | 454 | |
| 474 | 455 | Winamp - http://www.winamp.com/ |
| 456 | + | |
| 475 | 457 | WSP - http://www.spytech.cz/index.php?sec=demo |
| 476 | 458 | |
| 477 | 459 | (There is a Winamp plug-in that uses DUMB, but it is unreliable. If anyone |
| @@ -489,11 +471,11 @@ download samples at · 11 unmodified lines | ||
| 489 | 471 | If you would like to download module files composed by other people, check |
| 490 | 472 | the following sites: |
| 491 | 473 | |
| 492 | − http://www.modarchive.com/ | |
| 493 | − http://www.scene.org/ | |
| 494 | − http://www.tump.net/ | |
| 495 | − http://www.homemusic.cc/main.php | |
| 496 | − http://www.modplug.com/ | |
| 474 | + * http://www.modarchive.com/ | |
| 475 | + * http://www.scene.org/ | |
| 476 | + * http://www.tump.net/ | |
| 477 | + * http://www.homemusic.cc/main.php | |
| 478 | + * http://www.modplug.com/ | |
| 497 | 479 | |
| 498 | 480 | Once again, if you know of more sites where samples or module files are |
| 499 | 481 | available for download, please let me know. |
| @@ -516,10 +498,7 @@ loading), but future versions of DUMB will be able to rectify these mistakes. · 16 unmodified lines | ||
| 516 | 498 | On the other hand, if you convert the file, the damage is permanent. |
| 517 | 499 | |
| 518 | 500 | |
| 519 | −*********************** | |
| 520 | −*** Contact details *** | |
| 521 | −*********************** | |
| 522 | − | |
| 501 | +## Contact details | |
| 523 | 502 | |
| 524 | 503 | If you have trouble with DUMB, or want to contact me for any other reason, my |
| 525 | 504 | e-mail address is given below. Please do get in touch, even if I appear to |
| @@ -529,10 +508,7 @@ If you wish to chat online about something, perhaps on IRC, that can most · 3 unmodified lines | ||
| 529 | 508 | likely be arranged. Send me an e-mail. |
| 530 | 509 | |
| 531 | 510 | |
| 532 | −****************** | |
| 533 | −*** Conclusion *** | |
| 534 | −****************** | |
| 535 | − | |
| 511 | +## Conclusion | |
| 536 | 512 | |
| 537 | 513 | This is the conclusion. |
| 538 | 514 | |