Modinfo.lua - Revision history

Flozi: /* Details */ just use tag template instead?

2017-12-19T20:30:06Z

Details: just use tag template instead?

@@ Line 12: / Line 12: @@
 ==Details==
 The following tags are read, all are strings unless otherwise specified:
-* {{name|shortName}} - A short representation of the package name, usually an acronym of the above.
+{{tag
-* {{name|version}} - The version of this package. See [[#Further Reading]] for more information.
+{{tag
-* {{name|mutator}} - String. Is the package an official release or a mutator?
+{{tag
-* {{name|game}} - 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}} - Again an acronym representing the above.
+{{tag
-* {{name|description}} - A description of this content package.
+{{tag
-* {{name|modtype}} - 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}} - 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}} - 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.
+{{tag
 ==Examples==

Flozi: 104 ! base archives now have modtype of 4 and menu archive have modtype of 5 (Also use templates & instead of `, var template sucks for filenames)`


2017-12-18T21:40:35Z
104 ! base archives now have modtype of 4 and menu archive have modtype of 5 (Also use templates & <syntaxhighlight> instead of <code>, var template sucks for filenames)

				
				
				
				
				
				← Older revision
				Revision as of 22:40, 18 December 2017
				
Line 1:
Line 1:
==Location== ==Location==
<code>modinfo.lua</code> is a file in the root directory of a Spring Game. {{var|modinfo.lua}} is a file in the root directory of a Spring Game.



==Purpose== ==Purpose==
Line 12:
Line 12:
==Details== ==Details==
The following tags are read, all are strings unless otherwise specified: The following tags are read, all are strings unless otherwise specified:
* {{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!] * {{name|name}} - The name displayed in the lobby or via Spring.exe, {{name|version}} is automatically appended. [http://springrts.com/phpbb/viewtopic.php?f=14&t=25927 Don't put the version into the name!]



* {{name|shortName}} - 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.
Line 20:
Line 20:
* {{name|mutator}} - String. Is the package an official release or a mutator? * {{name|mutator}} - String. Is the package an official release or a mutator?



* {{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. * {{name|game}} - 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.



* {{name|shortGame}} - Again an acronym representing the above. * {{name|shortGame}} - Again an acronym representing the above.
Line 26:
Line 26:
* {{name|description}} - A description of this content package. * {{name|description}} - A description of this content package.



* {{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]]. * {{name|modtype}} - 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]].



* {{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]]. * {{name|depend}} - 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]].



* {{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. * {{name|replace}} - 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===
<code><pre> <syntaxhighlight lang="lua">
local modinfo = { local modinfo = {
   name = "My Awesome Spring Game",    name = "My Awesome Spring Game",
Line 48:
Line 48:



return modinfo return modinfo
</pre></code> </syntaxhighlight>



===Mutator=== ===Mutator===
A mutator depends on the main game file, but does not replace it, it will usually have a different <code>name</code> and <code>shortName</code> but the same <code>game</code> and <code>shortGame</code> values as the main game file. It should still have a <code>modtype</code> of 1. 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}}.






<code><pre> <syntaxhighlight lang="lua">
local modinfo = { local modinfo = {
   name = "My Awesome Spring Game Mutator",    name = "My Awesome Spring Game Mutator",
Line 71:
Line 71:



return modinfo return modinfo
</pre></code> </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 <code>modtype</code> of 0. The following example is from <code>springcontent.sdz</code>, which is automatically loaded by Spring for all games. 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.






<code><pre> <syntaxhighlight lang="lua">
local modinfo = { local modinfo = {
   name = "Spring content",    name = "Spring content",
   version = "v1",    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 = 0,    modtype = 4,
   depend = {    depend = {
     "Spring Bitmaps v1"      "Spring Bitmaps v1"
Line 89:
Line 89:



return modinfo return modinfo
</pre></code> </syntaxhighlight>



===Further Reading=== ===Further Reading===



Flozi: /* Details */ use template
2016-07-20T19:49:34Z
Details:  use template

				
				
				
				
				
				← Older revision
				Revision as of 20:49, 20 July 2016
				
Line 12:
Line 12:
==Details== ==Details==
The following tags are read, all are strings unless otherwise specified: 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== ==Examples==



Flozi: 1cat
2013-03-21T09:01:44Z
1cat

				
				
				
				
				
				← Older revision
				Revision as of 10:01, 21 March 2013
				
Line 94:
Line 94:
Forum thread: {{forumlink|topic=25927&start=5|title=Please fix:games contain version in "name" tag (modinfo.lua)}} Forum thread: {{forumlink|topic=25927&start=5|title=Please fix:games contain version in "name" tag (modinfo.lua)}}




[[Category:Game development]] 
[[Category:gamedata]] [[Category:gamedata]]



Flozi: /* Source */ reformat
2013-03-01T23:01:49Z
Source:  reformat

				
				
				
				
				
				← Older revision
				Revision as of 00:01, 2 March 2013
				
Line 6:
Line 6:



==Source== ==Source==
The engine source code which parses the data from this file is viewable here: {{sourcelink|file=rts/System/FileSystem/ArchiveScanner.cpp}} The engine source code which parses the data from this file is viewable here:
 
* {{sourcelink|file=rts/System/FileSystem/ArchiveScanner.cpp}}



==Details== ==Details==



Knorke: category to bottom
2012-02-22T00:08:22Z
category to bottom

				
				
				
				
				
				← Older revision
				Revision as of 01:08, 22 February 2012
				
Line 88:
Line 88:
return modinfo return modinfo
</pre></code> </pre></code>

===Further Reading===
Forum thread: {{forumlink|topic=25927&start=5|title=Please fix:games contain version in "name" tag (modinfo.lua)}}




[[Category:Game development]] [[Category:Game development]]
[[Category:gamedata]] [[Category:gamedata]]


===Further Reading=== 
Forum thread: {{forumlink|topic=25927&start=5|title=Please fix:games contain version in "name" tag (modinfo.lua)}} 



Flozi: /* Further Reading */ use forumlink template and go straight to relevant post
2011-11-17T21:48:00Z
Further Reading:  use forumlink template and go straight to relevant post

				
				
				
				
				
				← Older revision
				Revision as of 22:48, 17 November 2011
				
Line 94:
Line 94:



===Further Reading=== ===Further Reading===
Forum thread: ''Please fix:games contain version in "name" tag (modinfo.lua)'' <br> Forum thread: {{forumlink|topic=25927&start=5|title=Please fix:games contain version in "name" tag (modinfo.lua)}}
http://springrts.com/phpbb/viewtopic.php?f=14&t=25927 



Flozi: /* Further reading */ capitalisation
2011-11-17T21:42:49Z
Further reading:  capitalisation

				
				
				
				
				
				← Older revision
				Revision as of 22:42, 17 November 2011
				
Line 93:
Line 93:






===Further reading=== ===Further Reading===
Forum thread: ''Please fix:games contain version in "name" tag (modinfo.lua)'' <br> Forum thread: ''Please fix:games contain version in "name" tag (modinfo.lua)'' <br>
http://springrts.com/phpbb/viewtopic.php?f=14&t=25927 http://springrts.com/phpbb/viewtopic.php?f=14&t=25927



Flozi: /* Details */ please read whole page
2011-11-17T21:42:26Z
Details:  please read whole page

				
				
				
				
				
				← Older revision
				Revision as of 22:42, 17 November 2011
				
Line 14:
Line 14:
* <code>shortName</code> - A short representation of the package name, usually an acronym of the above. * <code>shortName</code> - A short representation of the package name, usually an acronym of the above.



* <code>version</code> - The version of this package. Can be any text you like but preferably not blank. It's also best if the version increments numerically so players know which version is newer. * <code>version</code> - The version of this package. See [[#Further Reading]] for more information.



* <code>mutator</code> - String. Is the package an official release or a mutator? * <code>mutator</code> - String. Is the package an official release or a mutator?



Spliff: Removed version from name in examples and clarify format of dependencies
2011-11-15T12:14:06Z
Removed version from name in examples and clarify format of dependencies

				
				
				
				
				
				← Older revision
				Revision as of 13:14, 15 November 2011
				
Line 14:
Line 14:
* <code>shortName</code> - A short representation of the package name, usually an acronym of the above. * <code>shortName</code> - A short representation of the package name, usually an acronym of the above.



* <code>version</code> - The version of this package. * <code>version</code> - The version of this package. Can be any text you like but preferably not blank. It's also best if the version increments numerically so players know which version is newer.



* <code>mutator</code> - Is the package an official release or a mutator? * <code>mutator</code> - 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. * <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.
Line 26:
Line 26:
* <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]]. * <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]].



* <code>depend</code> - A table of other content packages, referenced by <code>name</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>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]].



* <code>replace</code> - A table of content packages, again referenced by <code>name</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. * <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.



==Examples== ==Examples==
Line 77:
Line 77:
<code><pre> <code><pre>
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 = 0,    modtype = 0,
   depend = {    depend = {
     "Spring Bitmaps"      "Spring Bitmaps v1"
   },    },
} }

← Older revision		Revision as of 22:40, 18 December 2017
Line 1:		Line 1:
	==Location==		==Location==
	~~<code>~~modinfo.lua~~</code>~~ is a file in the root directory of a Spring Game.		{{var\|modinfo.lua}} is a file in the root directory of a Spring Game.

	==Purpose==		==Purpose==
Line 12:		Line 12:
	==Details==		==Details==
	The following tags are read, all are strings unless otherwise specified:		The following tags are read, all are strings unless otherwise specified:
	* {{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!]		* {{name\|name}} - The name displayed in the lobby or via Spring.exe, {{name\|version}} is automatically appended. [http://springrts.com/phpbb/viewtopic.php?f=14&t=25927 Don't put the version into the name!]

	* {{name\|shortName}} - 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.
Line 20:		Line 20:
	* {{name\|mutator}} - String. Is the package an official release or a mutator?		* {{name\|mutator}} - String. Is the package an official release or a mutator?

	* {{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.		* {{name\|game}} - 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.

	* {{name\|shortGame}} - Again an acronym representing the above.		* {{name\|shortGame}} - Again an acronym representing the above.
Line 26:		Line 26:
	* {{name\|description}} - A description of this content package.		* {{name\|description}} - A description of this content package.

	* {{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]].		* {{name\|modtype}} - 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]].

	* {{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]].		* {{name\|depend}} - 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]].

	* {{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.		* {{name\|replace}} - 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===
	<~~code><pre~~>		<syntaxhighlight lang="lua">
	local modinfo = {		local modinfo = {
	name = "My Awesome Spring Game",		name = "My Awesome Spring Game",
Line 48:		Line 48:

	return modinfo		return modinfo
	</~~pre></code~~>		</syntaxhighlight>

	===Mutator===		===Mutator===
	A mutator depends on the main game file, but does not replace it, it will usually have a different ~~<code>~~name~~</code>~~ and ~~<code>~~shortName~~</code>~~ but the same ~~<code>~~game~~</code>~~ and ~~<code>~~shortGame~~</code>~~ values as the main game file. It should still have a ~~<code>~~modtype~~</code>~~ of 1.		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}}.


	<~~code><pre~~>		<syntaxhighlight lang="lua">
	local modinfo = {		local modinfo = {
	name = "My Awesome Spring Game Mutator",		name = "My Awesome Spring Game Mutator",
Line 71:		Line 71:

	return modinfo		return modinfo
	</~~pre></code~~>		</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 ~~<code>~~modtype~~</code>~~ of 0. The following example is from ~~<code>~~springcontent.sdz~~</code>~~, which is automatically loaded by Spring for all games.		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.


	<~~code><pre~~>		<syntaxhighlight lang="lua">
	local modinfo = {		local modinfo = {
	name = "Spring content",		name = "Spring content",
	version = "v1",		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 = 0,		modtype = 4,
	depend = {		depend = {
	"Spring Bitmaps v1"		"Spring Bitmaps v1"
Line 89:		Line 89:

	return modinfo		return modinfo
	</~~pre></code~~>		</syntaxhighlight>

	===Further Reading===		===Further Reading===

← Older revision		Revision as of 20:49, 20 July 2016
Line 12:		Line 12:
	==Details==		==Details==
	The following tags are read, all are strings unless otherwise specified:		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==		==Examples==

← Older revision		Revision as of 10:01, 21 March 2013
Line 94:		Line 94:
	Forum thread: {{forumlink\|topic=25927&start=5\|title=Please fix:games contain version in "name" tag (modinfo.lua)}}		Forum thread: {{forumlink\|topic=25927&start=5\|title=Please fix:games contain version in "name" tag (modinfo.lua)}}


	~~[[Category:Game development]]~~
	[[Category:gamedata]]		[[Category:gamedata]]

← Older revision		Revision as of 00:01, 2 March 2013
Line 6:		Line 6:

	==Source==		==Source==
	The engine source code which parses the data from this file is viewable here: {{sourcelink\|file=rts/System/FileSystem/ArchiveScanner.cpp}}		The engine source code which parses the data from this file is viewable here:

			* {{sourcelink\|file=rts/System/FileSystem/ArchiveScanner.cpp}}

	==Details==		==Details==

← Older revision		Revision as of 01:08, 22 February 2012
Line 88:		Line 88:
	return modinfo		return modinfo
	</pre></code>		</pre></code>

			===Further Reading===
			Forum thread: {{forumlink\|topic=25927&start=5\|title=Please fix:games contain version in "name" tag (modinfo.lua)}}


	[[Category:Game development]]		[[Category:Game development]]
	[[Category:gamedata]]		[[Category:gamedata]]


	~~===Further Reading===~~
	~~Forum thread: {{forumlink\|topic=25927&start=5\|title=Please fix:games contain version in "name" tag (modinfo.lua)}}~~

← Older revision		Revision as of 22:48, 17 November 2011
Line 94:		Line 94:

	===Further Reading===		===Further Reading===
	Forum thread: ''Please fix:games contain version in "name" tag (modinfo.lua)~~'' <br>~~		Forum thread: {{forumlink\|topic=25927&start=5\|title=Please fix:games contain version in "name" tag (modinfo.lua)}}
	~~http://springrts.com/phpbb/viewtopic.php?f=14&t=25927~~

← Older revision		Revision as of 22:42, 17 November 2011
Line 93:		Line 93:


	===Further ~~reading~~===		===Further Reading===
	Forum thread: ''Please fix:games contain version in "name" tag (modinfo.lua)'' <br>		Forum thread: ''Please fix:games contain version in "name" tag (modinfo.lua)'' <br>
	http://springrts.com/phpbb/viewtopic.php?f=14&t=25927		http://springrts.com/phpbb/viewtopic.php?f=14&t=25927

← Older revision		Revision as of 22:42, 17 November 2011
Line 14:		Line 14:
	* <code>shortName</code> - A short representation of the package name, usually an acronym of the above.		* <code>shortName</code> - A short representation of the package name, usually an acronym of the above.

	* <code>version</code> - The version of this package. ~~Can be any text you like but preferably not blank. It's also best if the version increments numerically so players know which version is newer~~.		* <code>version</code> - The version of this package. See [[#Further Reading]] for more information.

	* <code>mutator</code> - String. Is the package an official release or a mutator?		* <code>mutator</code> - String. Is the package an official release or a mutator?

← Older revision		Revision as of 13:14, 15 November 2011
Line 14:		Line 14:
	* <code>shortName</code> - A short representation of the package name, usually an acronym of the above.		* <code>shortName</code> - A short representation of the package name, usually an acronym of the above.

	* <code>version</code> - The version of this package.		* <code>version</code> - The version of this package. Can be any text you like but preferably not blank. It's also best if the version increments numerically so players know which version is newer.

	* <code>mutator</code> - Is the package an official release or a mutator?		* <code>mutator</code> - 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.		* <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.
Line 26:		Line 26:
	* <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]].		* <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]].

	* <code>depend</code> - A table of other content packages, referenced by <code>name</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>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]].

	* <code>replace</code> - A table of content packages, again referenced by <code>name</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.		* <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.

	==Examples==		==Examples==
Line 77:		Line 77:
	<code><pre>		<code><pre>
	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 = 0,		modtype = 0,
	depend = {		depend = {
	"Spring Bitmaps"		"Spring Bitmaps v1"
	},		},
	}		}

Modinfo.lua - Revision history

Flozi: /* Details */ just use tag template instead?

Flozi: 104 ! base archives now have modtype of 4 and menu archive have modtype of 5 (Also use templates & instead of , var template sucks for filenames)

Flozi: /* Details */ use template

Flozi: 1cat

Flozi: /* Source */ reformat

Knorke: category to bottom

Flozi: /* Further Reading */ use forumlink template and go straight to relevant post

Flozi: /* Further reading */ capitalisation

Flozi: /* Details */ please read whole page

Spliff: Removed version from name in examples and clarify format of dependencies

Flozi: 104 ! base archives now have modtype of 4 and menu archive have modtype of 5 (Also use templates & instead of `, var template sucks for filenames)`