1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
4 <maintainer type="project">
5 <email>games@gentoo.org</email>
6 <name>Gentoo Games Project</name>
9 Welcome to ClanLib, a multi-platform game development library.
11 ClanLib is a medium level development kit. At its lowest level, it provides a
12 platform independent (as much as that is possible in C++) way of dealing with
13 display, sound, input, networking, files, threadding and such.
15 On top of that, ClanLib builds a generic game development framework, giving you
16 easy handling of resources, network object replication, graphical user
17 interfaces (GUI) with theme support, game scripting and more.
19 The goal of ClanLib is to allow the game developer to focus on stuff that
20 matters, avoiding all those nasty (and boring) lowlevel trivials like setting up
21 a directdraw window, sound mixing, reading image files, etc. All those things
22 are simplified into object oriented classes and function calls, making it a joy
25 ClanLib uses a resource system to keep track of images, fonts, samples and
26 music. It supports Targa, PCX, JPEG, PNG and BMP for images. Wave files for
27 sample. Ogg Vorbis (open sound format that has same sound quality as mp3) and
28 MikMod for music. By using a resource system, you cleanly seperate the physical
29 data formats from your code, and makes it easy to make themes and other plugins
30 for your game. The resource system is written in a manner that allows you to add
31 your own custom resources.
33 All classes in clanlib focus on making simple interfaces that are customizeable
34 and expandable. This keeps your game code clean and simple; but still allows you
35 to do advanced stuff. As an example, look at some sound code:
36 CL_SoundBuffer my_sample("Weapon/Minigun/sound", resources);
39 In this example, we play a simple sound effect, and afterwards forget all about
40 it. Nice and simple. But if we want to adjust the frequency during its playback
41 (eg. for a dobbler effect), it could look like this:
42 CL_SoundBuffer_Session playback = my_sample.play();
43 playback.set_frequency(1.2f); // increase frequency by 20%
45 We only need to keep the session handle if we are going to use it. Keep things
46 simple when they are simple, and make them complex when they are complex. :)
48 The object oriented nature of ClanLib allows you to operate both at high and low
49 levels, minimizing redundant code and still allows you to do stuff that isnt
50 supported by clanlib's high level APIs.
52 ClanLib currently support Windows 98, Windows 2000, Windows XP and Linux. The
53 following display targets are supported under linux: X11 and OpenGL. Some parts
54 of ClanLib still isnt entirely endian clean, so it will currently only work
55 without problems on the x86 architecture. Work is underway for a MacOS port.
56 Current compilers supported is VC++ 6.0, VC++ 7.0, GCC, Borland and MingW.