Difference between revisions of "Packages"
From VCMI Project Wiki
(→Package structure) |
(→Package structure) |
||
| Line 13: | Line 13: | ||
All files should be placed within the scope of root folder of mod.py file. | All files should be placed within the scope of root folder of mod.py file. | ||
Mods folder in main VCMI directory is scanned upon entering "new game" menu in search of mod.py files. | Mods folder in main VCMI directory is scanned upon entering "new game" menu in search of mod.py files. | ||
| + | |||
| + | =Adding new objects= | ||
| + | |||
| + | An example pseudo-code in Python for adding new artifact: | ||
| + | <pre> | ||
| + | id = CreateArtifact( | ||
| + | 'CrystalOrb', #reference name | ||
| + | 'Crystal Orb', #actual name in game | ||
| + | ART_RELIC, #rarity | ||
| + | ART_HERO, #artifact type (including combined artifacts, commander or creature art) | ||
| + | ARTPOS_MISC #slot | ||
| + | ) | ||
| + | id.AddBonus (Bonus.SIGHT_RADIOUS,+12) #using namespace Bonus | ||
| + | id.price = 8000 | ||
| + | id.AIValue = 12000 | ||
| + | id.description = ParseTextFile ('.\CrystalOrb.txt') | ||
| + | SetArtifactDef ('CrystalOrb','.\lodfile\orb.def') | ||
| + | ArtHandler.SetArtAvaliable ('CrystalOrb') | ||
| + | </pre> | ||
Revision as of 15:34, 5 February 2012
Package structure
Packages may consist of following files:
- mod.py - main file required by Mod Handler. Includes unique name and version of package. Lists all related files included in mod.
- Script defining new objects and requesting Mod Handler to put them in game.
- Graphics files
- Sound files
- Additional Python script files (.py)
- Additional text files
- Possibly .json files
All files should be placed within the scope of root folder of mod.py file. Mods folder in main VCMI directory is scanned upon entering "new game" menu in search of mod.py files.
Adding new objects
An example pseudo-code in Python for adding new artifact:
id = CreateArtifact(
'CrystalOrb', #reference name
'Crystal Orb', #actual name in game
ART_RELIC, #rarity
ART_HERO, #artifact type (including combined artifacts, commander or creature art)
ARTPOS_MISC #slot
)
id.AddBonus (Bonus.SIGHT_RADIOUS,+12) #using namespace Bonus
id.price = 8000
id.AIValue = 12000
id.description = ParseTextFile ('.\CrystalOrb.txt')
SetArtifactDef ('CrystalOrb','.\lodfile\orb.def')
ArtHandler.SetArtAvaliable ('CrystalOrb')
