Difference between revisions of "Documentation/Engine/Units/package version info"

From SCS Modding Wiki
Jump to navigation Jump to search
m (→‎Attributes)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
Package version info is unit containing version informations such like name of the folder or archive with content and the array of compatible game versions.
+
'''Package version info''' is a [[Documentation/Engine/Units|unit]] containing workshop mod package information, such as the name of the folder or archive with content and the array of compatible game versions. It is used in each workshop mod's [[Documentation/Tools/SCS_Workshop_Uploader/versions.sii|versions.sii]].
  
−
The package version info without defined compatible_versions is called universal version. This version will be used for all game versions that are not explictly defined inside versions.sii file.
+
== Special Case: Universal Version ==
−
 
+
Each workshop mod's versions.sii file may have a ''single'' package version info without any defined compatible_versions, called the “universal version.” The associated package will be used for all game versions that are not defined by another package version info unit inside the versions.sii file.
−
'''package_version_info unit attributes:'''
 
  
 +
== Attributes ==
 
{| class="wikitable"
 
{| class="wikitable"
−
!|Type
 
 
!|Name
 
!|Name
 +
!|[[Documentation/Engine/Units#Attribute_types|Type]]
 +
!|Required/Optional
 
!|Description
 
!|Description
 
|-
 
|-
−
|string
+
|package_name
−
|folder
+
|style="text-align:center;"|string
−
|The name of the folder or archive with the version-specific mod content. This is required attribute.
+
|style="text-align:center;"|Required
 +
|The name of the folder or archive with the version-specific mod content. For zip archives, package_name is just the file name without the extension.
 
|-
 
|-
−
|string array
 
 
|compatible_versions
 
|compatible_versions
−
|The array containg set of versions that are compatible with this version definition. This attribute is optional, if not specified this version will be used for all of the game versions - you can only have one `package_version_info` with this parameter not specified in versions.sii
+
|style="text-align:center;"|string array
 +
|style="text-align:center;"|Optional
 +
|The array containing the set of versions that are compatible with this version definition. If not specified this package will be used for all of the game versions not explicitly defined for other packages. <BR />'''Important:''' Each workshop mod's versions.sii can only contain ''one'' `package_version_info` unit without this parameter specified.
 +
|-
 +
|informational
 +
|style="text-align:center;"|bool
 +
|style="text-align:center;"|Optional
 +
|When true, it indicates that the package contains information only. If unspecified, it defaults to false.
 
|}
 
|}
  
 +
{{UnitDef|def=<nowiki>  "package_version_info":{
 +
  "superclass":"unit",
 +
  "attrs":{
 +
    "package_name":{
 +
    "type": "string"
 +
    },
 +
    "compatible_versions":{
 +
    "type": "string_array"
 +
    },
 +
    "informational":{
 +
    "type": "bool"
 +
    }
 +
  }</nowiki>}}
  
−
[[Category:Documentation]]
+
== See Also ==
−
[[Category:Units]]
+
[[Tutorials/SCS_Workshop_Uploader/How_to_use_mod_versioning|Tutorial: How to Use Mod Versioning]]
−
[[Category:SCS Workshop Uploader]]
 

Latest revision as of 21:32, 2 April 2023

Package version info is a unit containing workshop mod package information, such as the name of the folder or archive with content and the array of compatible game versions. It is used in each workshop mod's versions.sii.

Special Case: Universal Version

Each workshop mod's versions.sii file may have a single package version info without any defined compatible_versions, called the “universal version.” The associated package will be used for all game versions that are not defined by another package version info unit inside the versions.sii file.

Attributes

Name Type Required/Optional Description
package_name string Required The name of the folder or archive with the version-specific mod content. For zip archives, package_name is just the file name without the extension.
compatible_versions string array Optional The array containing the set of versions that are compatible with this version definition. If not specified this package will be used for all of the game versions not explicitly defined for other packages.
Important: Each workshop mod's versions.sii can only contain one `package_version_info` unit without this parameter specified.
informational bool Optional When true, it indicates that the package contains information only. If unspecified, it defaults to false.


Raw Unit Definition

  "package_version_info":{
   "superclass":"unit",
   "attrs":{
    "package_name":{
     "type": "string"
    },
    "compatible_versions":{
     "type": "string_array"
    },
    "informational":{
     "type": "bool"
    }
   }

See Also

Tutorial: How to Use Mod Versioning

Retrieved from "https://modding.scssoft.com/index.php?title=Documentation/Engine/Units/package_version_info&oldid=5191"