ModOptions.lua

   
-- $Id: ModOptions.lua 4642 2009-05-22 05:32:36Z carrepairer $


--  Custom Options Definition Table format
--  NOTES:
--  - using an enumerated table lets you specify the options order

--
--  These keywords must be lowercase for LuaParser to read them.
--
--  key:      the string used in the script.txt
--  name:     the displayed name
--  desc:     the description (could be used as a tooltip)
--  type:     the option type ('list','string','number','bool')
--  def:      the default value
--  min:      minimum value for number options
--  max:      maximum value for number options
--  step:     quantization step, aligned to the def value
--  maxlen:   the maximum string length for string options
--  items:    array of item strings for list options
--  section:  so lobbies can order options in categories/panels
--  scope:    'all', 'player', 'team', 'allyteam'      <<< not supported yet >>>
--

--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--
--  Example ModOptions.lua
--

local options = {
-- do deployment and tactics even work?
  {
    key    = 'zkmode',
    name   = 'Game Mode',
    desc   = 'Change the game mode.',
    type   = 'list',
    section= 'modifiers',
    def    = 'normal',
    items  = {
      {
        key  = 'normal',
        name = 'Normal',
        desc = 'Normal game mode',
      },
      {
	key  = 'kingofthehill',
	name = 'King of the Hill',
	desc = 'Control the hill for a set amount of time to win! See King of the Hill section.',
      },
      {
	key  = 'lavarise',
	name = 'Lava Rising',
	desc = 'Endlessly rising lava!  Fiery fun for the whole family!',
      },
    },
  },
  {
    key    = 'commends',
    name   = 'Team Commander Ends',
    desc   = 'Causes an allyteam to lose if they have no commanders left on their team',
    type   = 'bool',
    def    = false,
    section= 'modifiers',
  },
  {
    key = "noelo",
    name = "No Elo",
    desc = "Prevent battle from affecting Elo rankings",
    type = "bool",
    section= 'modifiers',
    def = false,
  },
  --{
  --  key = "mutespec",
  --  name = "Mute Spectators",
  --  desc = "Prevent spectators from communcating with players",
  --  type = "bool",
  --  section= 'modifiers',
  --  def = false,
  --},
  {
    key    = 'koth',
    name   = 'King of the Hill Settings',
    desc   = 'Settings for King of the Hill mode.',
    type   = 'section',
  },
    {
        key='hilltime',
        name='Hill control time',
        desc='Set how long a team has to control the hill for (in minutes).',
        type='number',
        def=10,
        min=1,
        max=30,
        step=1.0,
        section='koth',
    },

    {
        key='gracetime',
        name='No control grace period',
        desc='No player can control the hill until period is over.',
        type='number',
        def=2,
        min=0,
        max=5,
        step=0.5,
        section='koth',
    },
	
	{
    key    = 'lava',
    name   = 'Lava Rise Settings',
    desc   = 'Settings for lava rise mode.',
    type   = 'section',
    },
    {
        key='lavarisecycles',
        name='Number of cycles',
        desc='Set how many cycles before map floods completely.  The more cycles, the slower the map floods. ',
        type='number',
        def=7,
        min=1,
        max=2000,
        step=1.0,
        section='lava',
    },

    {
        key='lavariseperiod',
        name='Length of lava cycle',
        desc='How long each rise will wait for the next in seconds. ',
        type='number',
        def=120,
        min=1,
        max=6000,
        step=1,
        section='lava',
    },
  {
    key    = 'ctf',
    name   = 'Capture The Flag Settings',
    desc   = 'Settings for Capture The Flag mode.',
    type   = 'section',
  },
  {
      key='ctf_enabled',
      name='Enable CTF Mode',
      desc='Tick to enable Capture the Flag mode.',
      type='bool',
      def = false,
      section='ctf',
  },
  {
      key='ctf_flags',
      name='Number of flags per team',
      desc='Set how many flags each team should have initially, keep in mind this scales base income.',
      type='number',
      def=4,
      min=1,
      max=10,
      step=1,
      section='ctf',
  },
  {
      key='ctf_inc_mult',
      name='Scale base income by',
      desc='Set how much base income should be scaled.',
      type='number',
      def=0,
      min=0.0,
      max=100.0,
      step=0.05,
      section='ctf',
  },
  {
      key='ctf_orbit_drop',
      name='Allow com orbit drop',
      desc='Allow players to orbit drop their commander into battle again, should it die.',
      type='bool',
      def = false,
      section='ctf',
  },
  {
      key='ctf_resp_time',
      name='Commander respawn time in',
      desc='Set how much time should pass in seconds before you may call in another commander.',
      type='number',
      def=180,
      min=10,
      max=600,
      step=1,
      section='ctf',
  },
  {
      key='ctf_death_time',
      name='Sudden death timer',
      desc='Set how much time should pass in seconds before team resign should they lose all flags.',
      type='number',
      def=120,
      min=0,
      max=300,
      step=1,
      section='ctf',
  },
  {
    key    = 'zombie',
    name   = 'Zombie Settings',
    desc   = 'Settings for Zombies mutator.',
    type   = 'section',
  },
  {
    key    = 'zombies',
    name   = 'Enable zombies',
    desc   = "All features self-resurrect.",
    type   = 'bool',
    section= 'zombie',
    def    = false,
  },
  {
    key    = 'zombies_delay',
    name   = 'Zombie min spawn time',
    desc   = "In seconds, unit will resurrection no faster than this.",
    type   = 'number',
    section= 'zombie',
    def=10,
    min=1,
    max=600,
    step=1,
  },
  {
    key    = 'zombies_rezspeed',
    name   = 'Zombie resurrection speed',
    desc   = "In metal per second.",
    type   = 'number',
    section= 'zombie',
    def=12,
    min=1,
    max=10000,
    step=1,
  },
  {
    key    = 'zombies_permaslow',
    name   = 'Zombie permaslow modifier',
    desc   = "If more than 0 zombies are permaslowed to half of that amount, so 1 means 50% slow.",
    type   = 'int',
    section= 'zombie',
    def=1,
    min=0,
    max=1,
    step=0.01,
  },
  {
    key    = 'cncmex',
    name   = 'Ore Mex Settings',
    desc   = 'Settings for Ore Mex mutator.',
    type   = 'section',
  },
  {
    key    = 'oremex',
    name   = 'Enable CNC style mexes',
    desc   = "You have to reclaim ore with this option being enabled.",
    type   = 'bool',
    section= 'cncmex',
    def    = false,
  },
  {
    key    = 'oremex_prespawn',
    name   = 'Ore mex prespawn',
    desc   = "With this you get prespawned ore extractors.",
    type   = 'bool',
    section= 'cncmex',
    def    = true,
  },
  {
    key='oremex_metal',
    name='Prespawned ore amount',
    desc='Set how much metal should be prespawned.',
    type='number',
    def=35,
    min=0,
    max=10000,
    step=1,
    section='cncmex',
  },
  {
    key    = 'oremex_invul',
    name   = 'Ore mex invulnerability',
    desc   = "With this you can't damage ore extractors.",
    type   = 'bool',
    section= 'cncmex',
    def    = true,
  },
  {
    key    = 'oremex_overdrive',
    name   = 'Ore mex overdrive',
    desc   = "Overdrive ore extractors to produce more ore.",
    type   = 'bool',
    section= 'cncmex',
    def    = true,
  },
  {
    key    = 'oremex_inf',
    name   = 'Ore mex infinite growth',
    desc   = "With this you can have crystal apocalypse should it hurt units...",
    type   = 'bool',
    section= 'cncmex',
    def    = false,
  },
  {
    key    = 'oremex_uphill',
    name   = 'Ore mex slower uphill growth',
    desc   = "With this you can try to use terraform to slow growth.",
    type   = 'bool',
    section= 'cncmex',
    def    = true,
  },
  {
    key    = 'oremex_crystal',
    name   = 'Ore mex crystal models',
    desc   = "If true, ore will look like crystal, otherwise will look like metal chunks.",
    type   = 'bool',
    section= 'cncmex',
    def    = true,
  },
  {
    key    = 'oremex_communism',
    name   = 'Ore mex communism',
    desc   = "If true, ore income will be fully equally shared between active&alive players.",
    type   = 'bool',
    section= 'cncmex',
    def    = true,
  },
  {
    key='oremex_harm',
    name='Ore damage',
    desc='Set how much damage should ore inflict on contact, it stacks. Some units are ore proof.',
    type='number',
    def=0,
    min=0,
    max=10000,
    step=0.01,
    section='cncmex',
  },
  {
    key = "startingresourcetype",
    name = "Starting Resource Type",
    desc = "Choose the form in which starting resources are given.",
    type = "list",
    section= 'startconds',
    def = "facplop",
    items = {
      {
        key  = "facplop",
        name = "Factory Plop",
        desc = "First factory is free and built very fast.",
      },
      {
        key  = "classic",
        name = "Classic",
        desc = "Classic mode.",
      },
    },
  },
  {
    key = "air_ploppable",
    name = "Ploppable Air",
    desc = "Choose whether Air/Gunships are ploppable",
    type = "bool",
    section= 'startconds',
    def = true,
  },
  {
    key = "forcejunior",
    name = "Force Junior",
    desc = "Choose whether everyone gets a standard Junior Comm chassis.",
    type = "bool",
    section= 'startconds',
    def = false,
  },
  {
	key		= "disabledunits",
	name	= "Disable units",
	desc	= "Prevents specified units from being built ingame. Specify multiple units by using + ",
	section	= 'startconds',
	type	= "string",
	def		= nil,
  },
   {
	key		= "noair",
	name	= "Disable air",
	desc	= "Disables plane and gunship factories",
	section	= 'startconds',
	type	= "bool",
	def		= false,
  },
     {
	key		= "nodef",
	name	= "Disable defences",
	desc	= "Disables all defences from Defence tab",
	section	= 'startconds',
	type	= "bool",
	def		= false,
  },
  {
    key = "overdrivesharingscheme",
    name = "Overdrive Resource Distribution Scheme",
    desc = "Different scheme designed for distributing overdrive share.",
    type = "list",
    section= 'modifiers',
    def = "investmentreturn",
    items = {
      {
        key  = "investmentreturn",
        name = "Investment Return",
        desc = "Extra overdrive is given to active players who built energy structure until the cost of the structure is paid.",
      },
      {
        key  = "communism",
        name = "Equal Sharing",
        desc = "All overdrive is shared equally among active players at all time.",
      },
    },
  },  
  {
    key         = "allyreclaim",
    name        = "Reclaimable allies",
    desc        = "Allows reclaiming allied units and structures",
    type        = "bool",
    section     = "modifiers",
    def         = false,
  },
  {
    key    = "shuffle",
    name   = "Shuffle Start Points",
    desc   = "Shuffles start positions.",
    type   = "list",
    section= 'startconds',
    def    = "off",
    items  = {
      {
        key  = "off",
        name = "Off",
        desc = "Do nothing.",
      },
      {
        key  = "box",
        name = "Within Boxes",
        desc = "Shuffle start positions within each team's box.",
      },
      {
        key  = "all",
        name = "All",
        desc = "Shuffle start positions of all commanders. Use this in place of random for autohosts.",
      },
      {
        key = "allboxes",
        name = "Distribute over all boxes",
        desc = "Distribute commanders over all boxes.",
      },
    },
  },

  {
    key    = 'noceasefire',
    name   = 'Disable ceasefire panel',
    desc   = 'Disable ceasefire control panel (When "Fixed ingame alliances" is off).',
    type   = 'bool',
    section = 'diplomacy',
    def    = false,
  },
  {
    key    = 'sharemode',
    name   = 'Share Mode',
    desc   = 'Determines to which teams you may share units.',
    type   = 'list',
    section = 'diplomacy',
    def    = 'teammates',
    items = {
      { key='teammates', name="Teammates Only", desc='Share only to teammates.' },
      { key='ceasefire', name="Teammates and Ceasefired", desc='May also share to temporary ceasefired allies.' },
      { key='anyone', name="Anyone", desc='Share to anyone, including enemies.' },
    },
  },
  {
    key='typemapsetting',
    name='Terrain Speed Boost',
    desc='Choose which map Speed Boost to use',
    type='list',
    section= 'mapsettings',
    def='auto',
    items = {
      { key='auto', name="Automatic", desc='Use one of the other options based on a mod-defined list, defaulting to Keep Equal' },
      { key='mapdefault', name="Map Default", desc='Use map speed boost' },
      { key='average', name="Average", desc='Each terrain types speed boost is averaged' },
      { key='keepequal', name="Keep Equal", desc='Non-equal speedboost removed' },
      { key='onlyimpassable', name="Only Impassable", desc='Override all speedboost except impassable terrain' },
      { key='alloff', name="All Off", desc='Disable all speed boost' },
    },
  },
    {
    key    = 'waterlevel',
    name   = 'Water Level',
    desc   = 'Adjusts the water level of the map',
    type   = 'number',
    section= 'mapsettings',
    def    = 0,
    min    = -2000,
    max    = 2000,
    step   = 1,
  },
  {
    key    = 'MetalMult',
    name   = 'Metal Extraction Multiplier',
    desc   = 'Multiplies metal extraction rate. For use in large team games when there are fewer mexes per player.',
    type   = 'number',
    section= 'mapsettings',
    def    = 1,
    min    = 0,
    max    = 100,
    step   = 0.05,  -- quantization is aligned to the def value
                    -- (step <= 0) means that there is no quantization
  },
  {
    key    = 'EnergyMult',
    name   = 'Energy Production Multiplier',
    desc   = 'Useful for speed games without relying on map units.',
    type   = 'number',
    section= 'mapsettings',
    def    = 1,
    min    = 0,
    max    = 100,
    step   = 0.05,  -- quantization is aligned to the def value
                    -- (step <= 0) means that there is no quantization
  },
  {
    key    = 'minwind',
    name   = 'Minimum Wind',
    desc   = 'Minimum wind strength. Entering a negative value will use map\'s default.',
    type   = 'number',
    section= 'mapsettings',
    def    = 0,
    min    = -0.1,
    max    = 20,
    step   = 0.1,  -- quantization is aligned to the def value
                    -- (step <= 0) means that there is no quantization
  },
  {
    key    = 'maxwind',
    name   = 'Maximum Wind',
    desc   = 'Maximum wind strength. Entering a negative value will use map\'s default.',
    type   = 'number',
    section= 'mapsettings',
    def    = 2.5,
    min    = -0.1,
    max    = 20,
    step   = 0.1,  -- quantization is aligned to the def value
                    -- (step <= 0) means that there is no quantization
  },
  {
    key    = 'experimental',
    name   = 'Experimental Settings',
    desc   = 'Experimental settings.',
    type   = 'section',
  },
  {
    key    = 'marketandbounty',
    name   = 'Enable MarketPlace and Bounties (dysfunctional)',
    desc   = 'Adds option to sell your units, buy units from allies (including temporary allies). Also allows you to place a bounty on a unit.',
    type   = 'bool',
    section= 'experimental',
    def    = false,
  },
  {
    key    = 'terracostmult',
    name   = 'Terraform Cost Multiplier',
    desc   = 'Multiplies the cost of terraform.',
    type   = 'number',
    section= 'experimental',
    def    = 1,
    min    = 0.01,
    max    = 100,
    step   = 0.01,
  },
  {
    key    = 'terrarestoreonly',
    name   = 'Terraform Restore Only',
    desc   = 'Restore is the only terraform option available.',
    type   = 'bool',
    section= 'experimental',
    def    = false,
  },  
--[[  
  {
    key    = 'damagemult',
    name   = 'Damage Multiplier',
    desc   = 'Multiplies the damage dealt by all weapons, except for D-guns; autoheal; repair; and capture.',
    type   = 'number',
    section= 'experimental',
    def    = 1,
    min    = 0.01,
    max    = 10,
    step   = 0.01,
  },
  {
    key    = 'unitspeedmult',
    name   = 'Unit Speed Multiplier',
    desc   = 'Multiplies the speed, acceleration, and turn rate of all units.',
    type   = 'number',
    section= 'experimental',
    def    = 1,
    min    = 0.01,
    max    = 10,
    step   = 0.01,
  },
]]--
  {
    key    = 'cratermult',
    name   = 'Cratering Multiplier',
    desc   = 'Multiplies the depth of craters.',
    type   = 'number',
    section= 'experimental',
    def    = 1,
    min    = 0,
    max    = 1000,
    step   = 0.01,
  },
  {
    key    = 'defeatmode',
    name   = 'Defeat Mode',
    desc   = "Method of handling defeated alliances",
    type   = 'list',
    section= 'experimental',
    def    = 'destroy',
    items = {
      { key='debug', name="Debug", desc='Does nothing; game is endless.' },
      { key='destroy', name="Destroy Alliance", desc='Destroys the alliance if they are defeated"' },
      { key='losecontrol', name="Lose Control", desc='Alliance loses control of their units if they are defeated.' },

    },
  },
  --[[
  {
    key    = 'easymetal',
    name   = 'Easy Metal',
    desc   = 'Metal extractors are restricted to metal spots in the same way geo plants are. Spots are pre-analyzed but certain maps will provide strange results, such as Azure or Speedmetal.',
    type   = 'bool',
    section= 'experimental',
    def    = false,
  },
  --]]
  --[[
  {
    key    = 'terratex',
    name   = 'Terraform Texture',
    desc   = 'Adds a texture to terraformed ground.',
    type   = 'bool',
    section= 'experimental',
    def    = true,
  },
  --]]
--[[
  {
    key    = 'specialpower',
    name   = 'Special Advanced Powerplants',
    desc   = 'Rather than explode like a nuke, Adv Fusions create a massive implosion.',
    type   = 'bool',
    section= 'experimental',
    def    = false,
  },
  --]]
 
  {
    key    = 'specialdecloak',
    name   = 'Special Decloak Behavior (buggy)',
    desc   = 'Overrides engine\'s decloak. Shows cloaked units only to team that reveals them, also fixes cloak behavior in FFA games with ceasefires.',
    type   = 'bool',
    section= 'experimental',
    def    = false,
  },
  {
    key    = 'fun',
    name   = 'Fun Stuff',
    desc   = 'Fun stuff.',
    type   = 'section',
  },
  {
    key    = 'xmas',
    name   = 'Enable festive units',
    desc   = "Zero K units get into the spirit of the season with a festive new look.",
    type   = 'bool',
    section= 'fun',
    def    = false,
  },
  {
    key    = 'iwinbutton',
    name   = 'Enable giant expensive "I Win" button',
    desc   = "For speed games. Race to build it!",
    type   = 'bool',
    section= 'fun',
    def    = false,
  },
  {
    key    = "disablefeatures",
    name   = "Disable Features",
    desc   = "Disable features (no wreackages).",
    type   = "bool",
    section= "mapsettings",
    def    = false,
  },
  {
    key    = 'factorycostmult',
    name   = 'Factory Cost Multiplier',
    desc   = 'Multiplies the cost of factories.',
    type   = 'number',
    section= 'experimental',
    def    = 1,
    min    = 0.01,
    max    = 100,
    step   = 0.01,
  },
  {
    key    = 'wreckagemult',
    name   = 'Wreckage Metal Multiplier',
    desc   = 'Multiplies the metal of wreckages and debris.',
    type   = 'number',
    section= 'experimental',
    def    = 1,
    min    = 0.01,
    max    = 100,
    step   = 0.01,
  },
  {
    key    = "coop",
    name   = "Cooperation Mode",
    desc   = "Cooperation Mode",
    type   = "bool",
    section= "startconds",
    def    = false,
  },
  {
    key		= "enableunlocks",
    name	= "Enable unlock system",
    desc	= "Enables the unlock system (disabling will enable all units by default)",
    type	= "bool",
    def		= true,
    section	= "experimental",
  },  
  {
    key		= "impulsejump",
    name	= "Impulses Jump",
    desc	= "Allow jumps that is effected by Newton and can jump anywhere (no restriction). Compatible for Spring 93.2 and above",
    type	= "bool",
    def		= false,
    section	= "experimental",
  },  
  {
    key		= "pathfinder",
    name	= "Pathfinder type",
    desc	= "Sets the pathfinding system used by units.",
    type	= "list",
    def		= "standard",
    section	= "experimental",
    items  = {
      {
	key  = 'standard',
	name = 'Standard',
	desc = 'Standard pathfinder',
      },
      {
	key  = 'qtpfs',
	name = 'QTPFS',
	desc = 'New Quadtree Pathfinding System (experimental)',
      },
    --  {
	--	key  = 'classic',
	--	name = 'Classic',
	--	desc = 'An older pathfinding system without turninplace or reverse',
    --  }
    },	
  },  
  
  {
    key    = 'chicken',
    name   = 'Chicken',
    desc   = 'Settings for Chicken: Custom',
    type   = 'section',
  },
  {
    key = "playerchickens",
    name = "Players as chickens",
    desc = "Shared chickens with players, take commanders away",
    type = "bool",
    def = false,
    section = 'chicken',
  },
  {
    key	= "eggs",
    name = "Chicken Eggs",
    desc = "Enables eggs mode (applies to all chicken difficulties); metal extractors are disabled but chickens drop twice as many eggs",
    type = "bool",
    def	= false,
    section = 'chicken',
  },
  {
    key	= "speedchicken",
    name = "Speed Chicken",
    desc = "Game lasts half as long; no miniqueens (applies to all chicken difficulties)",
    type = "bool",
    def	= false,
    section = 'chicken',
  },
  {
    key    = 'chickenspawnrate',
    name   = 'Chicken Spawn Rate',
    desc   = 'Sets the frequency of chicken waves in seconds.',
    type   = 'number',
    section= 'chicken',
    def    = 50,
    min    = 20,
    max    = 200,
    step   = 1,
  },
  {
    key    = 'burrowspawnrate',
    name   = 'Burrow Spawn Rate',
    desc   = 'Sets the frequency of burrow spawns in seconds (modified by playercount and number of existing burrows).',
    type   = 'number',
    section= 'chicken',
    def    = 45,
    min    = 20,
    max    = 200,
    step   = 1,
  },
  {
    key    = 'queentime',
    name   = 'Queen Time',
    desc   = 'How soon the queen appears on her own, minutes.',
    type   = 'number',
    section= 'chicken',
    def    = 60,
    min    = 1,
    max    = 200,
    step   = 1,
  },
  {
    key    = 'graceperiod',
    name   = 'Grace Period',
    desc   = 'Delay before the first wave appears, minutes.',
    type   = 'number',
    section= 'chicken',
    def    = 2.5,
    min    = 0,
    max    = 120,
    step   = 0.5,
  },
  {
    key    = 'miniqueentime',
    name   = 'Dragon Time',
    desc   = 'Time when the White Dragons appear, as a proportion of queen time. 0 disables.',
    type   = 'number',
    section= 'chicken',
    def    = 0.6,
    min    = 0,
    max    = 1,
    step   = 0.05,
  },
  {
    key    = 'techtimemult',
    name   = 'Tech Time Mult',
    desc   = 'Multiplier for the appearance times of advanced chickens.',
    type   = 'number',
    section= 'chicken',
    def    = 1,
    min    = 0,
    max    = 5,
    step   = 0.05,
  },
--[[  
  {
	key    = 'burrowtechtime',
	name   = 'Burrow Tech Time',
	desc   = 'How much time each burrow shaves off chicken appearance times per wave (divided by playercount), seconds',
	type   = 'number',
	section= 'chicken',
	def    = 12,
	min    = 0,
	max    = 60,
	step   = 1,  
  },
]]--  
  {
	key    = 'burrowqueentime',
	name   = 'Burrow Queen Time',
	desc   = 'How much time each burrow death subtracts from queen appearance time, seconds',
	type   = 'number',
	section= 'chicken',
	def    = 15,
	min    = 0,
	max    = 120,
	step   = 1,  
  },
}

--// add key-name to the description (so you can easier manage modoptions in springie)
for i=1,#options do
  local opt = options[i]
  opt.desc = opt.desc .. '\nkey: ' .. opt.key
end

return options