1
0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-26 22:57:00 +02:00
vcmi/docs/modders/Artifact Format.md
2023-09-07 11:02:39 +03:00

1.3 KiB

See thread http://forum.vcmi.eu/viewtopic.php?t=558 for discussion

Artifact bonuses use Bonus Format.

TODO:

  • Artifacts growing with Commander level

Required data

In order to make functional artifact you also need:

  • Icon for hero inventory (1 image)
  • Icon for popup windows (1 image, optional)
  • Animation for adventure map (1 animation)

Format

{
	"type": ["HERO", "CREATURE", "COMMANDER"] //what kind of bearer can use this artifact
	"class": "TREASURE", //TREASURE, MINOR, MAJOR, RELIC, SPECIAL
	"slot":	"HEAD", //SHOULDERS, NECK, RIGHT_HAND, LEFT_HAND, TORSO, RIGHT_RING, LEFT_RING, FEET, MISC1, MISC2, MISC3, MISC4,
		//MACH1, MACH2, MACH3, MACH4, SPELLBOOK, MISC5
                //also possible MISC, RING 
	"value": 12000, //based on ARTRAITS.txt		
	"text":
	{
		"name": "Big Sword",
		"description": "Big sword gived +10 attack to hero",
		"event": "On your travel, you stumble upon big sword. You dust it off and stick in your backpack"
	},
	"graphics":
	{
		"image": "BigSword.png",
		"large": "BigSword_large.png",
		"map": "BigSword.def"//def file for adventure map
	},
	"bonuses":
	{
		Bonus_1,
		Bonus_2
	},
	"components": //optional, for combined artifacts only
	[
		"artifact1",
		"artifact2",
		"artifact3"
	],
	"warMachine" : "some.creature" //if set with artifact works like war machine
}