From be61daa95a785bda632568b93494d1539ebff6b9 Mon Sep 17 00:00:00 2001 From: Laserlicht <13953785+Laserlicht@users.noreply.github.com> Date: Sat, 10 Aug 2024 13:36:31 +0200 Subject: [PATCH] campaigns docs --- docs/modders/Campaign_Format.md | 21 +++------------------ 1 file changed, 3 insertions(+), 18 deletions(-) diff --git a/docs/modders/Campaign_Format.md b/docs/modders/Campaign_Format.md index 554e98566..6779a1e7c 100644 --- a/docs/modders/Campaign_Format.md +++ b/docs/modders/Campaign_Format.md @@ -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 |