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

82 lines
1.9 KiB
Markdown
Raw Normal View History

2023-09-01 11:11:35 +02:00
Artifact bonuses use [Bonus Format](../Bonus_Format.md)
2023-08-12 11:39:44 +02:00
## 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
``` jsonc
2023-08-12 11:39:44 +02:00
{
// Type of this artifact - creature, hero or commander
2023-09-01 00:30:26 +02:00
"type": ["HERO", "CREATURE", "COMMANDER"]
// TREASURE, MINOR, MAJOR, RELIC, SPECIAL
2023-09-01 00:30:26 +02:00
"class": "TREASURE",
// Slot(s) to which this artifact can be put, if applicable
// SHOULDERS, NECK, RIGHT_HAND, LEFT_HAND, TORSO, RIGHT_RING, LEFT_RING, FEET, MISC1, MISC2, MISC3, MISC4,
// MACH1, MACH2, MACH3, MACH4, SPELLBOOK, MISC5
// MISC, RING
2023-09-01 00:30:26 +02:00
"slot": "HEAD",
"slot": [ "LEFT_HAND", "RIGHT_HAND ],
2023-09-01 00:30:26 +02:00
// Cost of this artifact, in gold
2023-09-01 00:30:26 +02:00
"value": 12000,
2023-08-12 11:39:44 +02:00
"text":
{
// Name of the artifact
2023-08-12 11:39:44 +02:00
"name": "Big Sword",
// Long description of this artifact
2023-08-12 11:39:44 +02:00
"description": "Big sword gived +10 attack to hero",
// Text that visible on picking this artifact on map
2023-08-12 11:39:44 +02:00
"event": "On your travel, you stumble upon big sword. You dust it off and stick in your backpack"
},
"graphics":
{
// Base image for this artifact, used for example in hero screen
2023-08-12 11:39:44 +02:00
"image": "BigSword.png",
// Large image, used for drag-and-drop and popup messages
2023-08-12 11:39:44 +02:00
"large": "BigSword_large.png",
2023-09-01 00:30:26 +02:00
//def file for adventure map
"map": "BigSword.def"
2023-08-12 11:39:44 +02:00
},
// Bonuses provided by this artifact using bonus system
2023-08-12 11:39:44 +02:00
"bonuses":
{
Bonus_1,
Bonus_2
},
// Optional, list of components for combinational artifacts
2023-09-01 00:30:26 +02:00
"components":
2023-08-12 11:39:44 +02:00
[
"artifact1",
"artifact2",
"artifact3"
],
// Creature id to use on battle field. If set, this artifact is war machine
2023-09-01 00:30:26 +02:00
"warMachine" : "some.creature"
// If set to true, artifact won't spawn on a map without water
"onlyOnWaterMap" : false,
// TODO: document
"growing" : {
"bonusesPerLevel" : {},
"thresholdBonuses" : {},
}
2023-08-12 11:39:44 +02:00
}
```