Code Map

This page serves as a "map" of all of the files in the src directory. This page should be helpful to new contributors and is intended to help demystify them as to the structure of the code or where to find what they're looking for.

List of files by category

What follows is a sorted list of the files in the src directory grouped by the file's purpose and function. Note that some files may be in more than one group.

List of files and their contents

What follows is a list of every file in the src directory and a brief summary of the file's intended purpose and general content. The files are organized in alphabetical order.

cheats.d

Defines flags which are used to determine whether certain "cheat modes" have been activated. This file is also used to determine whether or not the game is going to start with a test map rather than generating a normal dungeon.

color.d

Defines a class for representing in-game color data and a second for storing color pairs, each of which is used to determine what colors the user interface will use to represent any particular character.

colors.d

Defines standard colors pairs and an enum used to represent them in the Symbol struct defined in sym.d. Also defines a function init_colors which is used to initialize the standard set of color pairs and store them in a global array CLR which is used by the game's output functions.

config.d

Defines various flags used to configure the game at compile-time.

dice.d

Sets up the random number generator, Lucky; and defines structs and functions related to in-game dice rolls.

fonts.d

Defines a struct FontDef which is used by the SDL interfaces to store data for specific fonts, namely the path to a font file and the height and width of each tile which uses that font.

Also defines an enum TileSet which is used to store the three primary fonts used by the game and identify them by name, currently standard, bold, and dyslexic.

fov.d

Defines functions related to calculating field-of-vision in-game.

Note that the code in this file is derived from the libtcod source code and as such is protected by the libtcod license in addition to the SwashRL license.

global.d

The global import file for SwashRL.

Defines a lot of important flags for the game's function, including the name of the compiled game and the version number, sets up a number of global variables determining functions such as map size and drawing offsets, and sets flags informing the program of which user interfaces are being compiled.

This file also imports every other source code file in the correct order.

iflags.d

Defines flags used to determine item properties, such as equipment slot and inventory category.

inven.d

Sets up the inventory system by defining the Inven struct, the indexes of the various inventory slots in the items array, and functions used for checking if the player character has a free grasp, whether an item can be equipped in a particular slot, etcetera.

iocurses.d

Defines the CursesIO class, which contains functions used for input and output on the curses interface. This class will define basic input and output functions used in the SwashIO interface in iomain.d to create more complex behaviors related to basic game IO.

iomain.d

Defines the SwashIO interface, which serves as a template for input and output on the curses and SDL interfaces and uses the generic functions defined by those interfaces to set up complex input and output behaviors such as displaying maps, printing characters and lines of text, and managing the inventory and equipment screens.

This file will also import iocurses.d and ioterm.d depending on what configuration is being compiled (i.e. whether version is curses, sdl, or both)

ioterm.d

Defines the SDLTerminalIO class, which contains functions and objects used for interfacing with the SDL "virtual terminal" interface. This class will set up the SDL window and initialize fonts, and defines functions which convert color flags to SDL color structs. This class also contains functions which allow for an "emergency shutdown" of the SDL window in case of the user getting stuck in an input loop and defines basic input and output functions which are used by the SwashIO interface in iomain.d to create more complex behaviors.

Also defined in this file is the SDLException, which is used to provide error-handling behavior for the SDL interface.

Note that large portions of the code in this file are protected by the SmugglerRL license in addition to the SwashRL license.

item.d

Defines the Item struct, a placeholder No_item used to fill in empty inventory and equipment slots as well as empty item slots on floor tiles, and a function Item_here used to determine whether or not an item slot is empty.

keymaps.d

Defines a function used to create keymaps, associative arrays or hash maps which are used to match the result of keypresses with movement flags defined in moves.d.

Also defined in this file is InvalidKeymapException, an Exception used to provide error information about bad keymaps created using the keymap function.

main.d

The mainfile for the program.

Defines functions related to displaying the version number, greeting the player at startup, initial game setup, and the main game loop. Also defines the SDL_MODES enum used to determine whether the SDL "mode" being used is terminal, full, or none.

The main function does a lot of the inital setup for the game, including interpreting command-line parameters, activating cheat modes, handling map storage, and most of the other essential functions which are necessary for setting up the game. It is also the main function which handles abrupt program shutdowns such as the closure of the SDL window.

The mainloop in main also handles user input, checking for messages at the end of every turn, and interpreting user input by either directly addressing movement flags or passing them into the umove function from mov.d.

map.d

Defines the Room and Map structs used to hold level data, including tile data, the locations of items, monster storage, the visibility of each tile, and the coordinates for the player's starting location.

Also defined in this file are functions used to add and remove monsters from the map.

mapalgo.d

Contains functions used to generate new Maps using various algorithms, including an empty_Map. In future revisions of the code, the generate_new_map function will take in a parameter determining which level generation algorithm will be used.

mapgen.d

Contains functions and constants used by the functions in mapalgo.d to generate maps by carving rooms and corridors, growing mold in the level, et cetera.

This file also contains the test_map function, which in debug builds can be used to generate the test map.

monst.d

Defines the Monst struct, which is used to represent monster data, and functions used to create new monsters.

Also defined in this file are the functions monst_name, the_monst, and The_monst, which are used to format a monster's name into formatted strings such as "%s hits you!"

Also defined in this file is the Mon struct, which in future versions of the code will be used to store monster generation data from which Monst objects can be generated.

mov.d

Contains all functions related to player and monster movement, including functions which calculate changes in x and y coordinate based on movement data and monster AI.

moves.d

Contains flags which define all of the possible "moves" the player can make, or in other words all of the possible commands which can be given to the game. Some of these are also used in mov.d to calculate differences in x and y coordinate during movement.

Code Map

Table of Contents

List of files by category

Configuration

Constants and Enums

Global Variables

Maps and Mapgen

Items and Inventory

Monsters

Dice and RNG

User I/O

Visuals and Display

File I/O

Miscellaneous

List of files and their contents

Uh oh!

Uh oh!

Uh oh!

Clone this wiki locally