2 * Empire - A multi-player, client/server Internet based war game.
3 * Copyright (C) 1986-2007, Dave Pare, Jeff Bailey, Thomas Ruschak,
4 * Ken Stevens, Steve McClure
6 * This program 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 2 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, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * See files README, COPYING and CREDITS in the root of the source
23 * tree for related information and legal notices. It is expected
24 * that future projects/authors will amend these files as needed.
28 * econfig-spec.h: Combined include for optlist.h and emp_config.c
30 * Known contributors to this file:
32 * Markus Armbruster, 2004-2006
36 * This file declares econfig keys. It expand into the corresponding
37 * variable declarations if defined(EMP_CONFIG_H_OUTPUT), and into
38 * struct keymatch[] initializers if defined(EMP_CONFIG_C_OUTPUT).
40 * EMPCFBOTH() defines econfig keys. EMPCF_OPT() is a convenience
41 * wrapper for options. EMPCF_COMMENT() defines comments.
45 * Preprocessor of MSC C++ 6.0 (VC98) is broken and chokes on empty
46 * macro arguments. Fixed in MSC C++ 7.0. Work around: pass
47 * useless token `unused'.
50 #if defined(EMP_CONFIG_C_OUTPUT)
52 #define EMPCFONLYC(fvname, vname, vtype, ctype, flags, descr) \
53 { (fvname), (ctype), &(vname), (flags), (descr) },
54 #define EMPCFBOTH(fvname, vname, vtype, ctype, flags, descr) \
55 { (fvname), (ctype), &(vname), (flags), (descr) },
57 #elif defined(EMP_CONFIG_H_OUTPUT)
59 #define EMPCFONLYC(fvname, vname, vtype, ctype, flags, descr)
60 #define EMPCFBOTH(fvname, vname, vtype, ctype, flags, descr) \
63 #endif /* EMP_CONFIG_C_OUTPUT || EMP_CONFIG_H_OUTPUT */
65 #define EMPCF_COMMENT(comment) \
66 EMPCFONLYC("", emp_config_dummy, unused , NSC_NOTYPE, 0, (comment))
68 #define EMPCF_OPT(fvname, vname, descr) \
69 EMPCFBOTH((fvname), (vname), int, NSC_INT, KM_OPTION, (descr))
71 /* econfig key definitions: */
73 EMPCF_COMMENT("\n### Server configuration and information")
74 EMPCFBOTH("custom_tables", custom_tables, char *, NSC_STRING, KM_INTERNAL,
75 "Custom configuration table files, separated by space")
76 EMPCFBOTH("data", gamedir, char *, NSC_STRING, KM_INTERNAL,
77 "Directory where this game's data is stored")
78 EMPCFBOTH("info", infodir, char *, NSC_STRING, KM_INTERNAL,
79 "Directory where info pages are stored, can be shared among games")
80 EMPCF_COMMENT("# Note: Use an absolute name here, the interpretation of a relative\n"
82 EMPCFBOTH("builtin", builtindir, char *, NSC_STRING, KM_INTERNAL,
83 "Directory where builtin files are stored")
84 EMPCF_COMMENT("# Set this to your source tree's src/lib/global to run the server\n"
85 "# without installing it, else leave it alone.")
86 EMPCFBOTH("listen_addr", listen_addr, char *, NSC_STRING, KM_INTERNAL,
87 "Local IP address the server should listen on.")
88 EMPCF_COMMENT("# \"\" listens on all, localhost just on the loopback interface")
89 EMPCFBOTH("port", loginport, char *, NSC_STRING, KM_INTERNAL,
90 "TCP port the server will bind")
91 EMPCFBOTH("keep_journal", keep_journal, int, NSC_INT, KM_INTERNAL,
92 "Enable journal log file")
93 EMPCFBOTH("privname", privname, char *, NSC_STRING, 0,
95 EMPCFBOTH("privlog", privlog, char *, NSC_STRING, 0,
96 "E-mail of the deity")
97 EMPCFBOTH("privip", privip, char *, NSC_STRING, KM_INTERNAL,
98 "Deities may connect from these IPs or networks, \"\" allows all")
99 EMPCFBOTH("WORLD_X", WORLD_X, int, NSC_INT, 0,
100 "World size X dimension (enforced to be even by subtracting 1 if necessary)")
101 EMPCFBOTH("WORLD_Y", WORLD_Y, int, NSC_INT, 0,
102 "World size Y dimension")
104 EMPCF_COMMENT("\n\n### Update policy\n\n"
105 "# Note: the update schedule is defined in the file schedule in the\n"
106 "# same directory as this file.")
107 EMPCFBOTH("etu_per_update", etu_per_update, int, NSC_INT, 0,
108 "Number of ETUs per update")
109 EMPCFBOTH("update_window", update_window, int, NSC_INT, 0,
110 "Time window the update will occur in after the update time, in seconds")
111 EMPCFBOTH("pre_update_hook", pre_update_hook, char *, NSC_STRING, KM_INTERNAL,
112 "Shell command run right before the update.")
114 EMPCFBOTH("update_demand", update_demand, int, NSC_INT, 0,
115 "Demand update policy")
116 EMPCF_COMMENT("# 0 - No demand updates\n"
117 "# 1 - Scheduled updates are demand updates\n"
118 "# 2 - Demand updates run right after the deciding vote is cast,\n"
119 "# in addition to (non-demand) scheduled updates\n")
120 EMPCFBOTH("update_wantmin", update_wantmin, int, NSC_INT, 0,
121 "Number of votes required for a demand update")
122 EMPCFBOTH("update_demandtimes", update_demandtimes, char *, NSC_STRING, 0,
123 "Times when unscheduled demand updates can occur, separated by space.")
124 EMPCF_COMMENT("# Give time ranges as HOUR:MINUTE-HOUR:MINUTE, e.g. 20:00-24:00\n"
125 "# Ranges CANNOT cross midnight.")
127 EMPCF_COMMENT("\n\n### Game hours restrictions")
128 EMPCFBOTH("game_days", game_days, char *, NSC_STRING, 0,
129 "Days of week the game is up and running, separated by space")
130 EMPCF_COMMENT("# Give days as Su Mo Tu We Th Fr Sa.")
131 EMPCFBOTH("game_hours", game_hours, char *, NSC_STRING, 0,
132 "Time of day ranges when the game is open, separated by space.")
133 EMPCF_COMMENT("# Give time ranges as HOUR:MINUTE-HOUR:MINUTE, e.g. 20:00-24:00\n"
134 "# Ranges CANNOT cross midnight.")
136 EMPCF_COMMENT("\n\n### Options")
137 EMPCF_OPT("ALL_BLEED", opt_ALL_BLEED,
138 "Let tech bleed to everyone, not just allies")
139 EMPCF_OPT("AUTO_POWER", opt_AUTO_POWER,
140 "Power report is updated only automatically, at the update")
141 EMPCF_OPT("BLITZ", opt_BLITZ,
143 EMPCF_OPT("BRIDGETOWERS", opt_BRIDGETOWERS,
144 "Allow bridge towers")
145 EMPCF_OPT("EASY_BRIDGES", opt_EASY_BRIDGES,
146 "Allow bridge building without bridge heads")
147 EMPCF_OPT("FALLOUT", opt_FALLOUT,
148 "Enable secondary effects caused by radiation")
149 EMPCF_OPT("FUEL", opt_FUEL,
150 "Make ships use fuel to move")
151 EMPCF_OPT("GODNEWS", opt_GODNEWS,
152 "Inform the world when deities give/take away")
153 EMPCF_OPT("GO_RENEW", opt_GO_RENEW,
154 "Make gold and oil renewable resources")
155 EMPCF_OPT("GUINEA_PIGS", opt_GUINEA_PIGS,
156 "Enable experimental stuff not ready for prime time")
157 EMPCF_OPT("HIDDEN", opt_HIDDEN,
158 "Hide information between players")
159 EMPCF_OPT("INTERDICT_ATT", opt_INTERDICT_ATT,
160 "Interdict post-attack move in")
161 EMPCF_OPT("LANDSPIES", opt_LANDSPIES,
162 "Enable the land unit type spies")
163 EMPCF_OPT("LOANS", opt_LOANS,
164 "Allow bailing out of other countries via S&L scandals")
165 EMPCF_OPT("LOSE_CONTACT", opt_LOSE_CONTACT,
166 "Let contact be lost after a few updates")
167 EMPCF_OPT("MARKET", opt_MARKET,
168 "Enable time-based market and trading")
169 EMPCF_OPT("MOB_ACCESS", opt_MOB_ACCESS,
170 "Update mobility in real-time rather than at the update")
171 EMPCF_OPT("NOFOOD", opt_NOFOOD,
172 "Disable food consumption")
173 EMPCF_OPT("NOMOBCOST", opt_NOMOBCOST,
174 "Don't charge mobility for firing from ships")
175 EMPCF_OPT("NO_FORT_FIRE", opt_NO_FORT_FIRE,
176 "Disable fortress fire")
177 EMPCF_OPT("NO_PLAGUE", opt_NO_PLAGUE,
179 EMPCF_OPT("PINPOINTMISSILE", opt_PINPOINTMISSILE,
180 "Enable marine missiles")
181 EMPCF_OPT("RES_POP", opt_RES_POP,
182 "Population is limited by research")
183 EMPCF_OPT("SAIL", opt_SAIL,
184 "Enable sail command")
185 EMPCF_OPT("SHOWPLANE", opt_SHOWPLANE,
186 "Show planes and land units embarked on ships or land units up for trade")
187 EMPCF_OPT("SLOW_WAR", opt_SLOW_WAR,
188 "Declaring war takes time")
189 EMPCF_OPT("SUPER_BARS", opt_SUPER_BARS,
190 "Make bars immune to damage")
191 EMPCF_OPT("TECH_POP", opt_TECH_POP,
192 "Technology costs more as population rises")
193 EMPCF_OPT("TRADESHIPS", opt_TRADESHIPS,
195 EMPCF_OPT("TREATIES", opt_TREATIES,
198 EMPCF_COMMENT("\n\n### Countries")
199 EMPCFBOTH("btu_build_rate", btu_build_rate, float, NSC_FLOAT, 0,
200 "Rate at which BTUs accumulate (etu * civ * eff * btu_build_rate)")
201 EMPCFBOTH("m_m_p_d", m_m_p_d, int, NSC_INT, 0,
202 "Maximum minutes per day a country is allowed to be logged in")
203 EMPCFBOTH("max_btus", max_btus, int, NSC_INT, 0,
204 "Maximum number of BTUs a country can have")
205 EMPCFBOTH("max_idle", max_idle, int, NSC_INT, 0,
206 "Maximum number of minutes a player can sit idle while logged in")
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")
213 EMPCFBOTH("war_cost", War_Cost, int, NSC_INT, 0,
214 "Cost to declare war (if SLOW_WAR is on)")
216 EMPCF_COMMENT("\n\n### Technology/Research/Education/Happiness")
217 EMPCFBOTH("easy_tech", easy_tech, float, NSC_FLOAT, 0,
218 "Amount of tech built with no penalty")
219 EMPCFBOTH("start_tech", start_technology, float, NSC_FLOAT, KM_INTERNAL,
220 "Starting technology for new countries")
221 EMPCFBOTH("start_happy", start_happiness, float, NSC_FLOAT, KM_INTERNAL,
222 "Starting happiness for new countries")
223 EMPCFBOTH("start_research", start_research, float, NSC_FLOAT, KM_INTERNAL,
224 "Starting research for new countries")
225 EMPCFBOTH("start_edu", start_education, float, NSC_FLOAT, KM_INTERNAL,
226 "Starting education for new countries")
227 EMPCFBOTH("level_age_rate", level_age_rate, float, NSC_FLOAT, 0,
228 "ETU rate at which tech decays (0 -> no decline)")
229 EMPCFBOTH("tech_log_base", tech_log_base, float, NSC_FLOAT, 0,
230 "Log base to apply to tech breakthroughs above the easy tech level")
231 EMPCFBOTH("ally_factor", ally_factor, float, NSC_FLOAT, 0,
232 "Shared tech with allies (1 / ally_factor)")
233 EMPCFBOTH("edu_avg", edu_avg, float, NSC_FLOAT, 0,
234 "Number of ETUs education is averaged over")
235 EMPCFBOTH("hap_avg", hap_avg, float, NSC_FLOAT, 0,
236 "Number of ETUs happiness is averaged over")
237 EMPCFBOTH("edu_cons", edu_cons, double, NSC_DOUBLE, 0,
238 "Education consumption (1 breakthrough per edu_cons)")
239 EMPCFBOTH("hap_cons", hap_cons, double, NSC_DOUBLE, 0,
240 "Happiness consumption (1 breakthrough per hap_cons)")
242 EMPCF_COMMENT("\n\n### Sectors")
243 EMPCFBOTH("startmob", startmob, int, NSC_INT, KM_INTERNAL,
244 "Starting mobility for sanctuaries")
245 EMPCFBOTH("sect_mob_scale", sect_mob_scale, float, NSC_FLOAT, 0,
246 "Sector mobility accumulation per ETU")
247 EMPCFBOTH("sect_mob_max", sect_mob_max, int, NSC_INT, 0,
248 "Maximum mobility for sectors")
249 EMPCFBOTH("buil_bh", buil_bh, int, NSC_INT, 0,
250 "Number of hcms required to build a bridge span")
251 EMPCFBOTH("buil_bc", buil_bc, double, NSC_DOUBLE, 0,
252 "Cash required to build a bridge span")
253 EMPCFBOTH("buil_bt", buil_bt, double, NSC_DOUBLE, 0,
254 "Technology required to build a bridge span")
255 EMPCFBOTH("buil_tower_bh", buil_tower_bh, int, NSC_INT, 0,
256 "Number of hcms required to build a bridge tower")
257 EMPCFBOTH("buil_tower_bc", buil_tower_bc, double, NSC_DOUBLE, 0,
258 "Cash required to build a bridge tower")
259 EMPCFBOTH("buil_tower_bt", buil_tower_bt, double, NSC_DOUBLE, 0,
260 "Technology required to build a bridge tower")
262 EMPCF_COMMENT("\n\n### Land Units")
263 EMPCFBOTH("land_mob_scale", land_mob_scale, float, NSC_FLOAT, 0,
264 "Land unit mobility accumulation per ETU")
265 EMPCFBOTH("land_grow_scale", land_grow_scale, float, NSC_FLOAT, 0,
266 "How fast efficiency grows for land units, per ETU")
267 EMPCFBOTH("land_mob_max", land_mob_max, int, NSC_INT, 0,
268 "Maximum mobility for land units")
269 EMPCFBOTH("money_land", money_land, double, NSC_DOUBLE, 0,
270 "Cost per ETU to maintain land units (percentage of unit price)")
271 EMPCFBOTH("morale_base", morale_base, int, NSC_INT, KM_INTERNAL,
272 "Base level for setting morale of land units")
274 EMPCF_COMMENT("\n\n### Planes")
275 EMPCFBOTH("plane_mob_scale", plane_mob_scale, float, NSC_FLOAT, 0,
276 "Plane mobility accumulation per ETU")
277 EMPCFBOTH("plane_grow_scale", plane_grow_scale, float, NSC_FLOAT, 0,
278 "How fast efficiency grows for planes each update, per ETU")
279 EMPCFBOTH("plane_mob_max", plane_mob_max, int, NSC_INT, 0,
280 "Maximum mobility for planes")
281 EMPCFBOTH("money_plane", money_plane, double, NSC_DOUBLE, 0,
282 "Cost per ETU to maintain planes (percentage of plane price)")
284 EMPCF_COMMENT("\n\n### Ships")
285 EMPCFBOTH("ship_mob_scale", ship_mob_scale, float, NSC_FLOAT, 0,
286 "Ship mobility accumulation per ETU")
287 EMPCFBOTH("ship_grow_scale", ship_grow_scale, float, NSC_FLOAT, 0,
288 "How fast efficiency grows for ships each update, per ETU")
289 EMPCFBOTH("ship_mob_max", ship_mob_max, int, NSC_INT, 0,
290 "Maximum mobility for ships")
291 EMPCFBOTH("money_ship", money_ship, double, NSC_DOUBLE, 0,
292 "Cost per ETU to maintain ships (percentage of ship price)")
293 EMPCFBOTH("torpedo_damage", torpedo_damage, int, NSC_INT, 0,
294 "Torpedo damage (damage is X + 1dX + 1dX)")
296 EMPCF_COMMENT("\n\n### Combat/Damage")
297 EMPCFBOTH("fort_max_interdiction_range", fort_max_interdiction_range, int, NSC_INT, 0,
298 "Maximum range (in sectors) a fort will try to interdict another country")
299 EMPCFBOTH("land_max_interdiction_range", land_max_interdiction_range, int, NSC_INT, 0,
300 "Maximum range (in sectors) a land unit will try to interdict another country")
301 EMPCFBOTH("ship_max_interdiction_range", ship_max_interdiction_range, int, NSC_INT, 0,
302 "Maximum range (in sectors) a ship will try to interdict another country")
303 EMPCFBOTH("flakscale", flakscale, float, NSC_FLOAT, 0,
304 "Scale factor for flak damage")
305 EMPCFBOTH("combat_mob", combat_mob, double, NSC_DOUBLE, 0,
306 "How much mobility do units spend for combat (* casualties/bodies)")
307 EMPCFBOTH("people_damage", people_damage, double, NSC_DOUBLE, 0,
308 "People take this amount of normal damage")
309 EMPCFBOTH("unit_damage", unit_damage, double, NSC_DOUBLE, 0,
310 "Land units take this amount of normal damage")
311 EMPCFBOTH("collateral_dam", collateral_dam, double, NSC_DOUBLE, 0,
312 "Side effect damage amount done to sector")
313 EMPCFBOTH("assault_penalty", assault_penalty, double, NSC_DOUBLE, 0,
314 "Amount of normal attacking efficiency for paratroopers and assaulting")
315 EMPCFBOTH("fire_range_factor", fire_range_factor, float, NSC_FLOAT, 0,
316 "Scale normal firing ranges by this amount")
317 EMPCFBOTH("sect_mob_neg_factor", sect_mob_neg_factor, int, NSC_INT, 0,
318 "Initial mobility for MOB_ACCESS (etu_per_update / sect_mob_neg_factor)")
319 EMPCF_COMMENT("# Applies to sector takeover, ship build, plane or land unit build or trade")
320 EMPCFBOTH("mission_mob_cost", mission_mob_cost, double, NSC_DOUBLE, 0,
321 "Cost to put something on a mission (percentage of max mob)")
323 EMPCF_COMMENT("\n\n### Populace")
324 EMPCFBOTH("uwbrate", uwbrate, double, NSC_DOUBLE, 0,
325 "Birth rate for uw's")
326 EMPCFBOTH("money_civ", money_civ, double, NSC_DOUBLE, 0,
327 "Money gained from taxes on a civilian in one ETU")
328 EMPCFBOTH("money_mil", money_mil, double, NSC_DOUBLE, 0,
329 "Money gained from taxes on an active soldier in one ETU")
330 EMPCFBOTH("money_res", money_res, double, NSC_DOUBLE, 0,
331 "Money gained from taxes on a soldier on active reserve in one ETU")
332 EMPCFBOTH("money_uw", money_uw, double, NSC_DOUBLE, 0,
333 "Money gained from taxes on an uncompensated worker in one ETU")
334 EMPCFBOTH("babyeat", babyeat, double, NSC_DOUBLE, 0,
335 "Amount of food to mature 1 baby into a civilian")
336 EMPCFBOTH("bankint", bankint, double, NSC_DOUBLE, 0,
337 "Bank dollar gain (per bar per etu)")
338 EMPCFBOTH("eatrate", eatrate, double, NSC_DOUBLE, 0,
339 "Food eating rate for mature people")
340 EMPCFBOTH("fcrate", fcrate, double, NSC_DOUBLE, 0,
341 "Food cultivation rate (* workforce in sector)")
342 EMPCFBOTH("fgrate", fgrate, double, NSC_DOUBLE, 0,
343 "Food growth rate (* fertility of sector)")
344 EMPCFBOTH("obrate", obrate, double, NSC_DOUBLE, 0,
345 "Civilian birth rate")
346 EMPCFBOTH("rollover_avail_max", rollover_avail_max, int, NSC_INT, 0,
347 "Maximum avail that can roll over an update")
349 EMPCF_COMMENT("\n\n### Nukes")
350 EMPCFBOTH("decay_per_etu", decay_per_etu, double, NSC_DOUBLE, 0,
351 "Decay of fallout per ETU")
352 EMPCFBOTH("fallout_spread", fallout_spread, double, NSC_DOUBLE, 0,
353 "Amount of fallout that leaks into surrounding sectors")
354 EMPCFBOTH("drnuke_const", drnuke_const, float, NSC_FLOAT, 0,
355 "Amount of research to tech needed to build a nuke, a common value is 0.33")
357 EMPCF_COMMENT("\n\n### Market/Trade")
358 EMPCFBOTH("MARK_DELAY", MARK_DELAY, int, NSC_INT, 0,
359 "Number of seconds commodities stay on the market for bidding")
360 EMPCFBOTH("TRADE_DELAY", TRADE_DELAY, int, NSC_INT, 0,
361 "Number of seconds ships, planes, and units stay on the market for bidding")
362 EMPCFBOTH("buytax", buytax, double, NSC_DOUBLE, 0,
363 "Tax (in percentage points) charged to the buyer on market purchases")
364 EMPCFBOTH("tradetax", tradetax, double, NSC_DOUBLE, 0,
365 "Amount of a trade transaction the seller makes (the rest is tax)")
367 EMPCF_COMMENT("\n\n### Trade ships")
368 EMPCFBOTH("trade_1_dist", trade_1_dist, int, NSC_INT, 0,
369 "Less than this distance no money for cashing in")
370 EMPCFBOTH("trade_2_dist", trade_2_dist, int, NSC_INT, 0,
371 "Less than this distance gets trade_1 money for cashing in")
372 EMPCFBOTH("trade_3_dist", trade_3_dist, int, NSC_INT, 0,
373 "Less than this distance gets trade_2 money for cashing in (>= gets trade_3")
374 EMPCFBOTH("trade_1", trade_1, float, NSC_FLOAT, 0,
375 "Return per sector on trade_1 distance amount")
376 EMPCFBOTH("trade_2", trade_2, float, NSC_FLOAT, 0,
377 "Return per sector on trade_2 distance amount")
378 EMPCFBOTH("trade_3", trade_3, float, NSC_FLOAT, 0,
379 "Return per sector on trade_3 distance amount")
380 EMPCFBOTH("trade_ally_bonus", trade_ally_bonus, float, NSC_FLOAT, 0,
381 "Bonus you get for cashing in with an ally")
382 EMPCFBOTH("trade_ally_cut", trade_ally_cut, float, NSC_FLOAT, 0,
383 "Bonus your ally gets for you cashing in with them")
385 EMPCF_COMMENT("\n\n### Misc.")
386 EMPCFBOTH("disabled_commands", disabled_commands, char *, NSC_STRING, KM_INTERNAL,
387 "Disabled commands, separated by space")
388 EMPCFBOTH("anno_keep_days", anno_keep_days, int, NSC_INT, KM_INTERNAL,
389 "How long until announcements expire (<0 means never)")
390 EMPCFBOTH("news_keep_days", news_keep_days, int, NSC_INT, KM_INTERNAL,
391 "How long until news expire")
392 EMPCFBOTH("fuel_mult", fuel_mult, int, NSC_INT, 0,
393 "Multiplier for fuel to mobility calculation")
394 EMPCFBOTH("lost_items_timeout", lost_items_timeout, int, NSC_INT, KM_INTERNAL,
395 "Seconds before a lost item is timed out of the database")
398 EMPCFONLYC(NULL, emp_config_dummy, NULL, NSC_NOTYPE, 0, NULL)