| Both sides previous revision
Previous revision
|
|
technical:example [2020/06/15 21:01]
reetam small edits to config formatting, will continue later |
technical:example [2020/06/19 22:33] (current)
reetam PLEASE REVIEW: complete overhaul of this page. will add hyperlinks later |
| ====== Example json ====== | ====== Example JSON ====== |
| * "name": "Example", //(The name of the Creature)// | * { |
| * "creatureType": "Example", //(Creature type gives it the beastiary category and what treats it will eat)// | * "name": "example", // (Name of the creature. Auto-capitalises the first letter in game.)// |
| * "groups": [ | * "creatureType": "example", // (The creature type. Determines where in the Beastiary it can be found, as well as the shape of the spawn egg.)// |
| "Example" //(Creature group gives it its AI)// | * "groups": [ // (The creature group. Determines AI.)// |
| * ], | * "example" |
| * "entityClass": "com.lycanitesmobs.core.entity.creature.EntityExample", //(where the actual storage of the java info of the Creature is housed)// | * ], |
| * "modelClass": "com.lycanitesmobs.client.model.creature.ModelExample", // (where the actual storage of the Model info of the Creature is housed)// | * "entityClass": "com.lycanitesmobs.core.entity.creature.EntityExample", // (The entity class that the mob will use. Not recommended to change as it can be unstable if you don't know what you are doing.)// |
| * "loadDefault": true, //(makes it so the Default version of this json is reloaded when launching the mod making sure that you don't accidentally mess up your version and giving a handy backup))// | * "modelClass": "com.lycanitesmobs.client.model.creature.ModelExample", // (The model class that the mob will use. Not recommended to change as it can be unstable if you don't know what you are doing.)// |
| * "enabled": true, //(this tells the mod if the creature should be used or not, changing this to false will make the creature not spawn)// | * "loadDefault": true, // **(Set this to false whenever you edit the config file, otherwise it will reset! Leaving it as or setting it to true is useful for regenerating specific config files.)**// |
| * "spawning": { | * "enabled": true, // **(Setting this to false will disable the mob entirely. Will cause the game to crash if the entity exists in game already.)**// |
| * "enabled": true, // (This tells the mod if this Creature should normally spawn in the world)// | * "spawning": { |
| * "spawners": [ | * "enabled": true, // (This value should be set to false to disable the mob from spawning in-game. Does not prevent spawning via spawn egg.)// |
| * "Example" //(This tells the mod where the Creature will normally spawn in the world)// | * "spawners": [ // (A list of spawners for the mob to use. You can find a list of spawners in the spawners folder in the config.)// |
| * ], | * "example", |
| * "disableSubspecies": false, //(This tells the mod if subspecies should be disabled in the world)// | * ], |
| * "dimensionIds": [ //(This tells the mod where subspecies should be disabled (if disabled) in the world)// | * "disableSubspecies": false, // (Whether the game will allow subspecies of the mob to spawn.)// |
| * -1, | * "dimensionIds": [ // (List of dimension IDs that the mob can spawn in. Overworld is 0, Nether is -1, End is 1. Most dimension mods have the dimension id in the config.)// |
| * 1 | * 0 |
| * ], | * ], |
| * "dimensionListType": "blacklist", //(this is the dimension blacklist section)// | * "dimensionListType": "whitelist", // (Whether to whitelist or blacklist dimension IDs.)// |
| * "ignoreBiome": false, //(if this is true then the following sections are blacklisted)// | * "ignoreBiome": true, // (When set to true, will allow the mob to spawn in any biome.)// |
| * "biomes": [ //(this is the section where it tells the creature what biomes to spawn in)// | * "biomeTags": [ // (Sets the biome tags of the biomes that the mob can spawn in.)// |
| * "Example" | * "example" |
| * ], | * ], |
| * "spawnWeight": 6, //(the chance that the next creature spawned will be this creature)// | * "spawnWeight": 4, // (Likelihood that the mob will spawn among the other mobs in its spawner.)// |
| * "dungeonWeight": 200, //(the chance that the next creature spawned in a dungeon will be this creature)// | * "dungeonWeight": 200, // (Likelihood that the mob will appear in a dungeon spawner.)// |
| * "spawnAreaLimit": 5, //(the limit of this creature in a certain area)// | * "spawnAreaLimit": 5, // (How many mobs of this species are allowed every 16 chunks.)// |
| * "spawnGroupMin": 1, //(the minimum number of this creature in a group)// | * "spawnGroupMin": 1, // (Minimum amount of mobs that will spawn in a group.)// |
| * "spawnGroupMax": 3, //(the maximum number of this creature in a group)// | * "spawnGroupMax": 3, // (Maximum amount of mobs that will spawn in a group.)// |
| * "spawnsInLight": false, //(this tell the mod if this creature can spawn in light)// | * "spawnsInLight": true, // (Whether the mob can spawn in light levels above 7.)// |
| * "spawnsInDark": true, //(this tell the mod if this creature can spawn in dark)// | * "spawnsInDark": true, // (Whether the mob can spawn in light levels below 7.)// |
| * "worldDayMin": -1, //(this tell the mod how many in-game days before this creature can spawn)// | * "worldDayMin": -1, // (The amount of days that must pass before the spawner is enabled in a world. Set to -1 for it to start enabled.)// |
| * "despawnNatural": true, //(this tell the mod if this creature will despawn naturally)// | * "worldDayMax": 32767, // (The amount of days that must pass before the spawner is disabled in a world. Remove the line for it to never be disabled.)// |
| * "despawnForced": false //(this tell the mod if this creature will despawn via commands or console)// | * "despawnNatural": true, // (Whether the mob will despawn naturally.)// |
| * }, | * "despawnForced": false // (Whether the mob will be forced to despawn.)// |
| * "width": 0.9, //(this is the creatures width relative to its model)// | * }, |
| * "height": 0.9, //(this is the creatures height relative to its model)// | * "width": 2.5, // (The height of the hitbox.)// |
| * "experience": 5, //(this is the creatures experience it gives upon death)// | * "height": 2.5, // (The width of the hitbox.)// |
| * "health": 5, //(this is the creatures health)// | * "experience": 10, // (How much experience the mob drops.)// |
| * "defense": 0, //(this is the creatures natural defense)// | * "health": 20, // (The health level, in half-hearts, that the mob has.)// |
| * "armor": 0, //(this is the creatures armor points)// | * "defense": 1, // (The defense level of the mob.)// |
| * "speed": 28, //(this is the creatures movement speed)// | * "armor": 0, // (The armor level of the mob.)// |
| * "damage": 1, //(this is the creatures damage it does on attacks)// | * "speed": 24, // (The speed of the mob.)// |
| * "attackSpeed": 2, //(this is the creatures attack rate of its melee attacks)// | * "damage": 3, // (How much damage the mob deals.)// |
| * "rangedSpeed": 1, //(this is the creatures fire rate of its ranged attacks)// | * "attackSpeed": 1, // (How often the mob can attack.)// |
| * "effectDuration": 5, //(this is the creatures duration of any effects it gives you)// | * "rangedSpeed": 0.25, // (The rate of fire of the mob.)// |
| * "effectAmplifier": 0, //(this is the creatures this is the tier of the effect the mob gives on attack)// | * "effectDuration": 5, // (How long the effect dealt by the mob lasts.)// |
| * "pierce": 1, //(this is the creatures ability to pierce armor)// | * "effectAmplifier": 0, // (The amplifier of the effect dealt by the mob.)// |
| * "sight": 24, //(this is the creatures Aggressive range)// | * "pierce": 1, // (Whether the mob pierces through armor.)// |
| * "knockbackResistance": 0, //(this is the creatures knockback resistance)// | * "sight": 32, // (The range that the mob can see you from.)// |
| * "eggBackColor": "#537d41", //(this is the color of the spawn eggs bottom layer)// | * "knockbackResistance": 0, // (The chance that the mob will resist knockback.)// |
| * "eggForeColor": "#dfb752", //(this is the color of the spawn eggs top layer)// | * "eggBackColor": "#FFFFFF", // (The primary color of the spawn egg, in hex.)// |
| * "subspecies": [ //(this is the section where info about subspecies are stored)// | * "eggForeColor": "#000000", // (The secondary color of the spawn egg, in hex.)// |
| * { | * "subspecies": [ // (The types of subspecies it has. The subspecies must match the textures given in the files.)// |
| * "index": 1, //(this tells the mod what to register this subspecies as in commands)// | * { |
| * "name": "Example", //(this is the name of the subspecies)// | * "index": 0, |
| * "type": "uncommon" //(this is the type of subspecies the creature will be)// | * "variants": [ |
| * }, | * { |
| * { | * "index": 1, |
| * "index": 2, | * "name": "example", // (The name of the subspecies. Can be scarlet, golden, verdant, keppel, azure, violet, dark, ashen, lux, and russet, meaning red, yellow, green, cyan, blue, magenta, black, grey, white, and brown respectively.)// |
| * "name": "Example2", | * "type": "uncommon" // (Whether the subspecies is uncommon or rare.)// |
| * "type": "uncommon" | * } |
| * }, | * ] |
| * { | * } |
| * "index": 3, | * ], |
| * "name": "Challenge", //(this is the name of the subspecies this one means it will be a more difficult subspecies)// | * "element": "example", // (The element(s) of the mob.)// |
| * "scale": 3, //(this is the size at which this subspecies will spawn)// | * "diets": [ |
| * "type": "rare" //(this is a rare type its normally used for special creatures such as event Creatures or challenge bosses)// | * "examplevore" // (The diet(s) of the mob.)// |
| * } | * ], |
| * ], | * "peaceful": false, // (Set to true if the mob doesn't attack.)// |
| * "element": "Example", //(this is the elemental magic that the creature is made up of)// | * "summonable": false, // (Whether you can summon the mob.)// |
| * "diets": [ //(this is the section that tells the mod what types of diets to tell the creature to eat)// | * "tameable": true, // (Whether you can tame the mob.)// |
| * "Example", //(what diet to tell the creature it can eat from)// | * "mountable": true, // (Whether you can mount the mob.)// |
| * "Example2" | * "summonCost": 2, // (The summon cost of the mob.)// |
| * ], | * "dungeonLevel": 3, // (The dungeon level of the mob.)// |
| * "peaceful": false, //(tells the mod if this creature is peaceful or not)// | * "drops": [ // (The drop(s) of the mob.)// |
| * "summonable": true, //(tells the mod if this creature is summonable or not)// | * { |
| * "tameable": false, //(tells the mod if this creature is tameable or not)// | * "item": "example:drop_one", // (The namespaced ID of the item.)// |
| * "mountable": false, //(tells the mod if this creature is mountable or not)// | * "minAmount": 1, // (The minimum amount that the mob can drop.)// |
| * "summonCost": 4, //(the summoning mana required to summon 1 of this creature)// | * "maxAmount": 2, // (The maximum amount that the mob can drop.)// |
| * "dungeonLevel": 1, //(the level of a dungeon the creature will spawn at)// | * "chance": 1 // (The likelihood of the mob dropping the item, out of 1.)// |
| * "drops": [ //(this section tells the mod what items it should drop and how many)// | * }, |
| * { | * ], |
| * "item": "minecraft:Item", //(the item it will drop upon death)// | * "sizeScale": 1, // (The scaling of the mob.)// |
| * "burningItem": "minecraft:Item", //(the item to drop if the creature is on fire instead of the normal item)// | * "hitboxScale": 1, // (The hitbox scaling of the mob.)// |
| * "minAmount": 1, //(the minimum amount that this item can drop of)// | * } |
| * "maxAmount": 5, //(the maximum amount that this item can drop of)// | |
| * "chance": 1 //(the chance from .1 to 1 of it dropping the item .1=1% and 1=100%)// | |
| * }, | |
| * { | |
| * "item": "minecraft:Item", | |
| * "minAmount": 1, | |
| * "maxAmount": 8, | |
| * "chance": 1 | |
| * }, | |
| * { | |
| * "item": "lycanitesmobs:soulstoneExample", | |
| * "minAmount": 1, | |
| * "maxAmount": 1, | |
| * "chance": 1, | |
| * "subspecies": 3 //(this section restricts this item to a certain subspecies)// | |
| * } | |
| * ], | |
| * "sizeScale": 1, //(this section tells the scale size of the model)// | |
| * "hitboxScale": 1 //(this section tells the scale size of the hitbox)// | |
| * } | |
reetam