Code documentation


Problems running or configuring the software, commands & options, compiling, different platforms, using the interface, documentation, etc.

Dungeon Dilettante

Posts: 2

Joined: Sunday, 25th March 2012, 00:41

Post Thursday, 12th April 2012, 01:44

Code documentation

Hi, is there anywhere I can find some more detailed documentation on the individual files in the source? Specifically, I have these questions:

- For a standard, Linux local tiles build, what global defines are used?
- To what extent is Cocos2d and SDL used? (Tiles) From what I can see, only SDLMain.m actually includes SDL.h, but thats in objective-c... Is that file only for mac builds?
- Is curses still used in the tiles build? What is the primary library that the tiles interface uses?

Thanks.
User avatar

Crypt Cleanser

Posts: 645

Joined: Wednesday, 14th September 2011, 09:36

Location: <---

Post Friday, 13th April 2012, 00:42

Re: Code documentation

Hi, is there anywhere I can find some more detailed documentation on the individual files in the source? Specifically, I have these questions:
You can find a lot of information in the doc : http://gitorious.org/crawl/crawl/trees/master/crawl-ref/docs/develop
There isn't detailed "whatis", so it's recommended to use grep or IDE to track functions.

- For a standard, Linux local tiles build, what global defines are used?
make TILES=y (and maybe make install) The makefile contain all typical parameters in the first lines

- To what extent is Cocos2d and SDL used? (Tiles) From what I can see, only SDLMain.m actually includes SDL.h, but thats in objective-c... Is that file only for mac builds?
Can't totally answer that one, but SDL is required only for tile
Note that the graphical build requires that you have development libraries
installed for SDL, SDL_image, libpng, zlib, and freetype

- Is curses still used in the tiles build? What is the primary library that the tiles interface uses?
Nope, tiles use libraries listed above, others are listed in INSTALL.TXT
GNU gcc and g++, GNU make, libncursesw or libcursesw. You need the development
headers for ncurses - they may not be installed by default on some Unixes.

* If you want both ASCII and Tiles binaries you need to compile them
separately, rename one of them, and copy them into the same Crawl
directory.

Thanks.
no problem

Return to Technical Support

Who is online

Users browsing this forum: No registered users and 5 guests

cron
Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group.
Designed by ST Software for PTF.