Modinfo.lua: Difference between revisions
From Spring
Jump to navigationJump to search
m Use numbers instead of strings for modtype (both are accepted) |
→Details: just use tag template instead? |
||
| (12 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
==Location== | ==Location== | ||
{{var|modinfo.lua}} is a file in the root directory of a Spring Game. | |||
==Purpose== | ==Purpose== | ||
| Line 6: | Line 6: | ||
==Source== | ==Source== | ||
The engine source code which parses the data from this file is viewable here: | The engine source code which parses the data from this file is viewable here: | ||
* {{sourcelink|file=rts/System/FileSystem/ArchiveScanner.cpp}} | |||
==Details== | ==Details== | ||
The following tags are read, all are strings unless otherwise specified: | The following tags are read, all are strings unless otherwise specified: | ||
{{tag | |||
|name = name | |||
|type = string | |||
|default = n/a | |||
|special = Required | |||
|description = The name displayed in the lobby or via Spring.exe, {{taglink|version}} is automatically appended. [http://springrts.com/phpbb/viewtopic.php?f=14&t=25927 Don't put the version into the name!] | |||
}} | |||
{{tag | |||
|name = shortName | |||
|type = string | |||
|default = n/a | |||
|description = A short representation of the package name, usually an acronym of the above. | |||
}} | |||
{{tag | |||
|name = version | |||
|type = string | |||
|default = n/a | |||
|description = The version of this package. See [[#Further Reading]] for more information. | |||
}} | |||
{{tag | |||
|name = mutator | |||
|type = string | |||
|default = n/a | |||
|special = Required | |||
|description = Is the package an official release or a mutator? | |||
}} | |||
{{tag | |||
|name = game | |||
|type = string | |||
|default = n/a | |||
|description = What game is this package based on? This is subtly different from the {{name|name}} attribute. Consider that a main game archive and a mutator would have the same game, but different name values. | |||
}} | |||
{{tag | |||
|name = shortGame | |||
|type = string | |||
|default = n/a | |||
|description = Again an acronym representing the above. | |||
}} | |||
{{tag | |||
|name = description | |||
|type = string | |||
|default = n/a | |||
|description = A description of this content package. | |||
}} | |||
{{tag | |||
|name = modType | |||
|type = int | |||
|default = n/a | |||
|description = What kind of content package is this? {{value|1}} for a game or mutator, {{value|4}} for a hidden base content file (prior to 104.0 this was {{value|0}}), menu archives use {{value|5}}. Maps use 3 in [[mapinfo.lua]]. | |||
}} | |||
{{tag | |||
|name = depend | |||
|type = table | |||
|default = {} | |||
|description = A table of other content packages, referenced by {{name|name + version}}, not their filename, which this package depends on. Spring will load them if they are present, or throw an error if they are missing. This is used by mutators to depend on main game file and by all games to depend on base content files. New games may particularly want to depend on {{value|'Spring Cursors'}} (provided as {{var|cursors.sdz}} in the Spring {{var|base}} directory) if they do not yet have their own [[MouseCursors|custom cursors]]. | |||
}} | |||
{{tag | |||
|name = replace | |||
|type = table | |||
|default = {} | |||
|description = A table of content packages, again referenced by {{name|name + version}}, that this package is meant to replace. For example if you have a base content package with your game music, you may wish to replace it with an updated version later on without having to modify the [[modinfo.lua]] of all packages which {{var|depend}} on it. This is not usually used to update main game archives, however, as players may wish to continue playing a previous version. | |||
}} | |||
==Examples== | ==Examples== | ||
===Main Game file=== | ===Main Game file=== | ||
< | <syntaxhighlight lang="lua"> | ||
local modinfo = { | local modinfo = { | ||
name = "My Awesome Spring Game", | name = "My Awesome Spring Game", | ||
| Line 47: | Line 101: | ||
return modinfo | return modinfo | ||
</ | </syntaxhighlight> | ||
===Mutator=== | ===Mutator=== | ||
A mutator depends on the main game file, but does not replace it, it will usually have a different | A mutator depends on the main game file, but does not replace it, it will usually have a different {{name|name}} and {{name|shortName}} but the same {{name|game}} and {{name|shortGame}} values as the main game file. It should still have a {{name|modtype}} of {{value|1}}. | ||
< | <syntaxhighlight lang="lua"> | ||
local modinfo = { | local modinfo = { | ||
name = "My Awesome Spring Game Mutator", | name = "My Awesome Spring Game Mutator", | ||
| Line 70: | Line 124: | ||
return modinfo | return modinfo | ||
</ | </syntaxhighlight> | ||
===Base Content=== | ===Base Content=== | ||
Base content is a hidden, unplayable content package which is depended on by your game. For example you might include music in a hidden content package so that it was not updated with the main game files. It must have a | Base content is a hidden, unplayable content package which is depended on by your game. For example you might include music in a hidden content package so that it was not updated with the main game files. It must have a {{name|modtype}} of {{value|4}} ({{value|0}} prior to 104.0). The following example is from {{var|springcontent.sdz}}, which is automatically loaded by Spring for all games. | ||
< | <syntaxhighlight lang="lua"> | ||
local modinfo = { | local modinfo = { | ||
name = "Spring content v1", | name = "Spring content", | ||
version = "v1", | |||
description = "Mods can depend on this archive to get all the spring content", | description = "Mods can depend on this archive to get all the spring content", | ||
modtype = | modtype = 4, | ||
depend = { | depend = { | ||
"Spring Bitmaps" | "Spring Bitmaps v1" | ||
}, | }, | ||
} | } | ||
return modinfo | return modinfo | ||
</ | </syntaxhighlight> | ||
===Further Reading=== | |||
Forum thread: {{forumlink|topic=25927&start=5|title=Please fix:games contain version in "name" tag (modinfo.lua)}} | |||
[[Category:gamedata]] | [[Category:gamedata]] | ||
Latest revision as of 21:30, 19 December 2017
Location
modinfo.lua is a file in the root directory of a Spring Game.
Purpose
The purpose of this file is to define a Spring content package as a game or game content archive. It is read both by the multiplayer lobbies and the engine itself.
Source
The engine source code which parses the data from this file is viewable here:
Details
The following tags are read, all are strings unless otherwise specified:
string name default: n/a Required
- The name displayed in the lobby or via Spring.exe, version is automatically appended. Don't put the version into the name!
string shortName default: n/a
- A short representation of the package name, usually an acronym of the above.
string version default: n/a
- The version of this package. See #Further Reading for more information.
string mutator default: n/a Required
- Is the package an official release or a mutator?
string game default: n/a
- What game is this package based on? This is subtly different from the name attribute. Consider that a main game archive and a mutator would have the same game, but different name values.
string shortGame default: n/a
- Again an acronym representing the above.
string description default: n/a
- A description of this content package.
int modType default: n/a
- What kind of content package is this? 1 for a game or mutator, 4 for a hidden base content file (prior to 104.0 this was 0), menu archives use 5. Maps use 3 in mapinfo.lua.
table depend default: {}
- A table of other content packages, referenced by name + version, not their filename, which this package depends on. Spring will load them if they are present, or throw an error if they are missing. This is used by mutators to depend on main game file and by all games to depend on base content files. New games may particularly want to depend on 'Spring Cursors' (provided as cursors.sdz in the Spring base directory) if they do not yet have their own custom cursors.
table replace default: {}
- A table of content packages, again referenced by name + version, that this package is meant to replace. For example if you have a base content package with your game music, you may wish to replace it with an updated version later on without having to modify the modinfo.lua of all packages which depend on it. This is not usually used to update main game archives, however, as players may wish to continue playing a previous version.
Examples
Main Game file
<syntaxhighlight lang="lua"> local modinfo = {
name = "My Awesome Spring Game", shortName = "MASG", game = "My Awesome Spring Game", shortGame = "MASG", mutator = "Official", version = "v1.0", description = "An awesome game I made with units", url = "http://www.linktomyawesomegame.com/", modtype = 1,
}
return modinfo </syntaxhighlight>
Mutator
A mutator depends on the main game file, but does not replace it, it will usually have a different name and shortName but the same game and shortGame values as the main game file. It should still have a modtype of 1.
<syntaxhighlight lang="lua">
local modinfo = {
name = "My Awesome Spring Game Mutator", shortName = "MASGM", game = "My Awesome Spring Game", shortGame = "MASG", mutator = "Double Speed Mutator", version = "v1.0", description = "An awesome mutator I made for MASG", url = "http://www.linktomyawesomegame.com/", modtype = 1, depend = { "My Awesome Spring Game v1.0", }
}
return modinfo </syntaxhighlight>
Base Content
Base content is a hidden, unplayable content package which is depended on by your game. For example you might include music in a hidden content package so that it was not updated with the main game files. It must have a modtype of 4 (0 prior to 104.0). The following example is from springcontent.sdz, which is automatically loaded by Spring for all games.
<syntaxhighlight lang="lua">
local modinfo = {
name = "Spring content",
version = "v1",
description = "Mods can depend on this archive to get all the spring content",
modtype = 4,
depend = {
"Spring Bitmaps v1"
},
}
return modinfo </syntaxhighlight>
Further Reading
Forum thread: Please fix:games contain version in "name" tag (modinfo.lua)
