2 * Empire - A multi-player, client/server Internet based war game.
3 * Copyright (C) 1986-2013, Dave Pare, Jeff Bailey, Thomas Ruschak,
4 * Ken Stevens, Steve McClure, Markus Armbruster
6 * Empire is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 * See files README, COPYING and CREDITS in the root of the source
22 * tree for related information and legal notices. It is expected
23 * that future projects/authors will amend these files as needed.
27 * econfig-spec.h: Combined include for optlist.h and emp_config.c
29 * Known contributors to this file:
31 * Markus Armbruster, 2004-2012
35 * This file declares econfig keys. It expand into the corresponding
36 * variable declarations if defined(EMP_CONFIG_H_OUTPUT), and into
37 * struct keymatch[] initializers if defined(EMP_CONFIG_C_OUTPUT).
39 * EMPCFBOTH() defines econfig keys. EMPCF_OPT() is a convenience
40 * wrapper for options. EMPCF_COMMENT() defines comments.
44 * Preprocessor of MSC C++ 6.0 (VC98) is broken and chokes on empty
45 * macro arguments. Fixed in MSC C++ 7.0. Work around: pass
46 * useless token `unused'.
49 #if defined(EMP_CONFIG_C_OUTPUT)
51 #define EMPCFONLYC(fvname, vname, vtype, ctype, flags, descr) \
52 { (fvname), (ctype), &(vname), (flags), (descr) },
53 #define EMPCFBOTH(fvname, vname, vtype, ctype, flags, descr) \
54 { (fvname), (ctype), &(vname), (flags), (descr) },
56 #elif defined(EMP_CONFIG_H_OUTPUT)
58 #define EMPCFONLYC(fvname, vname, vtype, ctype, flags, descr)
59 #define EMPCFBOTH(fvname, vname, vtype, ctype, flags, descr) \
62 #endif /* EMP_CONFIG_C_OUTPUT || EMP_CONFIG_H_OUTPUT */
64 #define EMPCF_COMMENT(comment) \
65 EMPCFONLYC("", emp_config_dummy, unused , NSC_NOTYPE, 0, (comment))
67 #define EMPCF_OPT(fvname, vname, descr) \
68 EMPCFBOTH((fvname), (vname), int, NSC_INT, KM_OPTION, (descr))
70 /* econfig key definitions: */
72 EMPCF_COMMENT("\n### Server configuration and information")
73 EMPCFBOTH("custom_tables", custom_tables, char *, NSC_STRING, KM_INTERNAL,
74 "Custom configuration table files, separated by space")
75 EMPCFBOTH("data", gamedir_conf, char *, NSC_STRING, KM_INTERNAL,
76 "Directory where this game's data is stored")
77 EMPCFBOTH("info", infodir_conf, char *, NSC_STRING, KM_INTERNAL,
78 "Directory where info pages are stored, can be shared among games")
79 EMPCF_COMMENT("# Set this to your build tree's info.nr to run the server without\n"
81 EMPCFBOTH("builtin", builtindir_conf, char *, NSC_STRING, KM_INTERNAL,
82 "Directory where builtin files are stored")
83 EMPCF_COMMENT("# Set this to your source tree's src/lib/global to run the server\n"
84 "# without installing it, else leave it alone.")
85 EMPCFBOTH("listen_addr", listen_addr, char *, NSC_STRING, KM_INTERNAL,
86 "Local IP address the server should listen on")
87 EMPCF_COMMENT("# \"\" listens on all, localhost just on the loopback interface.")
88 EMPCFBOTH("port", loginport, char *, NSC_STRING, KM_INTERNAL,
89 "TCP port the server will bind")
90 EMPCFBOTH("keep_journal", keep_journal, int, NSC_INT, KM_INTERNAL,
91 "Enable journal log file")
92 EMPCF_COMMENT("# 0 - Disabled\n"
93 "# 1 - Enabled, player output suppressed\n"
94 "# 2 - Enabled, log everything (big; rotating & compressing advised)\n")
95 EMPCFBOTH("post_crash_dump_hook", post_crash_dump_hook, char *, NSC_STRING, KM_INTERNAL,
96 "Shell command run right after a crash dump, in the game's data directory")
97 EMPCFBOTH("privname", privname, char *, NSC_STRING, 0,
99 EMPCFBOTH("privlog", privlog, char *, NSC_STRING, 0,
100 "E-mail of the deity")
101 EMPCFBOTH("privip", privip, char *, NSC_STRING, KM_INTERNAL,
102 "Deities may connect from these IPs or networks, \"\" allows all")
103 EMPCFBOTH("WORLD_X", WORLD_X, int, NSC_INT, 0,
104 "World size X dimension (enforced to be even by subtracting 1 if necessary)")
105 EMPCFBOTH("WORLD_Y", WORLD_Y, int, NSC_INT, 0,
106 "World size Y dimension")
108 EMPCF_COMMENT("\n\n### Update policy\n\n"
109 "# Note: the update schedule is defined in the file schedule in the\n"
110 "# same directory as this file.")
111 EMPCFBOTH("etu_per_update", etu_per_update, int, NSC_INT, 0,
112 "Number of ETUs per update")
113 EMPCFBOTH("update_window", update_window, int, NSC_INT, 0,
114 "Time window the update will occur in after the update time, in seconds")
115 EMPCFBOTH("pre_update_hook", pre_update_hook, char *, NSC_STRING, KM_INTERNAL,
116 "Shell command run right before the update, in the game's data directory")
117 EMPCFBOTH("update_demand", update_demand, int, NSC_INT, 0,
118 "Demand update policy")
119 EMPCF_COMMENT("# 0 - No demand updates\n"
120 "# 1 - Scheduled updates are demand updates\n"
121 "# 2 - Demand updates run right after the deciding vote is cast,\n"
122 "# in addition to (non-demand) scheduled updates")
123 EMPCFBOTH("update_wantmin", update_wantmin, int, NSC_INT, 0,
124 "Number of votes required for a demand update")
125 EMPCFBOTH("update_demandtimes", update_demandtimes, char *, NSC_STRING, 0,
126 "Times when unscheduled demand updates can occur, separated by space")
127 EMPCF_COMMENT("# Give time ranges as HOUR:MINUTE-HOUR:MINUTE, e.g. 20:00-24:00.\n"
128 "# Ranges CANNOT cross midnight.")
130 EMPCF_COMMENT("\n\n### Game hours restrictions")
131 EMPCFBOTH("game_days", game_days, char *, NSC_STRING, 0,
132 "Days of week the game is up and running, separated by space")
133 EMPCF_COMMENT("# Give days as Su Mo Tu We Th Fr Sa.")
134 EMPCFBOTH("game_hours", game_hours, char *, NSC_STRING, 0,
135 "Time of day ranges when the game is open, separated by space")
136 EMPCF_COMMENT("# Give time ranges as HOUR:MINUTE-HOUR:MINUTE, e.g. 20:00-24:00.\n"
137 "# Ranges CANNOT cross midnight.")
139 EMPCF_COMMENT("\n\n### Options")
140 EMPCF_OPT("ALL_BLEED", opt_ALL_BLEED,
141 "Let tech bleed to everyone, not just allies")
142 EMPCF_OPT("AUTO_POWER", opt_AUTO_POWER,
143 "Power report is updated only automatically, at the update")
144 EMPCF_OPT("BLITZ", opt_BLITZ,
146 EMPCF_OPT("BRIDGETOWERS", opt_BRIDGETOWERS,
147 "Allow bridge towers")
148 EMPCF_COMMENT("# If you enable this, make sure that bridge spans can produce\n"
149 "# sufficient avail. Depending on your etu_per_update, you may have\n"
150 "# to tweak buil_tower_bh, rollover_avail_max, or bridge span's maxpop.")
151 EMPCF_OPT("EASY_BRIDGES", opt_EASY_BRIDGES,
152 "Allow bridge building without bridge heads")
153 EMPCF_OPT("FALLOUT", opt_FALLOUT,
154 "Enable secondary effects caused by radiation")
155 EMPCF_OPT("GODNEWS", opt_GODNEWS,
156 "Inform the world when deities give/take away")
157 EMPCF_OPT("GO_RENEW", opt_GO_RENEW,
158 "Make gold and oil renewable resources")
159 EMPCF_OPT("GUINEA_PIGS", opt_GUINEA_PIGS,
160 "Enable experimental stuff not ready for prime time")
161 EMPCF_OPT("HIDDEN", opt_HIDDEN,
162 "Hide information between players")
163 EMPCF_OPT("INTERDICT_ATT", opt_INTERDICT_ATT,
164 "Interdict post-attack move in")
165 EMPCF_OPT("LOANS", opt_LOANS,
166 "Allow bailing out of other countries via S&L scandals")
167 EMPCF_OPT("LOSE_CONTACT", opt_LOSE_CONTACT,
168 "Let contact be lost after a few updates")
169 EMPCF_OPT("MARKET", opt_MARKET,
170 "Enable time-based market and trading")
171 EMPCF_OPT("MOB_ACCESS", opt_MOB_ACCESS,
172 "Update mobility in real-time rather than at the update")
173 EMPCF_OPT("NOFOOD", opt_NOFOOD,
174 "Disable food consumption")
175 EMPCF_OPT("NOMOBCOST", opt_NOMOBCOST,
176 "Don't charge mobility for firing from ships")
177 EMPCF_OPT("NO_FORT_FIRE", opt_NO_FORT_FIRE,
178 "Disable fortress fire")
179 EMPCF_OPT("NO_PLAGUE", opt_NO_PLAGUE,
181 EMPCF_OPT("RAILWAYS", opt_RAILWAYS,
182 "Highways double as rail")
183 EMPCF_OPT("RES_POP", opt_RES_POP,
184 "Population is limited by research")
185 EMPCF_OPT("SAIL", opt_SAIL,
186 "Enable sail command")
187 EMPCF_OPT("SUPER_BARS", opt_SUPER_BARS,
188 "Make bars immune to damage")
189 EMPCF_OPT("TECH_POP", opt_TECH_POP,
190 "Technology costs more as population rises")
191 EMPCF_OPT("TREATIES", opt_TREATIES,
194 EMPCF_COMMENT("\n\n### Countries")
195 EMPCFBOTH("btu_build_rate", btu_build_rate, float, NSC_FLOAT, 0,
196 "Rate at which BTUs accumulate (etu * civ * eff * btu_build_rate)")
197 EMPCFBOTH("m_m_p_d", m_m_p_d, int, NSC_INT, 0,
198 "Maximum minutes per day a country is allowed to be logged in")
199 EMPCFBOTH("max_btus", max_btus, int, NSC_INT, 0,
200 "Maximum number of BTUs a country can have")
201 EMPCFBOTH("max_idle", max_idle, int, NSC_INT, 0,
202 "Maximum number of minutes a player can sit idle while logged in")
203 EMPCFBOTH("max_idle_visitor", max_idle_visitor, int, NSC_INT, 0,
204 "Maximum number of minutes a visitor can sit idle while logged in")
205 EMPCFBOTH("login_grace_time", login_grace_time, int, NSC_INT, 0,
206 "Grace time for clients to complete login and logout (seconds)")
207 EMPCFBOTH("players_at_00", players_at_00, int, NSC_INT, 0,
208 "Players have their coordinate system at deity 0,0 (0 - no, 1 - yes)")
209 EMPCFBOTH("at_least_one_100", at_least_one_100, int, NSC_INT, KM_INTERNAL,
210 "Initialize new countries with at least one sector with 100 of all resource")
211 EMPCFBOTH("start_cash", start_cash, long, NSC_LONG, KM_INTERNAL,
212 "Starting cash for new countries")
214 EMPCF_COMMENT("\n\n### Technology/Research/Education/Happiness")
215 EMPCFBOTH("easy_tech", easy_tech, float, NSC_FLOAT, 0,
216 "Amount of tech built with no penalty")
217 EMPCFBOTH("start_tech", start_technology, float, NSC_FLOAT, KM_INTERNAL,
218 "Starting technology for new countries")
219 EMPCFBOTH("start_happy", start_happiness, float, NSC_FLOAT, KM_INTERNAL,
220 "Starting happiness for new countries")
221 EMPCFBOTH("start_research", start_research, float, NSC_FLOAT, KM_INTERNAL,
222 "Starting research for new countries")
223 EMPCFBOTH("start_edu", start_education, float, NSC_FLOAT, KM_INTERNAL,
224 "Starting education for new countries")
225 EMPCFBOTH("level_age_rate", level_age_rate, float, NSC_FLOAT, 0,
226 "ETU rate at which tech decays (0 -> no decline)")
227 EMPCFBOTH("tech_log_base", tech_log_base, float, NSC_FLOAT, 0,
228 "Log base to apply to tech breakthroughs above the easy tech level")
229 EMPCFBOTH("ally_factor", ally_factor, float, NSC_FLOAT, 0,
230 "Shared tech with allies (1 / ally_factor)")
231 EMPCFBOTH("edu_avg", edu_avg, float, NSC_FLOAT, 0,
232 "Number of ETUs education is averaged over")
233 EMPCFBOTH("hap_avg", hap_avg, float, NSC_FLOAT, 0,
234 "Number of ETUs happiness is averaged over")
235 EMPCFBOTH("edu_cons", edu_cons, double, NSC_DOUBLE, 0,
236 "Education consumption (1 breakthrough per edu_cons)")
237 EMPCFBOTH("hap_cons", hap_cons, double, NSC_DOUBLE, 0,
238 "Happiness consumption (1 breakthrough per hap_cons)")
240 EMPCF_COMMENT("\n\n### Sectors")
241 EMPCFBOTH("startmob", startmob, int, NSC_INT, KM_INTERNAL,
242 "Starting mobility for sanctuaries")
243 EMPCFBOTH("sect_mob_scale", sect_mob_scale, float, NSC_FLOAT, 0,
244 "Sector mobility accumulation per ETU")
245 EMPCFBOTH("sect_mob_max", sect_mob_max, int, NSC_INT, 0,
246 "Maximum mobility for sectors")
247 EMPCFBOTH("buil_bh", buil_bh, int, NSC_INT, 0,
248 "Number of hcms required to build a bridge span")
249 EMPCFBOTH("buil_bc", buil_bc, double, NSC_DOUBLE, 0,
250 "Cash required to build a bridge span")
251 EMPCFBOTH("buil_bt", buil_bt, double, NSC_DOUBLE, 0,
252 "Technology required to build a bridge span")
253 EMPCFBOTH("buil_tower_bh", buil_tower_bh, int, NSC_INT, 0,
254 "Number of hcms required to build a bridge tower")
255 EMPCFBOTH("buil_tower_bc", buil_tower_bc, double, NSC_DOUBLE, 0,
256 "Cash required to build a bridge tower")
257 EMPCFBOTH("buil_tower_bt", buil_tower_bt, double, NSC_DOUBLE, 0,
258 "Technology required to build a bridge tower")
260 EMPCF_COMMENT("\n\n### Land Units")
261 EMPCFBOTH("land_mob_scale", land_mob_scale, float, NSC_FLOAT, 0,
262 "Land unit mobility accumulation per ETU")
263 EMPCFBOTH("land_grow_scale", land_grow_scale, float, NSC_FLOAT, 0,
264 "How fast efficiency grows for land units, per ETU")
265 EMPCFBOTH("land_mob_max", land_mob_max, int, NSC_INT, 0,
266 "Maximum mobility for land units")
267 EMPCFBOTH("money_land", money_land, double, NSC_DOUBLE, 0,
268 "Cost per ETU to maintain land units (fraction of unit price)")
269 EMPCFBOTH("morale_base", morale_base, int, NSC_INT, KM_INTERNAL,
270 "Base level for setting morale of land units")
272 EMPCF_COMMENT("\n\n### Planes")
273 EMPCFBOTH("plane_mob_scale", plane_mob_scale, float, NSC_FLOAT, 0,
274 "Plane mobility accumulation per ETU")
275 EMPCFBOTH("plane_grow_scale", plane_grow_scale, float, NSC_FLOAT, 0,
276 "How fast efficiency grows for planes each update, per ETU")
277 EMPCFBOTH("plane_mob_max", plane_mob_max, int, NSC_INT, 0,
278 "Maximum mobility for planes")
279 EMPCFBOTH("money_plane", money_plane, double, NSC_DOUBLE, 0,
280 "Cost per ETU to maintain planes (fraction of plane price)")
282 EMPCF_COMMENT("\n\n### Ships")
283 EMPCFBOTH("ship_mob_scale", ship_mob_scale, float, NSC_FLOAT, 0,
284 "Ship mobility accumulation per ETU")
285 EMPCFBOTH("ship_grow_scale", ship_grow_scale, float, NSC_FLOAT, 0,
286 "How fast efficiency grows for ships each update, per ETU")
287 EMPCFBOTH("ship_mob_max", ship_mob_max, int, NSC_INT, 0,
288 "Maximum mobility for ships")
289 EMPCFBOTH("money_ship", money_ship, double, NSC_DOUBLE, 0,
290 "Cost per ETU to maintain ships (fraction of ship price)")
291 EMPCFBOTH("torpedo_damage", torpedo_damage, int, NSC_INT, 0,
292 "Torpedo damage (damage is X + 1dX + 1dX)")
294 EMPCF_COMMENT("\n\n### Combat/Damage")
295 EMPCFBOTH("fort_max_interdiction_range", fort_max_interdiction_range, int, NSC_INT, 0,
296 "Maximum range (in sectors) a fort will try to interdict another country")
297 EMPCFBOTH("land_max_interdiction_range", land_max_interdiction_range, int, NSC_INT, 0,
298 "Maximum range (in sectors) a land unit will try to interdict another country")
299 EMPCFBOTH("ship_max_interdiction_range", ship_max_interdiction_range, int, NSC_INT, 0,
300 "Maximum range (in sectors) a ship will try to interdict another country")
301 EMPCFBOTH("flakscale", flakscale, float, NSC_FLOAT, 0,
302 "Scale factor for flak damage")
303 EMPCFBOTH("combat_mob", combat_mob, double, NSC_DOUBLE, 0,
304 "How much mobility do units spend for combat (* casualties/bodies)")
305 EMPCFBOTH("people_damage", people_damage, double, NSC_DOUBLE, 0,
306 "People take this amount of normal damage")
307 EMPCFBOTH("unit_damage", unit_damage, double, NSC_DOUBLE, 0,
308 "Land units take this amount of normal damage")
309 EMPCFBOTH("collateral_dam", collateral_dam, double, NSC_DOUBLE, 0,
310 "Side effect damage amount done to sector")
311 EMPCFBOTH("assault_penalty", assault_penalty, double, NSC_DOUBLE, 0,
312 "Attack strength multiplier for paratroopers and assaulting")
313 EMPCFBOTH("fire_range_factor", fire_range_factor, float, NSC_FLOAT, 0,
314 "Scale normal firing ranges by this amount")
315 EMPCFBOTH("sect_mob_neg_factor", sect_mob_neg_factor, int, NSC_INT, 0,
316 "Initial mobility for MOB_ACCESS (-etu_per_update / sect_mob_neg_factor)")
317 EMPCF_COMMENT("# Applies to sector takeover, ship build, plane or land unit build, and trade.")
319 EMPCF_COMMENT("\n\n### Populace")
320 EMPCFBOTH("uwbrate", uwbrate, double, NSC_DOUBLE, 0,
321 "Birth rate for uncompensated workers")
322 EMPCFBOTH("money_civ", money_civ, double, NSC_DOUBLE, 0,
323 "Money gained from taxes on a civilian in one ETU")
324 EMPCFBOTH("money_mil", money_mil, double, NSC_DOUBLE, 0,
325 "Money gained from taxes on an active soldier in one ETU")
326 EMPCFBOTH("money_res", money_res, double, NSC_DOUBLE, 0,
327 "Money gained from taxes on a soldier on active reserve in one ETU")
328 EMPCFBOTH("money_uw", money_uw, double, NSC_DOUBLE, 0,
329 "Money gained from taxes on an uncompensated worker in one ETU")
330 EMPCFBOTH("babyeat", babyeat, double, NSC_DOUBLE, 0,
331 "Amount of food to mature 1 baby into a civilian")
332 EMPCFBOTH("bankint", bankint, double, NSC_DOUBLE, 0,
333 "Bank dollar gain (per bar per etu)")
334 EMPCFBOTH("eatrate", eatrate, double, NSC_DOUBLE, 0,
335 "Food eating rate for mature people")
336 EMPCFBOTH("fcrate", fcrate, double, NSC_DOUBLE, 0,
337 "Food cultivation rate (* workforce in sector)")
338 EMPCFBOTH("fgrate", fgrate, double, NSC_DOUBLE, 0,
339 "Food growth rate (* fertility of sector)")
340 EMPCFBOTH("obrate", obrate, double, NSC_DOUBLE, 0,
341 "Civilian birth rate")
342 EMPCFBOTH("rollover_avail_max", rollover_avail_max, int, NSC_INT, 0,
343 "Maximum avail that can roll over an update")
345 EMPCF_COMMENT("\n\n### Nukes")
346 EMPCFBOTH("decay_per_etu", decay_per_etu, double, NSC_DOUBLE, 0,
347 "Decay of fallout per ETU")
348 EMPCFBOTH("fallout_spread", fallout_spread, double, NSC_DOUBLE, 0,
349 "Amount of fallout that leaks into surrounding sectors")
350 EMPCFBOTH("drnuke_const", drnuke_const, float, NSC_FLOAT, 0,
351 "Research needed to build a nuke, as fraction of the tech needed")
352 EMPCF_COMMENT("# A common value is 0.33.")
354 EMPCF_COMMENT("\n\n### Market/Trade")
355 EMPCFBOTH("MARK_DELAY", MARK_DELAY, int, NSC_INT, 0,
356 "Time commodities stay on the market for bidding (seconds)")
357 EMPCFBOTH("TRADE_DELAY", TRADE_DELAY, int, NSC_INT, 0,
358 "Time ships, planes, lands and nukes stay on the market for bidding (seconds)")
359 EMPCFBOTH("buytax", buytax, double, NSC_DOUBLE, 0,
360 "Multiple of the bid charged to the buyer on market purchases")
361 EMPCFBOTH("tradetax", tradetax, double, NSC_DOUBLE, 0,
362 "Amount of a trade transaction the seller makes (the rest is tax)")
364 EMPCF_COMMENT("\n\n### Trade ships")
365 EMPCFBOTH("trade_1_dist", trade_1_dist, int, NSC_INT, 0,
366 "Less than this distance gets no money for cashing in")
367 EMPCFBOTH("trade_2_dist", trade_2_dist, int, NSC_INT, 0,
368 "Less than this distance gets trade_1 money for cashing in")
369 EMPCFBOTH("trade_3_dist", trade_3_dist, int, NSC_INT, 0,
370 "Less than this distance gets trade_2 money for cashing in, more gets trade_3")
371 EMPCFBOTH("trade_1", trade_1, float, NSC_FLOAT, 0,
372 "Return per sector on trade_1 distance amount")
373 EMPCFBOTH("trade_2", trade_2, float, NSC_FLOAT, 0,
374 "Return per sector on trade_2 distance amount")
375 EMPCFBOTH("trade_3", trade_3, float, NSC_FLOAT, 0,
376 "Return per sector on trade_3 distance amount")
377 EMPCFBOTH("trade_ally_bonus", trade_ally_bonus, float, NSC_FLOAT, 0,
378 "Bonus you get for cashing in with an ally")
379 EMPCFBOTH("trade_ally_cut", trade_ally_cut, float, NSC_FLOAT, 0,
380 "Bonus your ally gets for you cashing in with them")
382 EMPCF_COMMENT("\n\n### Miscellaneous")
383 EMPCFBOTH("disabled_commands", disabled_commands, char *, NSC_STRING, KM_INTERNAL,
384 "Disabled commands, separated by space")
385 EMPCFBOTH("anno_keep_days", anno_keep_days, int, NSC_INT, KM_INTERNAL,
386 "How long until announcements expire (<0 means never)")
387 EMPCFBOTH("news_keep_days", news_keep_days, int, NSC_INT, KM_INTERNAL,
388 "How long until news expire")
389 EMPCFBOTH("lost_keep_hours", lost_keep_hours, int, NSC_INT, KM_INTERNAL,
390 "How long until lost items expire")
393 EMPCFONLYC(NULL, emp_config_dummy, NULL, NSC_NOTYPE, 0, NULL)