finalize revision 0.032
[SwashRL.git] / src / config.d
blob97594000dade75a3a47bad7ac7ff55d6756f63bb
1 /*
2 * Copyright (c) 2015-2020 Philip Pavlick. See '3rdparty.txt' for other
3 * licenses. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the SwashRL project nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
29 // This is the configuration file for SwashRL. It defines flags which affect
30 // how your copy of SwashRL will compile.
32 // SECTION 0: ////////////////////////////////////////////////////////////////
33 // Instructions for the compiler //
34 //////////////////////////////////////////////////////////////////////////////
36 // Setting this to `true` will cause the program to output the current git
37 // commit number when asked for the version number. This will not affect
38 // version numbers which are output to save files for compatibility purposes.
39 // If you are not compiling from a git repository, you'll have to set this to
40 // `false` in order to compile.
41 enum INCLUDE_COMMIT = true;
43 // SECTION 1: ////////////////////////////////////////////////////////////////
44 // Display configuration //
45 //////////////////////////////////////////////////////////////////////////////
47 // What character to use for the player. `'@'` is recommended.
48 enum SMILEY = '@';
50 // Whether to use reversed graphics to make walls look more solid and
51 // connected (this makes the game much more pleasing to the eye on a number
52 // of terminals I tested with it)
53 enum REVERSED_WALLS = true;
55 // Color settings ////////////////////////////////////////////////////////////
57 // Enables color. This setting will also enable the FOLIAGE and BLOOD
58 // settings, defined below, if they are set to `true`.
59 enum COLOR = true;
61 // Enables foliage. Foliage grows randomly in dungeons and has no practical
62 // effect on gameplay other than turning tiles green.
63 enum FOLIAGE = true;
65 // Enables blood. Blood splatter will appear on map tiles when a creature is
66 // hit. This has no practical effect other than turning map tiles red.
67 enum BLOOD = true;
69 // Curses-specific options ///////////////////////////////////////////////////
71 // Enables special effects like the highlighted player and reversed walls.
72 // Only works if your curses standard uses these effects (it probably does).
73 enum TEXT_EFFECTS = true;
75 // SDL-specific options //////////////////////////////////////////////////////
77 // Set this to `true` to use the OpenDyslexic font rather than the standard
78 // fonts. This should make it easier for dyslexic players to differentiate
79 // characters in the SDL display.
80 enum DYSLEXIA = false;
82 // Set this to `true` to use a bolder font for the message line & status bar
83 // in the SDL terminal interface. This may be a bit more readable than the
84 // standard font for these purposes.
85 enum BOLD_MESSAGE_FONT = true;
87 // SECTION 2: ////////////////////////////////////////////////////////////////
88 // SwashRL configuration //
89 //////////////////////////////////////////////////////////////////////////////
91 // The number of messages to store in the message buffer
92 enum MAX_MESSAGE_BUFFER = 20;