games/vcmi
1
0
Fork 0
mirror of https://github.com/vcmi/vcmi.git synced 2025-03-25 21:38:59 +02:00
Code Issues Releases Activity

campaigns docs

Browse Source
This commit is contained in:
Laserlicht 2024-08-10 13:36:31 +02:00
parent d97fdfdefa
commit be61daa95a
1 changed files with 3 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/modders/Campaign_Format.md
View File

@ -5,7 +5,7 @@
Starting from version 1.3, VCMI supports its own campaign format.
Campaigns have *.vcmp file format and it consists from campaign json and set of scenarios (can be both *.vmap and *.h3m)
To start making campaign, create file named `00.json`. See also [Packing campaign](#packing-campaign)
To start making campaign, create file named `header.json`. See also [Packing campaign](#packing-campaign)
Basic structure of this file is here, each section is described in details below
```js
@ -199,24 +199,9 @@ Predefined campaign regions are located in file `campaign_regions.json`
## Packing campaign
After campaign scenarios and campaign description are ready, you should pack them into *.vcmp file.
This file is basically headless gz archive.
This file is a zip archive.
Your campaign should be stored in some folder with json describing campaign information.
Place all your scenarios inside same folder and enumerate their filenames, e.g `01.vmap`, '02.vmap', etc.
```
my-campaign/
|-- 00.json
|-- 01.vmap
|-- 02.vmap
|-- 03.vmap
```
If you use unix system, execute this command to pack your campaign:
```
gzip -c -n ./* >> my-campaign.vcmp
```
If you are using Windows system, try this https://gnuwin32.sourceforge.net/packages/gzip.htm
The scenarios should be named as in `"map"` field from header. Subfolders are allowed.
## Compatibility table
| Version | Min VCMI | Max VCMI | Description |