Difference between revisions of "User:Ivan/Mod format WIP"
From VCMI Project Wiki
(→Mod configuration format: Move FS to bottom) |
|||
| Line 4: | Line 4: | ||
=Filesystem format= | =Filesystem format= | ||
| − | All files from one mod are placed into mod directory located in Mods/ directory | + | All files from one mod are placed into mod directory located in Mods/ directory. Name of directory also serves as unique identifier of mod |
| − | Name of directory also serves as unique identifier of mod | ||
== Main mod directory == | == Main mod directory == | ||
Main mod directory contains following elements: | Main mod directory contains following elements: | ||
* main mod configuration file | * main mod configuration file | ||
| − | |||
* content directory | * content directory | ||
| − | |||
=== Main mod configuration file === | === Main mod configuration file === | ||
| Line 18: | Line 15: | ||
See [[#Mod configuration format|mod configuration format]] for description | See [[#Mod configuration format|mod configuration format]] for description | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Content directory === | === Content directory === | ||
Acts as game root directory and contains most of files from this mod | Acts as game root directory and contains most of files from this mod | ||
Revision as of 11:20, 25 May 2013
Future mod format, WIP
Based on modding guidelines page, any parts implemented in code should be moved to original page from here
Contents
Filesystem format
All files from one mod are placed into mod directory located in Mods/ directory. Name of directory also serves as unique identifier of mod
Main mod directory
Main mod directory contains following elements:
- main mod configuration file
- content directory
Main mod configuration file
File named "mod.json", contains all data necessary to load this mod into modding system.
See mod configuration format for description
Content directory
Acts as game root directory and contains most of files from this mod To avoid conflicts it is adviced to use subfolders with the name of mod:
Content/Data/myMod/ ... Content/Sprites/myMod/
See game data directories for description on where which files should be placed.
Data directories
Can be any of the following:
- data/ - unorganized files, mostly bitmap images (.bmp, .png, .pcx) and some rarely changed files like fonts
- config/ - json configuration files
- maps/ - h3m maps added or modified by mod
- music/ - music files. Mp3 is fully supported, ogg support may be added if needed
- sounds/ - sound files, in wav format.
- sprites/ - animation as well as any image sets (H3 .def files or VCMI .json files)
- video/ - video files, .bik or .smk. In future there may be support for other formats
Mod configuration format
{
// Name of your mod. While it does not have hard length limit
// it should not be longer than ~30 symbols to fit into allowed space
"name" : "My test mod",
// Version of the mod. Consists from up to 3 numbers:
// 1) Major - changed when there is large change in functionality
// 2) Minor - some minor changes notable by players
// 3) Patch - small bugfix releases
// Minor and Patch numbers are assumed to be 0 if not specified
// Used during updating and in dependencies resolution
"version" : "1.0.2"
// author of mod. Can be nickname, real name or name of team
"author" : "Anonymous"
// Home page of mod or link to forum thread
"weblink" : "http://example.com"
// Type of mod, e.g. "Town", "Artifacts", "Graphical". Should be predefined list
"modType" : "Graphical"
// More lengthy description of mod. No hard limit
// TODO: show it in some kind of mod manager
"description" : "My test mods that add a lot of useless stuff into the game",
// Download URL, used only in repository
"download" : "http://example.com/packages/1.1.zip",
// Size of archive for download, in Kb, only repository
"size" : 9001,
// List of mods that are required to run this one
"depends" :
[
// Can be a single name
"baseMod",
// Or using range of allowed versions
"1.0<modName<=5",
],
// List of mods that can't be enabled in the same time as this one
// Similar to dependencies can be either name of mod or mod name + versions range
"conflicts" :
[
"badMod"
],
// Following section describes configuration files with content added by mod
// It can be split into several files in any way you want but recommended organization is
// to keep one file per object (creature/hero/etc) and, if applicable, add separate file
// with translatable strings for each type of content
// See "additional links" at the bottom of page for descriptions of each of these formats
// list of factions/towns configuration files
"factions" :
[
"config/myMod/faction.json"
]
// List of hero classes configuration files
"heroClasses" :
[
"config/myMod/heroClasses.json"
],
// List of heroes configuration files
"heroes" :
[
"config/myMod/heroes.json"
],
// list of creature configuration files
"creatures" :
[
"config/myMod/creatures.json"
],
// List of artifacts configuration files
"artifacts" :
[
"config/myMod/artifacts.json"
],
// This is description on how files are organized in your mod
// Optional, by default it follow filesystem format description
// Example below shows default value
"filesystem":
{
"":
[
{"type" : "dir", "path" : "/Content"}
]
}
}
