Modinfo.lua: Difference between revisions

Revision as of 19:49, 20 July 2016

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:

rts/System/FileSystem/ArchiveScanner.cpp

Details

The following tags are read, all are strings unless otherwise specified:

{{#css:

 span.value {
   color:#e65c00;
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.type {
   color:#0099cc; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.prefix {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }   
 span.name {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
   font-weight:bold;
 }
 span.var {
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }

}}name - The name displayed in the lobby or via Spring.exe, version is automatically appended. Don't put the version into the name!

{{#css:

 span.value {
   color:#e65c00;
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.type {
   color:#0099cc; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.prefix {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }   
 span.name {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
   font-weight:bold;
 }
 span.var {
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }

}}shortName - A short representation of the package name, usually an acronym of the above.

{{#css:

 span.value {
   color:#e65c00;
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.type {
   color:#0099cc; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.prefix {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }   
 span.name {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
   font-weight:bold;
 }
 span.var {
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }

}}version - The version of this package. See #Further Reading for more information.

{{#css:

 span.value {
   color:#e65c00;
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.type {
   color:#0099cc; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.prefix {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }   
 span.name {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
   font-weight:bold;
 }
 span.var {
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }

}}mutator - String. Is the package an official release or a mutator?

{{#css:

 span.value {
   color:#e65c00;
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.type {
   color:#0099cc; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.prefix {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }   
 span.name {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
   font-weight:bold;
 }
 span.var {
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }

}}game - 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.

{{#css:

 span.value {
   color:#e65c00;
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.type {
   color:#0099cc; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.prefix {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }   
 span.name {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
   font-weight:bold;
 }
 span.var {
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }

}}shortGame - Again an acronym representing the above.

{{#css:

 span.value {
   color:#e65c00;
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.type {
   color:#0099cc; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.prefix {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }   
 span.name {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
   font-weight:bold;
 }
 span.var {
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }

}}description - A description of this content package.

{{#css:

 span.value {
   color:#e65c00;
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.type {
   color:#0099cc; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.prefix {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }   
 span.name {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
   font-weight:bold;
 }
 span.var {
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }

}}modtype - What kind of content package is this? 1 for a game or mutator, 0 for a hidden base content file. Maps use 3 in mapinfo.lua.

{{#css:

 span.value {
   color:#e65c00;
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.type {
   color:#0099cc; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.prefix {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }   
 span.name {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
   font-weight:bold;
 }
 span.var {
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }

}}depend - 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.

{{#css:

 span.value {
   color:#e65c00;
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.type {
   color:#0099cc; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }
 span.prefix {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }   
 span.name {
   color:#105289; 
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
   font-weight:bold;
 }
 span.var {
   font-family: â€˜Lucida Consoleâ€™, Monaco, monospace;
 }

}}replace - 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

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

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.

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

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 0. The following example is from springcontent.sdz, which is automatically loaded by Spring for all games.

local modinfo = {
  name = "Spring content",
  version = "v1",
  description = "Mods can depend on this archive to get all the spring content",
  modtype = 0,
  depend = {
    "Spring Bitmaps v1"
  },
}

return modinfo

@@ Line 12: / Line 12: @@
 ==Details==
 The following tags are read, all are strings unless otherwise specified:
-* <code>name</code> - The name displayed in the lobby or via Spring.exe, <code>version</code> is automatically appended. [http://springrts.com/phpbb/viewtopic.php?f=14&t=25927 Don't put the version into the name!]
+* {{name|name}} - The name displayed in the lobby or via Spring.exe, <code>version</code> is automatically appended. [http://springrts.com/phpbb/viewtopic.php?f=14&t=25927 Don't put the version into the name!]
-* <code>shortName</code> - A short representation of the package name, usually an acronym of the above.
+* {{name|shortName}} - A short representation of the package name, usually an acronym of the above.
-* <code>version</code> - The version of this package. See [[#Further Reading]] for more information.
+* {{name|version}} - The version of this package. See [[#Further Reading]] for more information.
-* <code>mutator</code> - String. Is the package an official release or a mutator?
+* {{name|mutator}} - String. Is the package an official release or a mutator?
-* <code>game</code> - What game is this package based on? This is subtly different from the <code>name</code> attribute. Consider that a main game archive and a mutator would have the same game, but different name values.
+* {{name|game}} - What game is this package based on? This is subtly different from the <code>name</code> attribute. Consider that a main game archive and a mutator would have the same game, but different name values.
-* <code>shortGame</code> - Again an acronym representing the above.
+* {{name|shortGame}} - Again an acronym representing the above.
-* <code>description</code> - A description of this content package.
+* {{name|description}} - A description of this content package.
-* <code>modtype</code> - What kind of content package is this? 1 for a game or mutator, 0 for a hidden base content file. Maps use 3 in [[mapinfo.lua]].
+* {{name|modtype}} - What kind of content package is this? 1 for a game or mutator, 0 for a hidden base content file. Maps use 3 in [[mapinfo.lua]].
-* <code>depend</code> - A table of other content packages, referenced by <code>name + version</code>, 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 <code>'Spring Cursors'</code> (provided as <code>cursors.sdz</code> in the Spring <code>base</code> directory) if they do not yet have their own [[MouseCursors|custom cursors]].
+* {{name|depend}} - A table of other content packages, referenced by <code>name + version</code>, 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 <code>'Spring Cursors'</code> (provided as <code>cursors.sdz</code> in the Spring <code>base</code> directory) if they do not yet have their own [[MouseCursors|custom cursors]].
-* <code>replace</code> - A table of content packages, again referenced by <code>name + version</code>, 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 <code>modinfo.lua</code> of all packages which <code>depend</code> on it. This is not usually used to update main game archives, however, as players may wish to continue playing a previous version.
+* {{name|replace}} - A table of content packages, again referenced by <code>name + version</code>, 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 <code>modinfo.lua</code> of all packages which <code>depend</code> on it. This is not usually used to update main game archives, however, as players may wish to continue playing a previous version.
 ==Examples==