1
0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-16 10:19:47 +02:00
vcmi/docs/modders/Artifact_Format.md

52 lines
1.3 KiB
Markdown
Raw Normal View History

2023-08-12 11:39:44 +02:00
See thread <http://forum.vcmi.eu/viewtopic.php?t=558> for discussion
Artifact bonuses use [Bonus Format](Bonus_Format "wikilink").
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
``` javascript
{
"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
}
```