How do mod options work?

KDR_11k · Post by **KDR_11k** » 04 Dec 2007, 23:00

The SVN TASClient has a mod options tab in the battle screen, how can a mod use those?

KDR_11k · Post by **KDR_11k** » 05 Dec 2007, 18:23

Okay, figured it out with a LOT of help. To spare others the experience:

1. The Lobby-side definition is done with a file called ModOptions.lua in the mod's root dir. Specs for the content are here
2. The mod-side handling is done with Spring.GetModOptions(), it returns a table with string keys and values. Note that bools are expressed as "0" and "1".

Pxtl · Post by **Pxtl** » 05 Dec 2007, 19:03

Wow, that's really cool. If only the Spring website had some sort of user-editable pages that we could use to keep track of this information, that modders, developers, and players could keep up-to-date with recent developments in the Spring engine.

/sarcasm.

KDR_11k · Post by **KDR_11k** » 05 Dec 2007, 19:22

Pxtl wrote:Wow, that's really cool. If only the Spring website had some sort of user-editable pages that we could use to keep track of this information, that modders, developers, and players could keep up-to-date with recent developments in the Spring engine.

/sarcasm.

I'd need an account for that...

Argh · Post by **Argh** » 05 Dec 2007, 22:00

I have a working account, just send whatever you've got to me... I don't mess with the Wiki much, but I can do so.

KDR_11k · Post by **KDR_11k** » 05 Dec 2007, 22:16

Meh, if I felt like writing a proper Wiki article I'd get an account myself. In the forums I was able to post this in two sentences

rattle · Post by **rattle** » 06 Dec 2007, 01:04

GTFO 10q

Wouldn't it be a good idea to put the Lua in the SVN? Actually, it would be a good idea to centralize all of the GPL'ed Luas somewhere so people don't have to look in 128937 different places.

Pxtl · Post by **Pxtl** » 08 Dec 2007, 05:12

Hey, does this mean that the "ONS" mode in KP could be made into a checkbox instead of a new gametype?

KDR_11k · Post by **KDR_11k** » 08 Dec 2007, 08:17

Most likely.

Forboding Angel · Post by **Forboding Angel** » 09 Dec 2007, 16:56

Could someone take the tiem to explain how to use this?

KDR_11k · Post by **KDR_11k** » 09 Dec 2007, 17:40

Make a ModOptions.lua file as outlined above, the settings can be retrieved using Spring.GetModOptions(). You just have to make your lua react to the settings.

Forboding Angel · Post by **Forboding Angel** » 09 Dec 2007, 17:48

Pardon me for saying... That's as clear as mud.

If something is going to be (for the most part) required, you have to kinda spell it out for people who don't understand lua.

KDR_11k · Post by **KDR_11k** » 09 Dec 2007, 17:53

You can't do this without Lua so if you don't know Lua that's not gonna help you anyway. It's not required, just pretty damn useful.

Forboding Angel · Post by **Forboding Angel** » 09 Dec 2007, 18:03

Is it so detailed that It could not be explained?

KDR_11k · Post by **KDR_11k** » 09 Dec 2007, 18:07

What else should I explain? I told you how to make the file and I told you how to read what the user inputted, the only step further I can imagine is telling you exactly how to implement your mod options.

Forboding Angel · Post by **Forboding Angel** » 09 Dec 2007, 18:10

KDR_11k wrote:...the only step further I can imagine is telling you exactly how to implement your mod options.

That would be wonderful, if you could explain generically so that people other than myself could benefit as well.

I have messed around with it some, but from what I've seen I haven't really affected anything.

KDR_11k · Post by **KDR_11k** » 09 Dec 2007, 18:14

Generically?

1. Write a gadget that looks for one or more mod options.
2. Make it do what you want those mod options to do.

Forboding Angel · Post by **Forboding Angel** » 09 Dec 2007, 18:15

OK I apologize, cause I need to be mroe clear with what I'm saying.

There are all these lists, which seem to have mix and match values. If each list was set up the same then it would make mroe sense...

for example:

{
key = 'deployment',
name = 'Deployment Mode',
desc = 'Players deploy a limited number of units before the game starts',
type = 'bool',
def = false,
},

{
key = 'ai_bonus',
name = 'AI Bonus',
desc = 'Higher numbers mean that the AI gets more resources, health, etc...',
type = 'number',
def = 1.25,
min = 0.25,
max = 10,
step = 0.05, -- quantization is aligned to the def value
-- (step <= 0) means that there is no quantization
},

{
key = 'string_opt',
name = 'String Option',
desc = 'an unused string option',
type = 'string',
def = 'BiteMe',
maxlen = 12,
},

None of these really seem to share much in common.

Forboding Angel · Post by **Forboding Angel** » 09 Dec 2007, 18:16

Oh, so this is a thing for a gadget to interface with, not spring directly?

KDR_11k · Post by **KDR_11k** » 09 Dec 2007, 18:25

Yes. Spring itself doesn't care what your mod options are, you need Lua to do anything with them.

The entries there have a lot in common, the differences are for different value types. The first one's a simple checkbox, the second a slider and the third a text entry field.

Spring RTS Engine

How do mod options work?

How do mod options work?