Cobblemon Wiki - User contributions [en]

Poser

2025-03-06T12:43:50Z

Frank The Farmer: Added primary quirks to the poser page

{{TOC|right}}
== Preface ==
The <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]


== Poser Properties ==
Before breaking down each section of the Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!


=== Rootbone ===
The <code>rootBone</code> property specifies what bone in the model will act as the root bone for generic animations not assigned in the poser such as the evolution animation. If the model was made following the standard bone format, then it should simply be the name of the Pokémon in lower case. Punctuation and capitalization matter! So make sure it matches the root bone of your model exactly.

You are '''required''' to assign this root bone properly or else it will break the model in certain generic animations! These animations animate the root bone and do not reset it to its original position when it finishes. This can cause model displacement after evolutions.

Below is a breakdown of the simple rootBone property:
"<abbr title="This property attempts to call the specified bone from the model to assign it as the root bone for generic animations.">rootBone</abbr>": "<abbr title="In this scenario, the charizard bone is being called. This charizard bone should contain all other bones so generic animations can move the entire model for whatever they animate.">charizard</abbr>",


=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a negative Z value that is some multiple of 5.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon.

For the sake of clarity, you should always refer to animations like faints, cries, or physicals as '''Named Animations'''. This is to help everyone distinguish them from the animations that are applied to poses. This distinction is important because you can assign both <code>animations</code> and <code>namedAnimations</code> to a pose. This is to allow you to assign different cries, faints, or attack animations to different poses like your floating or flying poses. This allows for water attack animations if you make the animation to support it. This process will be detailed later. Below is a list of currently available Named Animation types and Poses to choose from. 

==== Animations & Named Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.
* '''<battle_move>''': <code>animation.<pokemon>.<battle_move_name></code> - The animation that plays when a pokemon uses a specific move in battle. This animation property would assign a pokemon's animation to an '''existing''' action effect. Something like a custom flamethrower animation for Charizard or a Pokémon's signature move for example.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.


==== Basic Animation Calling Functions ====
Below are the 3 methods to call a <code>Pose</code> or <code>namedAnimation</code> animation. Each of them serve a purpose in layering animations on the Pokémon. <code>Pose</code> animations must always use <code>q.bedrock()</code> to serve as the base animation that can be overwritten by other animations when called. <code>NamedAnimations</code> can either use <code>q.bedrock_stateful()</code> to layer over the base animation or use <code>q.bedrock_primary()</code> to overwrite the base animation while it is playing. The default function used in each named animation type can be changed if your animation supports it. If you want the cry to overwrite rather than layer, then just be sure to animate it properly.


===== q.bedrock =====
The <code>q.bedrock()</code> function is the familiar animation calling format from the [[Old_Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},


===== q.bedrock_stateful =====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


===== q.bedrock_primary =====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


<code>q.bedrock_primary</code> comes with a couple of extra properties and they should be written in the following order:
# group: <code>'blastoise'</code> - The animation JSON that the game will search for the following animation. This should always be the name of a Pokémon.
# animation: <code>'status'</code> - The animation the game will call from the previously mentioned animation JSON. Primary animations are usually your attack animations or faints, but you can assign it to other named animations if desired.
# (optional) excluded labels: <code>'look'</code> - Exclusive labeled animations that wont get overwritten by this primary animation. The only reasonable use of excluded labels is to exclude the look animation from being overwritten. This is so they can keep looking at a target when using an animation.
# curve: <code>'q.curve('symmetrical_wide')'</code> - The interpolation curve that this primary animation will use to transition to and from the pose it is written under.


Since Primary animations behave in a similar way to swapping poses, they can use special interpolation curve types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 common primary animations in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', 'look', q.curve('symmetrical_wide'))"


====== q.curve ======
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",


===== q.array, q.random, and math.random =====
Whenever one of the previously mentioned functions calls the parameter for the animation type, such as <code>'faint'</code>, in the function, you can substitute the value with another function that can call one of multiple animations instead. These 3 functions can help create the illusion of randomized animations if you have enough animations to support the pose, named animation, or quirk.


* '''q.array()''' - This function selects one of the listed animation types when the function is called. Commonly used to create a pool of quirk animations where each option has equal weights.
** The following example allows Porygon-z to use one of 6 different twitch animations every 1-10 seconds as a quirk.
"q.bedrock_quirk('porygon-z', '''q.array('twitch1', 'twitch2', 'twitch3', 'twitch4', 'twitch5', 'twitch6')''', 1, 10, 1)"


* '''q.random()''' - This function selects one of the listed animation types when resources are loaded. This means the animation would be selected on game start or on an asset refresh when using F3+T as observed through testing. This seems to be a bug according to devs.
** The following example limits Porygon-z to using one of two different twitch animations every 1-10 seconds as a quirk until assets are refreshed.
"q.bedrock_quirk('porygon-z', '''q.random('twitch1', 'twitch2')''', 1, 10, 1)"


* '''math.random(0, 1) < ? : ''' - You can combine the math.random function with a trinary conditional operator(the ? and : bits) to have the game roll a number and determine what animation or set of animations to play. This option is great for when you want an animation to have a weighted chance to play. You can also add another math.random function or a q.random function as one of the options to keep stacking the odds and options if you wanted a set of common, uncommon, and rare animations in one scenario. You need a minimum of 2 animations to use this function properly, and you can theoretically have it call as many animations as you want. You probably shouldn't. An example is provided below with the underlined sections detailing what each value is doing.
"faint": "q.bedrock_primary('porygon-z', '''<abbr title="The molang function being called">math.random</abbr>(<abbr title="Part of the math.random function. Here you are setting a range of numbers for the game to roll between. You are telling the game to pick a number between 0 and 1, including all the decimals in between">0, 1</abbr>) <abbr title="This section here is basically saying if the rolled number is less than 0.1, then play the faint2 animation. This is effectively a 10% chance!">< 0.1 ? 'faint2'</abbr> <abbr title="This section is saying if the rolled value is greater than 0.1, then play the faint animation. This is effectively a 90% chance!">: 'faint'</abbr>''', q.curve('one'))"



=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting.


There are two methods for conditions that you can use. There is the old true or false conditions where each condition has a property named after it and then there is the new Molang conditions. Molang conditions can use one or more molang functions to have the game check certain properties of the pokemon like what stats it has or even what it is standing on. A list of Cobblemon's custom molang functions can be found [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/api/molang/MoLangFunctions.kt here with some usable functions highlighted in red.] Due to the complexity of molang and it being so new to cobblemon, it's difficult to explain its potentially unlimited possibilities. There will be many examples to borrow from in the future. You can even use Molang's operators to extend your string if needed.


How to write a Molang condition:
* <code>"condition": "<insert molang function(s)>"</code>
** One of the few examples:
<code>"condition": "<abbr title="The function being called which checks for the blocks the Pokémon is standing on.">q.is_standing_on_blocks</abbr>(<abbr title="The depth required in order to be met. Meaning it must be standing above 2 blocks of sand or red sand.">2</abbr>, <abbr title="One of the blocks this function is checking for. The animation will play if it is standing above 2 blocks of sand">'minecraft:sand'</abbr>, <abbr title="One of the blocks this function is checking for. The animation will play if it is standing above 2 blocks of red sand">'minecraft:red_sand'</abbr>)"</code>

Below is an example inside of Lunatone's poser where it uses molang conditions to assign its 2 different sleeping animations: one where it checks for sand so it can lodge itself in the sand, and the other where it floats while it sleeps. By using the <code>!</code> operator in front of the second pose's molang condition, the game makes sure that the conditions are false in order to play the animation.
"sand-sleep": {
"poseTypes": ["SLEEP"],
"condition": "q.is_standing_on_blocks(2, 'minecraft:sand', 'minecraft:red_sand')",
"namedAnimations": {
"cry": "q.bedrock_stateful('dummy', 'cry')"
},
"animations": ["q.bedrock('lunatone', 'sleep')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"condition": "!q.is_standing_on_blocks(2, 'minecraft:sand', 'minecraft:red_sand')",
"namedAnimations": {
"cry": "q.bedrock_stateful('dummy', 'cry')"
},
"animations": ["q.bedrock('lunatone', 'sleep_alt')"]
}


List of Currently Implemented True or False Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isInWaterOrRain"</code>: The Pokémon must be touching water or in rain. Again, not necessarily underwater.
* <code>"isUnderWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},



=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are typically stateful animations that you can have play over the main animation for a pose. The new poser format introduced primary quirk animations and a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.


==== Stateful Quirks ====
Stateful quirks are animations that will be layered on top of the idle animation currently playing.


The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

===== q.array =====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


==== Primary Quirks ====
Primary quirks are animations that will play over the idle animation for its entire animation length. Primary quirk animations can control the entire model during its duration so you can have the Pokémon do full flips or something and then interpolate back into the idle pose using a q.curve function.


The properties of <code>q.bedrock_primary_quirk</code> must be in the following order:
# Animation Group: <code>'porygon2'</code> - the name of the Pokémon
# Animation Name(s): <code>'idle_quirk'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>40</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk
# (optional) excluded labels: <code>'look'</code> - Exclusive labeled animations that wont get overwritten by this primary animation. The only reasonable use of excluded labels is to exclude the look animation from being overwritten. This is so they can keep looking at a target when using an animation.
# Curve: <code>q.curve('symmetrical')</code> - The type of curved sin wave used to transition back into the idle animation of the pose.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_primary_quirk('porygon2', q.array('idle_quirk', 'idle_quirk2'), 20, 40, 1, q.curve('symmetrical'))"
]

This example allows porygon2 to use one of 2 quirks as a primary animation. It will either flip or spin before transitioning back into its idle animation.



=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each placeholder features a very simple animation that swings a limb back and forth.


Below is a list of current placeholder animations, their default values, and an example you can copy into your animations list directly:
* '''q.quadruped_walk''' - A basic walk animation for Pokémon with 4 legs.
<code>"q.quadruped_walk(0.66, 1.4, 'leg_front_left', 'leg_front_right', 'leg_back_left', 'leg_back_right')"</code>


* '''q.biped_walk''' - A basic walking animation for Pokémon who stand on 2 legs.
<code>"q.biped_walk(0.66, 1.4, 'leg_left', 'leg_right')"</code>


* '''q.bimanual_swing''' - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
<code>"q.bimanual_swing(0.66, 1.4, 'arm_left', 'arm_right')"</code>


* '''q.sine_wing_flap''' - A basic wing flap animation for a pair of wings on a Pokémon. This animation allows you to control a few more aspects of the specified bones. It's important to note what axis these "wings" should be rotating in to give the illusion of flapping. So be sure to reference your model.
<code>"q.sine_wing_flap(<abbr title="Multiplier for the amplitude value. How far the wings will flap">0.9</abbr>, <abbr title="Multiplier for the period value. How fast the wings will flap">0.9</abbr>, <abbr title="Vertical shift value. Radian value that the wing pair will be offset by.">25</abbr>, <abbr title="The x, y, or z axis of the bone that shall be rotated by this animation.">'z'</abbr>, <abbr title="The left wing to be animated">'wing_left'</abbr>, <abbr title="The right wing to be animated">'wing_right'</abbr>)"</code>


With the exception of the wing flap placeholder, the first value mentioned in these functions controls how fast the limbs will swing, also called the period value. The second value is the amplitude, or how far a limb will swing. These are both multiplier values to a cosine wave that the author of this post can't seem to find at this moment. Be sure to tune these values if the limbs don't work with the defaults.



== Poser File Breakdown ==
Soon™


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that not all Pokémon have a bone called <code>head</code>.

Here is an example of a poser file for a custom <code>riolu</code> that includes all currently implemented poses and their appropriate animations.
* Riolu obviously can't fly. This is just an example as no Pokémon can do everything currently.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 1,
"portraitTranslation": [0, 0, 0],
"profileScale": 1,
"profileTranslation": [0, 0, 0],
"animations": {
"faint": "q.bedrock_primary('riolu', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('riolu', 'cry')",
"recoil": "q.bedrock_stateful('riolu', 'recoil')",
"physical": "q.bedrock_primary('riolu', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('riolu', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('riolu', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'battle_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('riolu', 'blink')"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"hover": {
"poseTypes": ["HOVER"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"fly": {
"poseTypes": ["FLY"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_fly')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('riolu', 'sleep')"]
},
"shoulder_left": {
"poseTypes": ["SHOULDER_LEFT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_left')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"shoulder_right": {
"poseTypes": ["SHOULDER_RIGHT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_right')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
}
}
}

{{Addon Creation}}

Poser

2025-03-06T12:16:08Z

Frank The Farmer: Slight formatting again

{{TOC|right}}
== Preface ==
The <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]


== Poser Properties ==
Before breaking down each section of the Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!


=== Rootbone ===
The <code>rootBone</code> property specifies what bone in the model will act as the root bone for generic animations not assigned in the poser such as the evolution animation. If the model was made following the standard bone format, then it should simply be the name of the Pokémon in lower case. Punctuation and capitalization matter! So make sure it matches the root bone of your model exactly.

You are '''required''' to assign this root bone properly or else it will break the model in certain generic animations! These animations animate the root bone and do not reset it to its original position when it finishes. This can cause model displacement after evolutions.

Below is a breakdown of the simple rootBone property:
"<abbr title="This property attempts to call the specified bone from the model to assign it as the root bone for generic animations.">rootBone</abbr>": "<abbr title="In this scenario, the charizard bone is being called. This charizard bone should contain all other bones so generic animations can move the entire model for whatever they animate.">charizard</abbr>",


=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a negative Z value that is some multiple of 5.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon.

For the sake of clarity, you should always refer to animations like faints, cries, or physicals as '''Named Animations'''. This is to help everyone distinguish them from the animations that are applied to poses. This distinction is important because you can assign both <code>animations</code> and <code>namedAnimations</code> to a pose. This is to allow you to assign different cries, faints, or attack animations to different poses like your floating or flying poses. This allows for water attack animations if you make the animation to support it. This process will be detailed later. Below is a list of currently available Named Animation types and Poses to choose from. 

==== Animations & Named Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.
* '''<battle_move>''': <code>animation.<pokemon>.<battle_move_name></code> - The animation that plays when a pokemon uses a specific move in battle. This animation property would assign a pokemon's animation to an '''existing''' action effect. Something like a custom flamethrower animation for Charizard or a Pokémon's signature move for example.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.


==== Basic Animation Calling Functions ====
Below are the 3 methods to call a <code>Pose</code> or <code>namedAnimation</code> animation. Each of them serve a purpose in layering animations on the Pokémon. <code>Pose</code> animations must always use <code>q.bedrock()</code> to serve as the base animation that can be overwritten by other animations when called. <code>NamedAnimations</code> can either use <code>q.bedrock_stateful()</code> to layer over the base animation or use <code>q.bedrock_primary()</code> to overwrite the base animation while it is playing. The default function used in each named animation type can be changed if your animation supports it. If you want the cry to overwrite rather than layer, then just be sure to animate it properly.


===== q.bedrock =====
The <code>q.bedrock()</code> function is the familiar animation calling format from the [[Old_Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},


===== q.bedrock_stateful =====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


===== q.bedrock_primary =====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


<code>q.bedrock_primary</code> comes with a couple of extra properties and they should be written in the following order:
# group: <code>'blastoise'</code> - The animation JSON that the game will search for the following animation. This should always be the name of a Pokémon.
# animation: <code>'status'</code> - The animation the game will call from the previously mentioned animation JSON. Primary animations are usually your attack animations or faints, but you can assign it to other named animations if desired.
# (optional) excluded labels: <code>'look'</code> - Exclusive labeled animations that wont get overwritten by this primary animation. The only reasonable use of excluded labels is to exclude the look animation from being overwritten. This is so they can keep looking at a target when using an animation.
# curve: <code>'q.curve('symmetrical_wide')'</code> - The interpolation curve that this primary animation will use to transition to and from the pose it is written under.


Since Primary animations behave in a similar way to swapping poses, they can use special interpolation curve types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 common primary animations in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', 'look', q.curve('symmetrical_wide'))"


====== q.curve ======
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",


===== q.array, q.random, and math.random =====
Whenever one of the previously mentioned functions calls the parameter for the animation type, such as <code>'faint'</code>, in the function, you can substitute the value with another function that can call one of multiple animations instead. These 3 functions can help create the illusion of randomized animations if you have enough animations to support the pose, named animation, or quirk.


* '''q.array()''' - This function selects one of the listed animation types when the function is called. Commonly used to create a pool of quirk animations where each option has equal weights.
** The following example allows Porygon-z to use one of 6 different twitch animations every 1-10 seconds as a quirk.
"q.bedrock_quirk('porygon-z', '''q.array('twitch1', 'twitch2', 'twitch3', 'twitch4', 'twitch5', 'twitch6')''', 1, 10, 1)"


* '''q.random()''' - This function selects one of the listed animation types when resources are loaded. This means the animation would be selected on game start or on an asset refresh when using F3+T as observed through testing. This seems to be a bug according to devs.
** The following example limits Porygon-z to using one of two different twitch animations every 1-10 seconds as a quirk until assets are refreshed.
"q.bedrock_quirk('porygon-z', '''q.random('twitch1', 'twitch2')''', 1, 10, 1)"


* '''math.random(0, 1) < ? : ''' - You can combine the math.random function with a trinary conditional operator(the ? and : bits) to have the game roll a number and determine what animation or set of animations to play. This option is great for when you want an animation to have a weighted chance to play. You can also add another math.random function or a q.random function as one of the options to keep stacking the odds and options if you wanted a set of common, uncommon, and rare animations in one scenario. You need a minimum of 2 animations to use this function properly, and you can theoretically have it call as many animations as you want. You probably shouldn't. An example is provided below with the underlined sections detailing what each value is doing.
"faint": "q.bedrock_primary('porygon-z', '''<abbr title="The molang function being called">math.random</abbr>(<abbr title="Part of the math.random function. Here you are setting a range of numbers for the game to roll between. You are telling the game to pick a number between 0 and 1, including all the decimals in between">0, 1</abbr>) <abbr title="This section here is basically saying if the rolled number is less than 0.1, then play the faint2 animation. This is effectively a 10% chance!">< 0.1 ? 'faint2'</abbr> <abbr title="This section is saying if the rolled value is greater than 0.1, then play the faint animation. This is effectively a 90% chance!">: 'faint'</abbr>''', q.curve('one'))"



=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting.


There are two methods for conditions that you can use. There is the old true or false conditions where each condition has a property named after it and then there is the new Molang conditions. Molang conditions can use one or more molang functions to have the game check certain properties of the pokemon like what stats it has or even what it is standing on. A list of Cobblemon's custom molang functions can be found [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/api/molang/MoLangFunctions.kt here with some usable functions highlighted in red.] Due to the complexity of molang and it being so new to cobblemon, it's difficult to explain its potentially unlimited possibilities. There will be many examples to borrow from in the future. You can even use Molang's operators to extend your string if needed.


How to write a Molang condition:
* <code>"condition": "<insert molang function(s)>"</code>
** One of the few examples:
<code>"condition": "<abbr title="The function being called which checks for the blocks the Pokémon is standing on.">q.is_standing_on_blocks</abbr>(<abbr title="The depth required in order to be met. Meaning it must be standing above 2 blocks of sand or red sand.">2</abbr>, <abbr title="One of the blocks this function is checking for. The animation will play if it is standing above 2 blocks of sand">'minecraft:sand'</abbr>, <abbr title="One of the blocks this function is checking for. The animation will play if it is standing above 2 blocks of red sand">'minecraft:red_sand'</abbr>)"</code>

Below is an example inside of Lunatone's poser where it uses molang conditions to assign its 2 different sleeping animations: one where it checks for sand so it can lodge itself in the sand, and the other where it floats while it sleeps. By using the <code>!</code> operator in front of the second pose's molang condition, the game makes sure that the conditions are false in order to play the animation.
"sand-sleep": {
"poseTypes": ["SLEEP"],
"condition": "q.is_standing_on_blocks(2, 'minecraft:sand', 'minecraft:red_sand')",
"namedAnimations": {
"cry": "q.bedrock_stateful('dummy', 'cry')"
},
"animations": ["q.bedrock('lunatone', 'sleep')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"condition": "!q.is_standing_on_blocks(2, 'minecraft:sand', 'minecraft:red_sand')",
"namedAnimations": {
"cry": "q.bedrock_stateful('dummy', 'cry')"
},
"animations": ["q.bedrock('lunatone', 'sleep_alt')"]
}


List of Currently Implemented True or False Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isInWaterOrRain"</code>: The Pokémon must be touching water or in rain. Again, not necessarily underwater.
* <code>"isUnderWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},



=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each placeholder features a very simple animation that swings a limb back and forth.


Below is a list of current placeholder animations, their default values, and an example you can copy into your animations list directly:
* '''q.quadruped_walk''' - A basic walk animation for Pokémon with 4 legs.
<code>"q.quadruped_walk(0.66, 1.4, 'leg_front_left', 'leg_front_right', 'leg_back_left', 'leg_back_right')"</code>


* '''q.biped_walk''' - A basic walking animation for Pokémon who stand on 2 legs.
<code>"q.biped_walk(0.66, 1.4, 'leg_left', 'leg_right')"</code>


* '''q.bimanual_swing''' - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
<code>"q.bimanual_swing(0.66, 1.4, 'arm_left', 'arm_right')"</code>


* '''q.sine_wing_flap''' - A basic wing flap animation for a pair of wings on a Pokémon. This animation allows you to control a few more aspects of the specified bones. It's important to note what axis these "wings" should be rotating in to give the illusion of flapping. So be sure to reference your model.
<code>"q.sine_wing_flap(<abbr title="Multiplier for the amplitude value. How far the wings will flap">0.9</abbr>, <abbr title="Multiplier for the period value. How fast the wings will flap">0.9</abbr>, <abbr title="Vertical shift value. Radian value that the wing pair will be offset by.">25</abbr>, <abbr title="The x, y, or z axis of the bone that shall be rotated by this animation.">'z'</abbr>, <abbr title="The left wing to be animated">'wing_left'</abbr>, <abbr title="The right wing to be animated">'wing_right'</abbr>)"</code>


With the exception of the wing flap placeholder, the first value mentioned in these functions controls how fast the limbs will swing, also called the period value. The second value is the amplitude, or how far a limb will swing. These are both multiplier values to a cosine wave that the author of this post can't seem to find at this moment. Be sure to tune these values if the limbs don't work with the defaults.



== Poser File Breakdown ==
Soon™


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that not all Pokémon have a bone called <code>head</code>.

Here is an example of a poser file for a custom <code>riolu</code> that includes all currently implemented poses and their appropriate animations.
* Riolu obviously can't fly. This is just an example as no Pokémon can do everything currently.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 1,
"portraitTranslation": [0, 0, 0],
"profileScale": 1,
"profileTranslation": [0, 0, 0],
"animations": {
"faint": "q.bedrock_primary('riolu', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('riolu', 'cry')",
"recoil": "q.bedrock_stateful('riolu', 'recoil')",
"physical": "q.bedrock_primary('riolu', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('riolu', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('riolu', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'battle_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('riolu', 'blink')"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"hover": {
"poseTypes": ["HOVER"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"fly": {
"poseTypes": ["FLY"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_fly')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('riolu', 'sleep')"]
},
"shoulder_left": {
"poseTypes": ["SHOULDER_LEFT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_left')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"shoulder_right": {
"poseTypes": ["SHOULDER_RIGHT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_right')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
}
}
}

{{Addon Creation}}

Poser

2025-03-06T12:14:35Z

Frank The Farmer: Included some new functions for calling animations

{{TOC|right}}
== Preface ==
The <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]


== Poser Properties ==
Before breaking down each section of the Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!


=== Rootbone ===
The <code>rootBone</code> property specifies what bone in the model will act as the root bone for generic animations not assigned in the poser such as the evolution animation. If the model was made following the standard bone format, then it should simply be the name of the Pokémon in lower case. Punctuation and capitalization matter! So make sure it matches the root bone of your model exactly.

You are '''required''' to assign this root bone properly or else it will break the model in certain generic animations! These animations animate the root bone and do not reset it to its original position when it finishes. This can cause model displacement after evolutions.

Below is a breakdown of the simple rootBone property:
"<abbr title="This property attempts to call the specified bone from the model to assign it as the root bone for generic animations.">rootBone</abbr>": "<abbr title="In this scenario, the charizard bone is being called. This charizard bone should contain all other bones so generic animations can move the entire model for whatever they animate.">charizard</abbr>",


=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a negative Z value that is some multiple of 5.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon.

For the sake of clarity, you should always refer to animations like faints, cries, or physicals as '''Named Animations'''. This is to help everyone distinguish them from the animations that are applied to poses. This distinction is important because you can assign both <code>animations</code> and <code>namedAnimations</code> to a pose. This is to allow you to assign different cries, faints, or attack animations to different poses like your floating or flying poses. This allows for water attack animations if you make the animation to support it. This process will be detailed later. Below is a list of currently available Named Animation types and Poses to choose from. 

==== Animations & Named Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.
* '''<battle_move>''': <code>animation.<pokemon>.<battle_move_name></code> - The animation that plays when a pokemon uses a specific move in battle. This animation property would assign a pokemon's animation to an '''existing''' action effect. Something like a custom flamethrower animation for Charizard or a Pokémon's signature move for example.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.


==== Basic Animation Calling Functions ====
Below are the 3 methods to call a <code>Pose</code> or <code>namedAnimation</code> animation. Each of them serve a purpose in layering animations on the Pokémon. <code>Pose</code> animations must always use <code>q.bedrock()</code> to serve as the base animation that can be overwritten by other animations when called. <code>NamedAnimations</code> can either use <code>q.bedrock_stateful()</code> to layer over the base animation or use <code>q.bedrock_primary()</code> to overwrite the base animation while it is playing. The default function used in each named animation type can be changed if your animation supports it. If you want the cry to overwrite rather than layer, then just be sure to animate it properly.


===== q.bedrock =====
The <code>q.bedrock()</code> function is the familiar animation calling format from the [[Old_Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},


===== q.bedrock_stateful =====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


===== q.bedrock_primary =====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


<code>q.bedrock_primary</code> comes with a couple of extra properties and they should be written in the following order:
# group: <code>'blastoise'</code> - The animation JSON that the game will search for the following animation. This should always be the name of a Pokémon.
# animation: <code>'status'</code> - The animation the game will call from the previously mentioned animation JSON. Primary animations are usually your attack animations or faints, but you can assign it to other named animations if desired.
# (optional) excluded labels: <code>'look'</code> - Exclusive labeled animations that wont get overwritten by this primary animation. The only reasonable use of excluded labels is to exclude the look animation from being overwritten. This is so they can keep looking at a target when using an animation.
# curve: <code>'q.curve('symmetrical_wide')'</code> - The interpolation curve that this primary animation will use to transition to and from the pose it is written under.


Since Primary animations behave in a similar way to swapping poses, they can use special interpolation curve types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 common primary animations in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', 'look', q.curve('symmetrical_wide'))"


====== q.curve ======
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",


====== q.array, q.random, and math.random ======
Whenever one of the previously mentioned functions calls the parameter for the animation type, such as <code>'faint'</code>, in the function, you can substitute the value with another function that can call one of multiple animations instead. These 3 functions can help create the illusion of randomized animations if you have enough animations to support the pose, named animation, or quirk.


* '''q.array()''' - This function selects one of the listed animation types when the function is called. Commonly used to create a pool of quirk animations where each option has equal weights.
** The following example allows Porygon-z to use one of 6 different twitch animations every 1-10 seconds as a quirk.
"q.bedrock_quirk('porygon-z', '''q.array('twitch1', 'twitch2', 'twitch3', 'twitch4', 'twitch5', 'twitch6')''', 1, 10, 1)"


* '''q.random()''' - This function selects one of the listed animation types when resources are loaded. This means the animation would be selected on game start or on an asset refresh when using F3+T as observed through testing. This seems to be a bug according to devs.
** The following example limits Porygon-z to using one of two different twitch animations every 1-10 seconds as a quirk until assets are refreshed.
"q.bedrock_quirk('porygon-z', '''q.random('twitch1', 'twitch2')''', 1, 10, 1)"


* '''math.random(0, 1) < ? : ''' - You can combine the math.random function with a trinary conditional operator(the ? and : bits) to have the game roll a number and determine what animation or set of animations to play. This option is great for when you want an animation to have a weighted chance to play. You can also add another math.random function or a q.random function as one of the options to keep stacking the odds and options if you wanted a set of common, uncommon, and rare animations in one scenario. You need a minimum of 2 animations to use this function properly, and you can theoretically have it call as many animations as you want. You probably shouldn't. An example is provided below with the underlined sections detailing what each value is doing.
"faint": "q.bedrock_primary('porygon-z', '''<abbr title="The molang function being called">math.random</abbr>(<abbr title="Part of the math.random function. Here you are setting a range of numbers for the game to roll between. You are telling the game to pick a number between 0 and 1, including all the decimals in between">0, 1</abbr>) <abbr title="This section here is basically saying if the rolled number is less than 0.1, then play the faint2 animation. This is effectively a 10% chance!">< 0.1 ? 'faint2'</abbr> <abbr title="This section is saying if the rolled value is greater than 0.1, then play the faint animation. This is effectively a 90% chance!">: 'faint'</abbr>''', q.curve('one'))"



=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting.


There are two methods for conditions that you can use. There is the old true or false conditions where each condition has a property named after it and then there is the new Molang conditions. Molang conditions can use one or more molang functions to have the game check certain properties of the pokemon like what stats it has or even what it is standing on. A list of Cobblemon's custom molang functions can be found [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/api/molang/MoLangFunctions.kt here with some usable functions highlighted in red.] Due to the complexity of molang and it being so new to cobblemon, it's difficult to explain its potentially unlimited possibilities. There will be many examples to borrow from in the future. You can even use Molang's operators to extend your string if needed.


How to write a Molang condition:
* <code>"condition": "<insert molang function(s)>"</code>
** One of the few examples:
<code>"condition": "<abbr title="The function being called which checks for the blocks the Pokémon is standing on.">q.is_standing_on_blocks</abbr>(<abbr title="The depth required in order to be met. Meaning it must be standing above 2 blocks of sand or red sand.">2</abbr>, <abbr title="One of the blocks this function is checking for. The animation will play if it is standing above 2 blocks of sand">'minecraft:sand'</abbr>, <abbr title="One of the blocks this function is checking for. The animation will play if it is standing above 2 blocks of red sand">'minecraft:red_sand'</abbr>)"</code>

Below is an example inside of Lunatone's poser where it uses molang conditions to assign its 2 different sleeping animations: one where it checks for sand so it can lodge itself in the sand, and the other where it floats while it sleeps. By using the <code>!</code> operator in front of the second pose's molang condition, the game makes sure that the conditions are false in order to play the animation.
"sand-sleep": {
"poseTypes": ["SLEEP"],
"condition": "q.is_standing_on_blocks(2, 'minecraft:sand', 'minecraft:red_sand')",
"namedAnimations": {
"cry": "q.bedrock_stateful('dummy', 'cry')"
},
"animations": ["q.bedrock('lunatone', 'sleep')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"condition": "!q.is_standing_on_blocks(2, 'minecraft:sand', 'minecraft:red_sand')",
"namedAnimations": {
"cry": "q.bedrock_stateful('dummy', 'cry')"
},
"animations": ["q.bedrock('lunatone', 'sleep_alt')"]
}


List of Currently Implemented True or False Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isInWaterOrRain"</code>: The Pokémon must be touching water or in rain. Again, not necessarily underwater.
* <code>"isUnderWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},



=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each placeholder features a very simple animation that swings a limb back and forth.


Below is a list of current placeholder animations, their default values, and an example you can copy into your animations list directly:
* '''q.quadruped_walk''' - A basic walk animation for Pokémon with 4 legs.
<code>"q.quadruped_walk(0.66, 1.4, 'leg_front_left', 'leg_front_right', 'leg_back_left', 'leg_back_right')"</code>


* '''q.biped_walk''' - A basic walking animation for Pokémon who stand on 2 legs.
<code>"q.biped_walk(0.66, 1.4, 'leg_left', 'leg_right')"</code>


* '''q.bimanual_swing''' - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
<code>"q.bimanual_swing(0.66, 1.4, 'arm_left', 'arm_right')"</code>


* '''q.sine_wing_flap''' - A basic wing flap animation for a pair of wings on a Pokémon. This animation allows you to control a few more aspects of the specified bones. It's important to note what axis these "wings" should be rotating in to give the illusion of flapping. So be sure to reference your model.
<code>"q.sine_wing_flap(<abbr title="Multiplier for the amplitude value. How far the wings will flap">0.9</abbr>, <abbr title="Multiplier for the period value. How fast the wings will flap">0.9</abbr>, <abbr title="Vertical shift value. Radian value that the wing pair will be offset by.">25</abbr>, <abbr title="The x, y, or z axis of the bone that shall be rotated by this animation.">'z'</abbr>, <abbr title="The left wing to be animated">'wing_left'</abbr>, <abbr title="The right wing to be animated">'wing_right'</abbr>)"</code>


With the exception of the wing flap placeholder, the first value mentioned in these functions controls how fast the limbs will swing, also called the period value. The second value is the amplitude, or how far a limb will swing. These are both multiplier values to a cosine wave that the author of this post can't seem to find at this moment. Be sure to tune these values if the limbs don't work with the defaults.



== Poser File Breakdown ==
Soon™


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that not all Pokémon have a bone called <code>head</code>.

Here is an example of a poser file for a custom <code>riolu</code> that includes all currently implemented poses and their appropriate animations.
* Riolu obviously can't fly. This is just an example as no Pokémon can do everything currently.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 1,
"portraitTranslation": [0, 0, 0],
"profileScale": 1,
"profileTranslation": [0, 0, 0],
"animations": {
"faint": "q.bedrock_primary('riolu', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('riolu', 'cry')",
"recoil": "q.bedrock_stateful('riolu', 'recoil')",
"physical": "q.bedrock_primary('riolu', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('riolu', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('riolu', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'battle_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('riolu', 'blink')"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"hover": {
"poseTypes": ["HOVER"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"fly": {
"poseTypes": ["FLY"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_fly')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('riolu', 'sleep')"]
},
"shoulder_left": {
"poseTypes": ["SHOULDER_LEFT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_left')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"shoulder_right": {
"poseTypes": ["SHOULDER_RIGHT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_right')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
}
}
}

{{Addon Creation}}

Poser

2025-03-06T11:16:47Z

Frank The Farmer: Slight formatting

{{TOC|right}}
== Preface ==
The <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]


== Poser Properties ==
Before breaking down each section of the Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!


=== Rootbone ===
The <code>rootBone</code> property specifies what bone in the model will act as the root bone for generic animations not assigned in the poser such as the evolution animation. If the model was made following the standard bone format, then it should simply be the name of the Pokémon in lower case. Punctuation and capitalization matter! So make sure it matches the root bone of your model exactly.

You are '''required''' to assign this root bone properly or else it will break the model in certain generic animations! These animations animate the root bone and do not reset it to its original position when it finishes. This can cause model displacement after evolutions.

Below is a breakdown of the simple rootBone property:
"<abbr title="This property attempts to call the specified bone from the model to assign it as the root bone for generic animations.">rootBone</abbr>": "<abbr title="In this scenario, the charizard bone is being called. This charizard bone should contain all other bones so generic animations can move the entire model for whatever they animate.">charizard</abbr>",


=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a negative Z value that is some multiple of 5.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon.

For the sake of clarity, you should always refer to animations like faints, cries, or physicals as '''Named Animations'''. This is to help everyone distinguish them from the animations that are applied to poses. This distinction is important because you can assign both <code>animations</code> and <code>namedAnimations</code> to a pose. This is to allow you to assign different cries, faints, or attack animations to different poses like your floating or flying poses. This allows for water attack animations if you make the animation to support it. This process will be detailed later. Below is a list of currently available Named Animation types and Poses to choose from. 

==== Animations & Named Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.
* '''<battle_move>''': <code>animation.<pokemon>.<battle_move_name></code> - The animation that plays when a pokemon uses a specific move in battle. This animation property would assign a pokemon's animation to an '''existing''' action effect. Something like a custom flamethrower animation for Charizard or a Pokémon's signature move for example.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.


==== Basic Animation Calling Functions ====
Below are the 3 methods to call a <code>Pose</code> or <code>namedAnimation</code> animation. Each of them serve a purpose in layering animations on the Pokémon. <code>Pose</code> animations must always use <code>q.bedrock()</code> to serve as the base animation that can be overwritten by other animations when called. <code>NamedAnimations</code> can either use <code>q.bedrock_stateful()</code> to layer over the base animation or use <code>q.bedrock_primary()</code> to overwrite the base animation while it is playing. The default function used in each named animation type can be changed if your animation supports it. If you want the cry to overwrite rather than layer, then just be sure to animate it properly.


===== q.bedrock =====
The <code>q.bedrock()</code> function is the familiar animation calling format from the [[Old_Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},


===== q.bedrock_stateful =====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


===== q.bedrock_primary =====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


<code>q.bedrock_primary</code> comes with a couple of extra properties and they should be written in the following order:
# group: <code>'blastoise'</code> - The animation JSON that the game will search for the following animation. This should always be the name of a Pokémon.
# animation: <code>'status'</code> - The animation the game will call from the previously mentioned animation JSON. Primary animations are usually your attack animations or faints, but you can assign it to other named animations if desired.
# (optional) excluded labels: <code>'look'</code> - Exclusive labeled animations that wont get overwritten by this primary animation. The only reasonable use of excluded labels is to exclude the look animation from being overwritten. This is so they can keep looking at a target when using an animation.
# curve: <code>'q.curve('symmetrical_wide')'</code> - The interpolation curve that this primary animation will use to transition to and from the pose it is written under.


Since Primary animations behave in a similar way to swapping poses, they can use special interpolation curve types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 common primary animations in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', 'look', q.curve('symmetrical_wide'))"


====== q.curve ======
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",


=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting.


There are two methods for conditions that you can use. There is the old true or false conditions where each condition has a property named after it and then there is the new Molang conditions. Molang conditions can use one or more molang functions to have the game check certain properties of the pokemon like what stats it has or even what it is standing on. A list of Cobblemon's custom molang functions can be found [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/api/molang/MoLangFunctions.kt here with some usable functions highlighted in red.] Due to the complexity of molang and it being so new to cobblemon, it's difficult to explain its potentially unlimited possibilities. There will be many examples to borrow from in the future. You can even use Molang's operators to extend your string if needed.


How to write a Molang condition:
* <code>"condition": "<insert molang function(s)>"</code>
** One of the few examples:
<code>"condition": "<abbr title="The function being called which checks for the blocks the Pokémon is standing on.">q.is_standing_on_blocks</abbr>(<abbr title="The depth required in order to be met. Meaning it must be standing above 2 blocks of sand or red sand.">2</abbr>, <abbr title="One of the blocks this function is checking for. The animation will play if it is standing above 2 blocks of sand">'minecraft:sand'</abbr>, <abbr title="One of the blocks this function is checking for. The animation will play if it is standing above 2 blocks of red sand">'minecraft:red_sand'</abbr>)"</code>

Below is an example inside of Lunatone's poser where it uses molang conditions to assign its 2 different sleeping animations: one where it checks for sand so it can lodge itself in the sand, and the other where it floats while it sleeps. By using the <code>!</code> operator in front of the second pose's molang condition, the game makes sure that the conditions are false in order to play the animation.
"sand-sleep": {
"poseTypes": ["SLEEP"],
"condition": "q.is_standing_on_blocks(2, 'minecraft:sand', 'minecraft:red_sand')",
"namedAnimations": {
"cry": "q.bedrock_stateful('dummy', 'cry')"
},
"animations": ["q.bedrock('lunatone', 'sleep')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"condition": "!q.is_standing_on_blocks(2, 'minecraft:sand', 'minecraft:red_sand')",
"namedAnimations": {
"cry": "q.bedrock_stateful('dummy', 'cry')"
},
"animations": ["q.bedrock('lunatone', 'sleep_alt')"]
}


List of Currently Implemented True or False Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isInWaterOrRain"</code>: The Pokémon must be touching water or in rain. Again, not necessarily underwater.
* <code>"isUnderWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},



=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each placeholder features a very simple animation that swings a limb back and forth.


Below is a list of current placeholder animations, their default values, and an example you can copy into your animations list directly:
* '''q.quadruped_walk''' - A basic walk animation for Pokémon with 4 legs.
<code>"q.quadruped_walk(0.66, 1.4, 'leg_front_left', 'leg_front_right', 'leg_back_left', 'leg_back_right')"</code>


* '''q.biped_walk''' - A basic walking animation for Pokémon who stand on 2 legs.
<code>"q.biped_walk(0.66, 1.4, 'leg_left', 'leg_right')"</code>


* '''q.bimanual_swing''' - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
<code>"q.bimanual_swing(0.66, 1.4, 'arm_left', 'arm_right')"</code>


* '''q.sine_wing_flap''' - A basic wing flap animation for a pair of wings on a Pokémon. This animation allows you to control a few more aspects of the specified bones. It's important to note what axis these "wings" should be rotating in to give the illusion of flapping. So be sure to reference your model.
<code>"q.sine_wing_flap(<abbr title="Multiplier for the amplitude value. How far the wings will flap">0.9</abbr>, <abbr title="Multiplier for the period value. How fast the wings will flap">0.9</abbr>, <abbr title="Vertical shift value. Radian value that the wing pair will be offset by.">25</abbr>, <abbr title="The x, y, or z axis of the bone that shall be rotated by this animation.">'z'</abbr>, <abbr title="The left wing to be animated">'wing_left'</abbr>, <abbr title="The right wing to be animated">'wing_right'</abbr>)"</code>


With the exception of the wing flap placeholder, the first value mentioned in these functions controls how fast the limbs will swing, also called the period value. The second value is the amplitude, or how far a limb will swing. These are both multiplier values to a cosine wave that the author of this post can't seem to find at this moment. Be sure to tune these values if the limbs don't work with the defaults.



== Poser File Breakdown ==
Soon™


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that not all Pokémon have a bone called <code>head</code>.

Here is an example of a poser file for a custom <code>riolu</code> that includes all currently implemented poses and their appropriate animations.
* Riolu obviously can't fly. This is just an example as no Pokémon can do everything currently.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 1,
"portraitTranslation": [0, 0, 0],
"profileScale": 1,
"profileTranslation": [0, 0, 0],
"animations": {
"faint": "q.bedrock_primary('riolu', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('riolu', 'cry')",
"recoil": "q.bedrock_stateful('riolu', 'recoil')",
"physical": "q.bedrock_primary('riolu', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('riolu', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('riolu', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'battle_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('riolu', 'blink')"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"hover": {
"poseTypes": ["HOVER"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"fly": {
"poseTypes": ["FLY"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_fly')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('riolu', 'sleep')"]
},
"shoulder_left": {
"poseTypes": ["SHOULDER_LEFT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_left')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"shoulder_right": {
"poseTypes": ["SHOULDER_RIGHT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_right')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
}
}
}

{{Addon Creation}}

Poser

2025-03-06T11:15:11Z

Frank The Farmer: Slight introduction to molang conditions in the conditions section

{{TOC|right}}
== Preface ==
The <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]


== Poser Properties ==
Before breaking down each section of the Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!


=== Rootbone ===
The <code>rootBone</code> property specifies what bone in the model will act as the root bone for generic animations not assigned in the poser such as the evolution animation. If the model was made following the standard bone format, then it should simply be the name of the Pokémon in lower case. Punctuation and capitalization matter! So make sure it matches the root bone of your model exactly.

You are '''required''' to assign this root bone properly or else it will break the model in certain generic animations! These animations animate the root bone and do not reset it to its original position when it finishes. This can cause model displacement after evolutions.

Below is a breakdown of the simple rootBone property:
"<abbr title="This property attempts to call the specified bone from the model to assign it as the root bone for generic animations.">rootBone</abbr>": "<abbr title="In this scenario, the charizard bone is being called. This charizard bone should contain all other bones so generic animations can move the entire model for whatever they animate.">charizard</abbr>",


=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a negative Z value that is some multiple of 5.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon.

For the sake of clarity, you should always refer to animations like faints, cries, or physicals as '''Named Animations'''. This is to help everyone distinguish them from the animations that are applied to poses. This distinction is important because you can assign both <code>animations</code> and <code>namedAnimations</code> to a pose. This is to allow you to assign different cries, faints, or attack animations to different poses like your floating or flying poses. This allows for water attack animations if you make the animation to support it. This process will be detailed later. Below is a list of currently available Named Animation types and Poses to choose from. 

==== Animations & Named Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.
* '''<battle_move>''': <code>animation.<pokemon>.<battle_move_name></code> - The animation that plays when a pokemon uses a specific move in battle. This animation property would assign a pokemon's animation to an '''existing''' action effect. Something like a custom flamethrower animation for Charizard or a Pokémon's signature move for example.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.


==== Basic Animation Calling Functions ====
Below are the 3 methods to call a <code>Pose</code> or <code>namedAnimation</code> animation. Each of them serve a purpose in layering animations on the Pokémon. <code>Pose</code> animations must always use <code>q.bedrock()</code> to serve as the base animation that can be overwritten by other animations when called. <code>NamedAnimations</code> can either use <code>q.bedrock_stateful()</code> to layer over the base animation or use <code>q.bedrock_primary()</code> to overwrite the base animation while it is playing. The default function used in each named animation type can be changed if your animation supports it. If you want the cry to overwrite rather than layer, then just be sure to animate it properly.


===== q.bedrock =====
The <code>q.bedrock()</code> function is the familiar animation calling format from the [[Old_Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},


===== q.bedrock_stateful =====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


===== q.bedrock_primary =====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


<code>q.bedrock_primary</code> comes with a couple of extra properties and they should be written in the following order:
# group: <code>'blastoise'</code> - The animation JSON that the game will search for the following animation. This should always be the name of a Pokémon.
# animation: <code>'status'</code> - The animation the game will call from the previously mentioned animation JSON. Primary animations are usually your attack animations or faints, but you can assign it to other named animations if desired.
# (optional) excluded labels: <code>'look'</code> - Exclusive labeled animations that wont get overwritten by this primary animation. The only reasonable use of excluded labels is to exclude the look animation from being overwritten. This is so they can keep looking at a target when using an animation.
# curve: <code>'q.curve('symmetrical_wide')'</code> - The interpolation curve that this primary animation will use to transition to and from the pose it is written under.


Since Primary animations behave in a similar way to swapping poses, they can use special interpolation curve types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 common primary animations in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', 'look', q.curve('symmetrical_wide'))"


====== q.curve ======
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",

=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting.


There are two methods for conditions that you can use. There is the old true or false conditions where each condition has a property named after it and then there is the new Molang conditions. Molang conditions can use one or more molang functions to have the game check certain properties of the pokemon like what stats it has or even what it is standing on. A list of Cobblemon's custom molang functions can be found [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/api/molang/MoLangFunctions.kt here with some usable functions highlighted in red.] Due to the complexity of molang and it being so new to cobblemon, it's difficult to explain its potentially unlimited possibilities. There will be many examples to borrow from in the future. You can even use Molang's operators to extend your string if needed.


How to write a Molang condition:
* <code>"condition": "<insert molang function(s)>"</code>
** One of the few examples:
<code>"condition": "<abbr title="The function being called which checks for the blocks the Pokémon is standing on.">q.is_standing_on_blocks</abbr>(<abbr title="The depth required in order to be met. Meaning it must be standing above 2 blocks of sand or red sand.">2</abbr>, <abbr title="One of the blocks this function is checking for. The animation will play if it is standing above 2 blocks of sand">'minecraft:sand'</abbr>, <abbr title="One of the blocks this function is checking for. The animation will play if it is standing above 2 blocks of red sand">'minecraft:red_sand'</abbr>)"</code>

Below is an example inside of Lunatone's poser where it uses molang conditions to assign its 2 different sleeping animations: one where it checks for sand so it can lodge itself in the sand, and the other where it floats while it sleeps. By using the <code>!</code> operator in front of the second pose's molang condition, the game makes sure that the conditions are false in order to play the animation.
"sand-sleep": {
"poseTypes": ["SLEEP"],
"condition": "q.is_standing_on_blocks(2, 'minecraft:sand', 'minecraft:red_sand')",
"namedAnimations": {
"cry": "q.bedrock_stateful('dummy', 'cry')"
},
"animations": ["q.bedrock('lunatone', 'sleep')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"condition": "!q.is_standing_on_blocks(2, 'minecraft:sand', 'minecraft:red_sand')",
"namedAnimations": {
"cry": "q.bedrock_stateful('dummy', 'cry')"
},
"animations": ["q.bedrock('lunatone', 'sleep_alt')"]
}


List of Currently Implemented True or False Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isInWaterOrRain"</code>: The Pokémon must be touching water or in rain. Again, not necessarily underwater.
* <code>"isUnderWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},



=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each placeholder features a very simple animation that swings a limb back and forth.


Below is a list of current placeholder animations, their default values, and an example you can copy into your animations list directly:
* '''q.quadruped_walk''' - A basic walk animation for Pokémon with 4 legs.
<code>"q.quadruped_walk(0.66, 1.4, 'leg_front_left', 'leg_front_right', 'leg_back_left', 'leg_back_right')"</code>


* '''q.biped_walk''' - A basic walking animation for Pokémon who stand on 2 legs.
<code>"q.biped_walk(0.66, 1.4, 'leg_left', 'leg_right')"</code>


* '''q.bimanual_swing''' - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
<code>"q.bimanual_swing(0.66, 1.4, 'arm_left', 'arm_right')"</code>


* '''q.sine_wing_flap''' - A basic wing flap animation for a pair of wings on a Pokémon. This animation allows you to control a few more aspects of the specified bones. It's important to note what axis these "wings" should be rotating in to give the illusion of flapping. So be sure to reference your model.
<code>"q.sine_wing_flap(<abbr title="Multiplier for the amplitude value. How far the wings will flap">0.9</abbr>, <abbr title="Multiplier for the period value. How fast the wings will flap">0.9</abbr>, <abbr title="Vertical shift value. Radian value that the wing pair will be offset by.">25</abbr>, <abbr title="The x, y, or z axis of the bone that shall be rotated by this animation.">'z'</abbr>, <abbr title="The left wing to be animated">'wing_left'</abbr>, <abbr title="The right wing to be animated">'wing_right'</abbr>)"</code>


With the exception of the wing flap placeholder, the first value mentioned in these functions controls how fast the limbs will swing, also called the period value. The second value is the amplitude, or how far a limb will swing. These are both multiplier values to a cosine wave that the author of this post can't seem to find at this moment. Be sure to tune these values if the limbs don't work with the defaults.



== Poser File Breakdown ==
Soon™


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that not all Pokémon have a bone called <code>head</code>.

Here is an example of a poser file for a custom <code>riolu</code> that includes all currently implemented poses and their appropriate animations.
* Riolu obviously can't fly. This is just an example as no Pokémon can do everything currently.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 1,
"portraitTranslation": [0, 0, 0],
"profileScale": 1,
"profileTranslation": [0, 0, 0],
"animations": {
"faint": "q.bedrock_primary('riolu', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('riolu', 'cry')",
"recoil": "q.bedrock_stateful('riolu', 'recoil')",
"physical": "q.bedrock_primary('riolu', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('riolu', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('riolu', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'battle_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('riolu', 'blink')"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"hover": {
"poseTypes": ["HOVER"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"fly": {
"poseTypes": ["FLY"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_fly')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('riolu', 'sleep')"]
},
"shoulder_left": {
"poseTypes": ["SHOULDER_LEFT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_left')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"shoulder_right": {
"poseTypes": ["SHOULDER_RIGHT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_right')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
}
}
}

{{Addon Creation}}

Poser

2025-03-06T10:25:16Z

Frank The Farmer: Updated placeholder animation section and included examples. Curse you Paul!

{{TOC|right}}
== Preface ==
The <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]


== Poser Properties ==
Before breaking down each section of the Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!


=== Rootbone ===
The <code>rootBone</code> property specifies what bone in the model will act as the root bone for generic animations not assigned in the poser such as the evolution animation. If the model was made following the standard bone format, then it should simply be the name of the Pokémon in lower case. Punctuation and capitalization matter! So make sure it matches the root bone of your model exactly.

You are '''required''' to assign this root bone properly or else it will break the model in certain generic animations! These animations animate the root bone and do not reset it to its original position when it finishes. This can cause model displacement after evolutions.

Below is a breakdown of the simple rootBone property:
"<abbr title="This property attempts to call the specified bone from the model to assign it as the root bone for generic animations.">rootBone</abbr>": "<abbr title="In this scenario, the charizard bone is being called. This charizard bone should contain all other bones so generic animations can move the entire model for whatever they animate.">charizard</abbr>",


=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a negative Z value that is some multiple of 5.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon.

For the sake of clarity, you should always refer to animations like faints, cries, or physicals as '''Named Animations'''. This is to help everyone distinguish them from the animations that are applied to poses. This distinction is important because you can assign both <code>animations</code> and <code>namedAnimations</code> to a pose. This is to allow you to assign different cries, faints, or attack animations to different poses like your floating or flying poses. This allows for water attack animations if you make the animation to support it. This process will be detailed later. Below is a list of currently available Named Animation types and Poses to choose from. 

==== Animations & Named Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.
* '''<battle_move>''': <code>animation.<pokemon>.<battle_move_name></code> - The animation that plays when a pokemon uses a specific move in battle. This animation property would assign a pokemon's animation to an '''existing''' action effect. Something like a custom flamethrower animation for Charizard or a Pokémon's signature move for example.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.


==== Basic Animation Calling Functions ====
Below are the 3 methods to call a <code>Pose</code> or <code>namedAnimation</code> animation. Each of them serve a purpose in layering animations on the Pokémon. <code>Pose</code> animations must always use <code>q.bedrock()</code> to serve as the base animation that can be overwritten by other animations when called. <code>NamedAnimations</code> can either use <code>q.bedrock_stateful()</code> to layer over the base animation or use <code>q.bedrock_primary()</code> to overwrite the base animation while it is playing. The default function used in each named animation type can be changed if your animation supports it. If you want the cry to overwrite rather than layer, then just be sure to animate it properly.


===== q.bedrock =====
The <code>q.bedrock()</code> function is the familiar animation calling format from the [[Old_Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},


===== q.bedrock_stateful =====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


===== q.bedrock_primary =====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


<code>q.bedrock_primary</code> comes with a couple of extra properties and they should be written in the following order:
# group: <code>'blastoise'</code> - The animation JSON that the game will search for the following animation. This should always be the name of a Pokémon.
# animation: <code>'status'</code> - The animation the game will call from the previously mentioned animation JSON. Primary animations are usually your attack animations or faints, but you can assign it to other named animations if desired.
# (optional) excluded labels: <code>'look'</code> - Exclusive labeled animations that wont get overwritten by this primary animation. The only reasonable use of excluded labels is to exclude the look animation from being overwritten. This is so they can keep looking at a target when using an animation.
# curve: <code>'q.curve('symmetrical_wide')'</code> - The interpolation curve that this primary animation will use to transition to and from the pose it is written under.


Since Primary animations behave in a similar way to swapping poses, they can use special interpolation curve types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 common primary animations in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', 'look', q.curve('symmetrical_wide'))"


====== q.curve ======
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",

=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting. 

List of Currently Implemented Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isInWaterOrRain"</code>: The Pokémon must be touching water or in rain. Again, not necessarily underwater.
* <code>"isUnderWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},


=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each placeholder features a very simple animation that swings a limb back and forth.


Below is a list of current placeholder animations, their default values, and an example you can copy into your animations list directly:
* '''q.quadruped_walk''' - A basic walk animation for Pokémon with 4 legs.
<code>"q.quadruped_walk(0.66, 1.4, 'leg_front_left', 'leg_front_right', 'leg_back_left', 'leg_back_right')"</code>


* '''q.biped_walk''' - A basic walking animation for Pokémon who stand on 2 legs.
<code>"q.biped_walk(0.66, 1.4, 'leg_left', 'leg_right')"</code>


* '''q.bimanual_swing''' - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
<code>"q.bimanual_swing(0.66, 1.4, 'arm_left', 'arm_right')"</code>


* '''q.sine_wing_flap''' - A basic wing flap animation for a pair of wings on a Pokémon. This animation allows you to control a few more aspects of the specified bones. It's important to note what axis these "wings" should be rotating in to give the illusion of flapping. So be sure to reference your model.
<code>"q.sine_wing_flap(<abbr title="Multiplier for the amplitude value. How far the wings will flap">0.9</abbr>, <abbr title="Multiplier for the period value. How fast the wings will flap">0.9</abbr>, <abbr title="Vertical shift value. Radian value that the wing pair will be offset by.">25</abbr>, <abbr title="The x, y, or z axis of the bone that shall be rotated by this animation.">'z'</abbr>, <abbr title="The left wing to be animated">'wing_left'</abbr>, <abbr title="The right wing to be animated">'wing_right'</abbr>)"</code>


With the exception of the wing flap placeholder, the first value mentioned in these functions controls how fast the limbs will swing, also called the period value. The second value is the amplitude, or how far a limb will swing. These are both multiplier values to a cosine wave that the author of this post can't seem to find at this moment. Be sure to tune these values if the limbs don't work with the defaults.



== Poser File Breakdown ==
Soon™


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that not all Pokémon have a bone called <code>head</code>.

Here is an example of a poser file for a custom <code>riolu</code> that includes all currently implemented poses and their appropriate animations.
* Riolu obviously can't fly. This is just an example as no Pokémon can do everything currently.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 1,
"portraitTranslation": [0, 0, 0],
"profileScale": 1,
"profileTranslation": [0, 0, 0],
"animations": {
"faint": "q.bedrock_primary('riolu', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('riolu', 'cry')",
"recoil": "q.bedrock_stateful('riolu', 'recoil')",
"physical": "q.bedrock_primary('riolu', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('riolu', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('riolu', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'battle_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('riolu', 'blink')"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"hover": {
"poseTypes": ["HOVER"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"fly": {
"poseTypes": ["FLY"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_fly')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('riolu', 'sleep')"]
},
"shoulder_left": {
"poseTypes": ["SHOULDER_LEFT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_left')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"shoulder_right": {
"poseTypes": ["SHOULDER_RIGHT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_right')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
}
}
}

{{Addon Creation}}

Poser

2025-03-06T06:17:41Z

Frank The Farmer: Data update for example poser

{{TOC|right}}
== Preface ==
The <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]


== Poser Properties ==
Before breaking down each section of the Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!


=== Rootbone ===
The <code>rootBone</code> property specifies what bone in the model will act as the root bone for generic animations not assigned in the poser such as the evolution animation. If the model was made following the standard bone format, then it should simply be the name of the Pokémon in lower case. Punctuation and capitalization matter! So make sure it matches the root bone of your model exactly.

You are '''required''' to assign this root bone properly or else it will break the model in certain generic animations! These animations animate the root bone and do not reset it to its original position when it finishes. This can cause model displacement after evolutions.

Below is a breakdown of the simple rootBone property:
"<abbr title="This property attempts to call the specified bone from the model to assign it as the root bone for generic animations.">rootBone</abbr>": "<abbr title="In this scenario, the charizard bone is being called. This charizard bone should contain all other bones so generic animations can move the entire model for whatever they animate.">charizard</abbr>",


=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a negative Z value that is some multiple of 5.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon.

For the sake of clarity, you should always refer to animations like faints, cries, or physicals as '''Named Animations'''. This is to help everyone distinguish them from the animations that are applied to poses. This distinction is important because you can assign both <code>animations</code> and <code>namedAnimations</code> to a pose. This is to allow you to assign different cries, faints, or attack animations to different poses like your floating or flying poses. This allows for water attack animations if you make the animation to support it. This process will be detailed later. Below is a list of currently available Named Animation types and Poses to choose from. 

==== Animations & Named Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.
* '''<battle_move>''': <code>animation.<pokemon>.<battle_move_name></code> - The animation that plays when a pokemon uses a specific move in battle. This animation property would assign a pokemon's animation to an '''existing''' action effect. Something like a custom flamethrower animation for Charizard or a Pokémon's signature move for example.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.


==== Basic Animation Calling Functions ====
Below are the 3 methods to call a <code>Pose</code> or <code>namedAnimation</code> animation. Each of them serve a purpose in layering animations on the Pokémon. <code>Pose</code> animations must always use <code>q.bedrock()</code> to serve as the base animation that can be overwritten by other animations when called. <code>NamedAnimations</code> can either use <code>q.bedrock_stateful()</code> to layer over the base animation or use <code>q.bedrock_primary()</code> to overwrite the base animation while it is playing. The default function used in each named animation type can be changed if your animation supports it. If you want the cry to overwrite rather than layer, then just be sure to animate it properly.


===== q.bedrock =====
The <code>q.bedrock()</code> function is the familiar animation calling format from the [[Old_Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},


===== q.bedrock_stateful =====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


===== q.bedrock_primary =====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


<code>q.bedrock_primary</code> comes with a couple of extra properties and they should be written in the following order:
# group: <code>'blastoise'</code> - The animation JSON that the game will search for the following animation. This should always be the name of a Pokémon.
# animation: <code>'status'</code> - The animation the game will call from the previously mentioned animation JSON. Primary animations are usually your attack animations or faints, but you can assign it to other named animations if desired.
# (optional) excluded labels: <code>'look'</code> - Exclusive labeled animations that wont get overwritten by this primary animation. The only reasonable use of excluded labels is to exclude the look animation from being overwritten. This is so they can keep looking at a target when using an animation.
# curve: <code>'q.curve('symmetrical_wide')'</code> - The interpolation curve that this primary animation will use to transition to and from the pose it is written under.


Since Primary animations behave in a similar way to swapping poses, they can use special interpolation curve types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 common primary animations in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', 'look', q.curve('symmetrical_wide'))"


====== q.curve ======
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",

=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting. 

List of Currently Implemented Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isInWaterOrRain"</code>: The Pokémon must be touching water or in rain. Again, not necessarily underwater.
* <code>"isUnderWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},


=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each placeholder features a very simple animation that swings a limb back and forth. For now, you'll have to figure out how to configure these yourself lol

Here is a list of all the Placeholder animations:
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L172 "q.quadruped_walk()"]</code> - A basic walk animation for Pokémon with 4 legs
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L192 "q.biped_walk()"]</code> - A basic walking animation for Pokémon who stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L208 "q.bimanual_swing()"]</code> - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L224 "q.sine_wing_flap()"]</code> - A basic wing flap animation for a pair of wings on a Pokémon.



== Poser File Breakdown ==
Soon™


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that not all Pokémon have a bone called <code>head</code>.

Here is an example of a poser file for a custom <code>riolu</code> that includes all currently implemented poses and their appropriate animations.
* Riolu obviously can't fly. This is just an example as no Pokémon can do everything currently.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 1,
"portraitTranslation": [0, 0, 0],
"profileScale": 1,
"profileTranslation": [0, 0, 0],
"animations": {
"faint": "q.bedrock_primary('riolu', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('riolu', 'cry')",
"recoil": "q.bedrock_stateful('riolu', 'recoil')",
"physical": "q.bedrock_primary('riolu', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('riolu', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('riolu', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'battle_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('riolu', 'blink')"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"hover": {
"poseTypes": ["HOVER"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"fly": {
"poseTypes": ["FLY"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_fly')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('riolu', 'sleep')"]
},
"shoulder_left": {
"poseTypes": ["SHOULDER_LEFT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_left')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"shoulder_right": {
"poseTypes": ["SHOULDER_RIGHT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_right')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
}
}
}

{{Addon Creation}}

Species Additions

2025-03-06T05:32:44Z

Frank The Farmer: Info update for species addiitons

{{TOC|right}}
== Preface ==
You can create a <code>species_addition</code> JSON to replace or add some new data to an existing <code>[[Species|species]]</code> file. Species additions can be a helpful way to add your own [[Tutorials/Regional_Forms|regional variants]] to existing Pokémon. They can also be helpful if you want to rewrite a Pokémon's stats for an addon. This system was created to improve the compatibility between multiple datapacks by allowing datapack developers to target specific species and append or replace depending on the field type without overwriting the base species file.

=== Species Addition Breakdown ===
Creating a <code>species addition</code> JSON is very simple. You simply list your target Pokémon, and then list '''''any data''''' that you wish to rewrite or add to the <code>species</code> file of that Pokémon. <code>Forms</code> and <code>evolution</code> data are exceptions to the rewriting. They will always be added instead.

Here is a breakdown of an example <code>species addition</code>. Hover over the underlined text to see more information.
{
"<abbr title="Here you will specify which Pokémon will receive the data in this file.">target</abbr>": "<abbr title="In this case, Bulbasaur will get all of this data written into its species file.">cobblemon:bulbasaur</abbr>",
"<abbr title="This will let you change the primary type of the target">primaryType</abbr>": "fire",
"<abbr title="This will let you change the secondary type of the target">secondaryType</abbr>": "water",
"<abbr title="Whether or not the target can be placed on the player shoulder">shoulderMountable</abbr>": true,
"<abbr title="The following block of data would allow the target Pokémon to grant the slow falling effect to the player when on the shoulder.">shoulderEffects</abbr>": [
{
"type": "potion_effect",
"effect": "minecraft:slow_falling",
"amplifier": 0,
"ambient": true,
"showParticles": false,
"showIcon": false
}
],
"<abbr title="The following block of data will allow the target Pokémon to have a 2.5% chance at dropping razor fangs.">drops</abbr>": {
"amount": 1,
"entries": [
{
"item": "cobblemon:razor_fang",
"percentage": 2.5
}
]
},
"<abbr title="The following block of data will rewrite the target's AI behavior. This new behavior will allow it to fly.">behaviour</abbr>": {
"moving": {
"walk": {
"canWalk": true
},
"fly": {
"canFly": true
}
},
"resting": {
"canSleep": true,
"willSleepOnBed": true,
"depth": "normal",
"light": "0-4"
}
},
"<abbr title="This will change the model size of the target">baseScale</abbr>": 2,
"<abbr title="This will change the size of the hitbox on the target">hitbox</abbr>": {
"<abbr title="This will make the hitbox 2 blocks wide">width</abbr>": 2,
"<abbr title="This will make the hitbox 2 blocks tall">height</abbr>": 2,
"fixed": false
},
"<abbr title="This block of data will let the target emit a light source if the player has compatible dynamic light mods installed.">lightingData</abbr>": {
"<abbr title="This is the light level the target will give off">lightLevel</abbr>": 10,
"<abbr title="This lets the target only emit light when on land. Never in the water.">liquidGlowMode</abbr>": "LAND"
}
}

Loading this file would have the following effects on Bulbasaur:
* It will become a fire and water type instead of grass and poison
* Can be mounted on the player shoulder
* When shoulder mounted, will grant the slow falling effect
* Can start dropping razor fangs at a 2.5% chance
* Can now fly
* Increased model scale to 2
* Increased hitbox size to a 2x2 cube
* Can emit a light level of 10 when on land only if dynamic light mods are installed

Here is a list of tips about species additions:
* Species additions will rewrite any data if it is already written in the target species file.
** Example: If you wanted to add a new move to the <code>moves</code> list, you'd have to rewrite the entire move list. If you only write the one new move, it will be the only move that Pokémon can learn.
* Species additions will also add your written data if it doesn't exist in the target species file yet.
** You can create a file to add <code>drops</code> for Pokémon that don't drop anything yet.
* This system was created to help addon creators keep their datapacks compatible with others! Always use them if you wish to edit something about existing Pokémon you didn't create.
** It will prevent 2 datapacks fighting over who will get to replace the main species file.
** It can prevent your addon from causing irreparable damage to player save data in certain scenarios!
* If 2 additions want to rewrite the same thing, like item drops, then only the first file in the load order will have its changes implemented.
* Using species additions to add special Pokémon forms is the most addon friendly process!
** If two creators both wanted to add a regional form to Mudkip, and they both used species additions to add the form data, then people can use both addons together without issues!

==== Datapack Folder Location ====
These files belong in a folder you might have never seen before. You can place the JSONs in the species additions folder itself, or even create sub folders for your JSONs. '''Remember that datapack rules will apply if you use the cobblemon namespace and use the Pokémon's name to name the JSON. Consider using your own namespace and using unique file names to avoid conflicts with other addons that want to make changes to the same Pokémon.''' Here is how you should arrange your <code>species addition</code> files and folder:
<div class="treeview">
*''(addon name)''
**data
***''(addon name)''
****species_additions
*****'''<target_pokemon>.json'''
*****''(optional target pokemon/generation folders)''
******'''<optional target_pokemon>.json'''
</div>

You can also merge the species additions folder into an existing addon pack.

=== Species Addition Examples ===
One of the most common uses of species additions by the community is adding extra <code>evolution</code> data to official Pokémon. It is also used often to change the <code>baseScale</code> and <code>hitbox</code> sizes of a Pokémon for use with unofficial models.

* In this example, Combee will have its basescale and hitbox sizes changed. A species addition like this is helpful if you want to add your own model to a Pokémon without an official model yet.
{
"target": "cobblemon:combee",
"baseScale": 1,
"hitbox": {
"width": 1,
"height": 1.2,
"fixed": false
}
}

* In this example, Eevee will now evolve into Charizard at level 36 and it will maintain all its other eeveelutions!
{
"target": "cobblemon:eevee",
"evolutions": [
{
"id": "eevee_charizard",
"variant": "level_up",
"result": "charizard",
"consumeHeldItem": false,
"learnableMoves": [],
"requirements": [
{
"variant": "level",
"minLevel": 36
}
]
}
]
}

The following is an example of two addons that want to change <code>evolution</code> and <code>form</code> data for an existing Pokémon. In this case, they both want to create a new eeveelution and a new regional form of Eevee that has its own evolution as well. Thanks to <code>species_additions</code> and its special rules, anybody can use both of these hypothetical addons and get the effects of both without issues!
* A regular Eevee could then evolve into Charizard or Blastoise at level 36.
* An Alolan Eevee would become an Ice type and evolve into Squirtle with a [[Water Stone]].
* A Hisuian Eevee would become a Fire type and evolve into Bulbasaur with a [[Leaf Stone]].

Addon #1's species addition:
{
"target": "cobblemon:eevee",
"features": ["alolan"],
"forms": [
{
"name": "Alola",
"primaryType": "ice",
"abilities": [
"snowcloak",
"h:snowwarning"
],
"aspects": ["alolan"],
"evolutions": [
{
"id": "eevee_squirtle",
"variant": "item_interact",
"result": "squirtle",
"consumeHeldItem": false,
"learnableMoves": [],
"requirements": [],
"requiredContext": "cobblemon:water_stone"
}
]
}
],
"evolutions": [
{
"id": "eevee_blastoise",
"variant": "level_up",
"result": "blastoise",
"consumeHeldItem": false,
"learnableMoves": [],
"requirements": [
{
"variant": "level",
"minLevel": 36
}
]
}
]
}

Addon #2's species addition:
{
"target": "cobblemon:eevee",
"features": ["hisuian"],
"forms": [
{
"name": "Hisui",
"primaryType": "fire",
"abilities": [
"flamebody",
"h:drought"
],
"aspects": ["hisuian"],
"evolutions": [
{
"id": "eevee_bulbasaur",
"variant": "item_interact",
"result": "bulbasaur",
"consumeHeldItem": false,
"learnableMoves": [],
"requirements": [],
"requiredContext": "cobblemon:leaf_stone"
}
]
}
],
"evolutions": [
{
"id": "eevee_charizard",
"variant": "level_up",
"result": "charizard",
"consumeHeldItem": false,
"learnableMoves": [],
"requirements": [
{
"variant": "level",
"minLevel": 36
}
]
}
]
}

[[File:New_Eeveelutions.png|thumb|center|900px|caption|The resulting eeveelutions with both addons enabled.]]

{{Addon Creation}}

Spawn Pool World

2025-03-06T05:05:13Z

Frank The Farmer: Updated some spawn file examples

{{TOC|right}}
== Preface ==
The <code>spawn_pool_world</code> folder contains the JSON files that control how a Pokémon spawns naturally. For simplicity, most people call them <code>spawn files</code>. These files dictate which Pokémon will spawn, its rarity , its level, and the [[Spawn_Condition|conditions]] it will spawn in. Every implemented Pokémon has at least one set of spawn data. Without this spawn data, a Pokémon can only be spawned through commands.

=== Spawn File Breakdown ===
The data in spawn files can be rather self-explanatory. These files can be as simple as spawning in the forest, or as complicated as only spawning at 2:30-3:00AM on top of clay during the new moon in an ocean biome that is south of spawn.

Here is a breakdown of <code>Bulbasaur's</code> spawn file. Hover over the underlined text to see more information.
{
"<abbr title="This determines whether this spawn data is enabled">enabled": true</abbr>,
"<abbr title="These are lists that say whether the spawn data requires specific mods to be present. Namely, this is mostly for pokémon that spawn in biomes introduced by other mods.">neededInstalledMods": []</abbr>,
"<abbr title="These are lists that say whether the spawn data requires specific mods to be present. Namely, this is mostly for pokémon that spawn in biomes introduced by other mods.">neededUninstalledMods": []</abbr>,
"<abbr title="Here we are declaring where it will spawn.">spawns</abbr>": [
{
"<abbr title="Spawn locations require unique ID's. Calling them something like yourpokemon-1, yourpokemon-2 and so on is acceptable.">id": "bulbasaur-1</abbr>",
"<abbr title="Which pokémon are we trying to spawn here?">pokemon": "bulbasaur</abbr>",
"<abbr title="Presets are a collection of potential block candidates to spawn on, this way you don't need to clarify a ton of blocks every time you make a spawn file.">presets</abbr>": [
"<abbr title="natural is the most common preset. You can pick others like underground, freshwater, redstone or more.">natural</abbr>"
],
"<abbr title="We are spawning a pokémon here, so no need to change this.">type": "pokemon</abbr>",
"<abbr title="What sort of surface is this spawning on? There are some other contexts listed below the example.">context": "grounded</abbr>",
"<abbr title="How rare is this pokémon?">bucket": "ultra-rare</abbr>",
"<abbr title="This is the minimum and maximum level this pokémon can spawn at.">level": "5-32</abbr>",
"<abbr title="This number determines how likely it is to spawn considering its rarity.">weight": 9.0</abbr>,
"<abbr title="Additional spawn conditions are listed in this section.">condition</abbr>": {
"<abbr title="Whether or not this pokémon should be able to see the sky when it spawns.">canSeeSky</abbr>": true,
"<abbr title="Here we list the biomes we want the pokémon to spawn in.">biomes</abbr>": [
"<abbr title="The Cobblemon tag for jungle biomes. Allows Bulbasaur to spawn in any biome tagged as a jungle.">#cobblemon:is_jungle</abbr>"
]
}
}
]
}
Bulbasaur is an ultra-rare spawn which occurs 0.2% of the time. It can only spawn on natural blocks, like grass, that are in a jungle biome while the sky is visible. It cannot spawn under trees.

Here is a list of options that some of the spawn properties can use:
* '''"presets"''': You can use any of these presets listed on the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/data/cobblemon/spawn_detail_presets Gitlab] or you can make your own [[Spawn_Detail_Presets|presets]].
* '''"context"''': You can choose between <code>"grounded"</code> for land spawns, <code>"submerged"</code> for underwater spawns, and <code>"surface"</code> for spawns on the surface of water or lava.
* '''"bucket"''': The rarity pool of the Pokémon. You can choose <code>"common"</code>, <code>"uncommon"</code>, <code>"rare"</code>, or <code>"ultra-rare"</code>
* '''"weight"''': This determines how common the Pokémon will be inside of the assigned rarity pool. Generally, you can treat it like a scale of 0.1 to 10 on how rare it will be in that pool. You can use numbers higher than 10 if you really want that Pokémon to spawn more often.
* '''"condition"''': You can use any of the conditions listed [[Spawn_Condition|here]] to make Pokémon spawn
* '''"anticondition"''': You can use any of the conditions listed [[Spawn_Condition|here]] to '''PREVENT''' a Pokémon from spawning
* '''"biomes"''': A subcategory of conditions and anticonditions. You can use biome id's or any [https://docs.google.com/document/d/1iB0EJSc2r6mRJXIo1n3XpHbZ5udwJVnrh2pXdhTyH8c/edit biome tags]. Should work with modded biome id's too!
* '''"weightMultiplier"''': This allows you to multiply the weight of the specific spawn ID provided a second set of conditions are also met. An array that requires a <code>multiplier</code> float value, and an array of conditions and/or anticonditions.
** A snippet example of a weight multiplier from elekid:
"<abbr title="The normal weight of the spawn. In this case, the weight is 1.8 if in the hills or plains while there is no thunderstorm.">weight</abbr>": 1.8,
"<abbr title="Here you will specify when to multiply the weights and by how much.">weightMultiplier</abbr>": {
"<abbr title="The value that will be multiplied with the normal weight. 5 x 1.8 would result in a weight of 9 only if it there is a thunderstorm while in the hills or plains.">multiplier</abbr>": 5.0,
"<abbr title="The list of conditions that must be met in order for the weight to be multiplied.">condition</abbr>": {
"<abbr title="Weather or not a thunderstorm must be present">isThundering</abbr>": true
}
},
"<abbr title="The list of conditions that must be met in order for Elekid to spawn.">condition</abbr>": {
"<abbr title="Whether or not the spawning context must have a direct route to the sky above it">canSeeSky</abbr>": true,
"<abbr title="A list of required biomes in order for Elekid to spawn.">biomes</abbr>": [
"#cobblemon:is_hills",
"#cobblemon:is_plains"
]
}

=== Spawn File Examples ===
Instead of making <code>spawn files</code> from scratch each time, you can use familiar Pokémon as a template. You can simply swap their names for the <code>id</code> and <code>pokemon</code> properties. Here are some simple examples of different spawn files.

* Buneary's spawn file - A great template for common land pokemon
{
"enabled": true,
"neededInstalledMods": [],
"neededUninstalledMods": [],
"spawns": [
{
"id": "buneary-1",
"pokemon": "buneary",
"presets": [
"natural",
"wild"
],
"type": "pokemon",
"context": "grounded",
"bucket": "common",
"level": "10-35",
"weight": 5.4,
"condition": {
"minSkyLight": 8,
"maxSkyLight": 15,
"biomes": [
"#cobblemon:is_forest",
"#cobblemon:is_hills",
"#cobblemon:is_snowy_forest",
"#cobblemon:is_snowy_taiga",
"#cobblemon:is_taiga"
]
}
}
]
}

* Wishiwashi's spawn file - A great template for a fish-like pokemon that you can find in water or fish for!
{
"enabled": true,
"neededInstalledMods": [],
"neededUninstalledMods": [],
"spawns": [
{
"id": "wishiwashi-1",
"pokemon": "wishiwashi",
"presets": [
"water"
],
"type": "pokemon",
"context": "submerged",
"bucket": "common",
"level": "1-18",
"weight": 10.0,
"condition": {
"canSeeSky": true,
"biomes": [
"#cobblemon:is_ocean"
]
}
},
{
"id": "wishiwashi-2",
"pokemon": "wishiwashi",
"type": "pokemon",
"context": "fishing",
"bucket": "common",
"level": "1-18",
"weight": 10.0,
"condition": {
"canSeeSky": true,
"biomes": [
"#cobblemon:is_coast",
"#cobblemon:is_ocean"
]
}
},
{
"id": "wishiwashi-3",
"pokemon": "wishiwashi",
"presets": [
"water"
],
"type": "pokemon",
"context": "submerged",
"bucket": "common",
"level": "1-18",
"weight": 10.0,
"condition": {
"canSeeSky": false,
"minSkyLight": 8,
"maxSkyLight": 15,
"biomes": [
"#cobblemon:is_ocean"
]
}
},
{
"id": "wishiwashi-4",
"pokemon": "wishiwashi",
"type": "pokemon",
"context": "fishing",
"bucket": "common",
"level": "1-18",
"weight": 10.0,
"condition": {
"canSeeSky": false,
"minSkyLight": 8,
"maxSkyLight": 15,
"biomes": [
"#cobblemon:is_coast",
"#cobblemon:is_ocean"
]
}
}
]
}

* Klink's spawn file - A great template for nearby block requirements, and mod compatibility!
{
"enabled": true,
"neededInstalledMods": [],
"neededUninstalledMods": [],
"spawns": [
{
"id": "klink-1",
"pokemon": "klink",
"presets": [
"natural"
],
"type": "pokemon",
"context": "grounded",
"bucket": "common",
"level": "5-30",
"weight": 9.0,
"condition": {
"minSkyLight": 0,
"maxSkyLight": 7,
"biomes": [
"#cobblemon:is_overworld"
],
"neededNearbyBlocks": [
"#minecraft:redstone_ores",
"#c:redstone_ores"
]
},
"anticondition": {
"biomes": [
"#cobblemon:is_deep_dark"
]
}
},
{
"id": "klink-2",
"pokemon": "klink",
"presets": [
"natural",
"redstone"
],
"type": "pokemon",
"context": "grounded",
"bucket": "common",
"level": "5-30",
"weight": 1.8,
"condition": {
"biomes": [
"#cobblemon:is_overworld"
]
}
},
{
"id": "klink-3",
"pokemon": "klink",
"presets": [
"natural"
],
"type": "pokemon",
"context": "grounded",
"bucket": "common",
"level": "5-30",
"weight": 1.8,
"condition": {
"biomes": [
"#cobblemon:is_overworld"
],
"neededNearbyBlocks": [
"create:cogwheel",
"create:large_cogwheel",
"create:gearbox",
"create:vertical_gearbox"
]
}
}
]
}

* Elekid's spawn file - a great example of weight multipliers
{
"enabled": true,
"neededInstalledMods": [],
"neededUninstalledMods": [],
"spawns": [
{
"id": "elekid-1",
"pokemon": "elekid",
"presets": [
"natural"
],
"type": "pokemon",
"context": "grounded",
"bucket": "uncommon",
"level": "11-36",
"weight": 1.68,
"weightMultiplier": {
"multiplier": 5.0,
"condition": {
"isThundering": true
}
},
"condition": {
"minSkyLight": 8,
"maxSkyLight": 15,
"biomes": [
"#cobblemon:is_hills",
"#cobblemon:is_plains"
]
}
}
]
}

{{Addon Creation}}

Spawn Detail Presets

2025-03-06T00:13:20Z

Frank The Farmer: Updated json example for redstone

{{TOC|right}}
== Preface ==
The JSONs in the <code>spawn_detail_presets</code> folder create the <code>presets</code> that are used in Pokémon [[Spawn_Pool_World|spawn files]]. Presets are simply a collection of <code>conditions</code>, <code>anticonditions</code>, and <code>contexts</code> that are bundled up into a new <code>preset</code> named after the JSON file name! They are a great way to make familiar scenes into a simple tag you can use when making spawns.

=== Preset Breakdown ===
You can make a <code>preset</code> as simple or complex as you like. The complexity of it depends on your understanding of [[Spawn_Condition|spawn conditions]], [https://docs.google.com/document/d/1iB0EJSc2r6mRJXIo1n3XpHbZ5udwJVnrh2pXdhTyH8c/edit biomes], and your creativity. Almost all presets include one major condition. This condition is a list of blocks that the Pokémon can spawn on.

Here is a breakdown of the <code>stronghold</code> preset. Its conditions require you to be in a naturally generated stronghold with some block requirements. Hover over the underlined text to see more information.

{
"<abbr title="Here you will list spawn conditions that will allow a Pokémon to spawn">condition</abbr>": {
"<abbr title="A list of structures that a Pokémon can spawn in the area of. You will need to list the structure id which can be identified in game using the locate structure command.">structures</abbr>": [
"<abbr title="The ID for minecraft's stronghold structure. This will allow Pokémon with this preset to spawn in strongholds provided the other conditions are also met.">minecraft:stronghold</abbr>"
],
"<abbr title="Here you are specifying the max Y level the Pokémon can spawn at.">maxY</abbr>": <abbr title="In this case, pokemon using this preset wont spawn above Y:62">62</abbr>,
"<abbr title="A list of blocks that a Pokémon can spawn on top of. Can list block id's or block tags.">neededBaseBlocks</abbr>": [
"<abbr title="The block tag for the different kinds of stone bricks.">#minecraft:stone_bricks</abbr>"
],
"<abbr title="A list of blocks required to be nearby in order for a Pokémon to spawn. Only one block from the list is required to be nearby.">neededNearbyBlocks</abbr>": [
"<abbr title="The block ID for cracked stone bricks">minecraft:cracked_stone_bricks</abbr>",
"<abbr title="The block ID for mossy stone bricks">minecraft:mossy_stone_bricks</abbr>"
]
}
}

=== Preset Examples ===
Here are some simple examples of presets.

* '''lava_surface''' - Allows Pokémon with this preset to spawn on top of lava
{
"context": "surface",
"condition": {
"fluid": "#minecraft:lava"
}
}

* '''river''' - Allows Pokémon to spawn in river biomes that aren't covered in snow or ice.
{
"condition": {
"biomes": [ "#cobblemon:is_river" ]
},
"anticondition": {
"biomes": [ "#cobblemon:is_freezing" ]
}
}

* '''redstone''' - Allows Pokémon to spawn near some redstone related blocks, but prevents them from spawning on top of certain blocks too.
{
"condition": {
"neededNearbyBlocks": [
"minecraft:activator_rail",
"minecraft:daylight_detector",
"minecraft:detector_rail",
"minecraft:dispenser",
"minecraft:dropper",
"minecraft:hopper",
"minecraft:observer",
"minecraft:piston",
"minecraft:powered_comparator",
"minecraft:powered_rail",
"minecraft:powered_repeater",
"minecraft:redstone_block",
"minecraft:redstone_lamp",
"minecraft:redstone_torch",
"minecraft:redstone_wire",
"minecraft:sticky_piston",
"minecraft:unlit_redstone_torch",
"minecraft:unpowered_comparator",
"minecraft:unpowered_repeater",
"#minecraft:redstone_ores",
"#c:redstone_blocks",
"#c:redstone_ores"
]
},
"anticondition": {
"neededBaseBlocks": [
"minecraft:activator_rail",
"minecraft:daylight_detector",
"minecraft:detector_rail",
"minecraft:dispenser",
"minecraft:dropper",
"minecraft:hopper",
"minecraft:observer",
"minecraft:piston",
"minecraft:powered_comparator",
"minecraft:powered_rail",
"minecraft:powered_repeater",
"minecraft:redstone_block",
"minecraft:redstone_lamp",
"minecraft:redstone_torch",
"minecraft:redstone_wire",
"minecraft:sticky_piston",
"minecraft:unlit_redstone_torch",
"minecraft:unpowered_comparator",
"minecraft:unpowered_repeater",
"#c:redstone_blocks"
]
}
}

{{Addon Creation}}

Tutorials/Regional Forms

2025-01-26T12:52:05Z

Frank The Farmer: /* Step 4: Create a "species addition" file with "form" data */

{{TOC|right}}
== Preface ==
This tutorial will teach you how to create a regional form for '''''an existing Pokémon.''''' Regional forms are a species variant that can have different looks, types, abilities, moves, and spawn locations! '''Knowledge of [[Tutorials/Creating_A_Custom_Pokemon|creating custom Pokémon]] is ''required.''''' Creating a unique model and textures for your form is highly recommended, but not always necessary.

Due to regional forms usually requiring files for both data and assets, this type of pack will just be called an <code>addon</code> for simplicity. Addons that use data and asset folders will end up needing to have a copy in both the <code>datapacks</code> and <code>resourcepacks</code> game folders. The data and assets can be separated if desired, but are usually bundled together to make sharing easier!

=== Step 1: Arrange the folders for this addon ===
Due to some files sharing the same names later in this guide, you will be creating the folder structure and <code>pack.mcmeta</code> now. This is to prevent confusion going forward.

# Create a new text file and name it <code>pack.mcmeta</code>
#* Ensure that it doesn't end in other file extensions like .txt
# Open the file and insert the following data:
#* Hover over the underlined text to see more information.
{
"<abbr title="This lets Minecraft know that it is a datapack">pack</abbr>": {
"<abbr title="Here you will list the pack format number for a specific version of Minecraft">pack_format</abbr>": <abbr title="As of 1.20.1, the current resourcepack format number is 15. But it will still load if this number isn't correct!">15</abbr>,
"<abbr title="Here you will write a short description of your datapack">description</abbr>": "<abbr title="Your short datapack description">Example description</abbr>"
}
}
# <li value=3> Save the file and put it aside for now.
# Create a series of folders arranged like the following example:
==== Folder Structure ====
<div class="treeview">
*''(addon name)''
** '''pack.mcmeta'''
**assets
***cobblemon
****bedrock
*****pokemon
******animations
*******<target pokemon folder>
******models
*******<target pokemon folder>
******posers
******resolvers
*******<target pokemon folder>
****textures
*****pokemon
******<target pokemon folder>
**data
***cobblemon
****spawn_pool_world
****species_additions
****species_features
</div>
# <li value="5">Place the <code>pack.mcmeta</code> file into the first folder of your addon next to <code>assets</code> and <code>data</code>
After this folder tree for your addon is made, you can simply drop the files into the associated folders as you create them.
Remember that the <code>pack.mcmeta</code> is a file, not a folder to add. It must be one folder deep in order for Minecraft to recognize this pack as a resource pack or data pack when in the appropriate game folders.

=== Step 2: Create the assets for your regional variant ===
How you want your regional variant to look depends entirely on you. You can make it use a new texture over the original model. Most of the time, a new model, texture, and animations are created for this regional form. If for some reason you don't want it to have a visual difference at all, then you can skip anything regarding <code>assets</code>. Make sure your assets have a unique name so they don't overwrite any original form assets.

Assets for existing Pokémon can be obtained from the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/assets/cobblemon/bedrock/pokemon/models Gitlab] or the mod's JAR file. This can be helpful if you wanted to make a texture variant, or use the model as a base for the regional form. Just remember that animation files are made for specific models so they may need updating depending on what you make. These assets can be made in Blockbench or any relevant art apps.

# Create the regional form's <code>model</code>
# Create the regional form's <code>texture</code>
# Create the regional form's <code>animations</code>
# Export these files and place them into the appropriate folders in your addon pack
# Create a <code>[[poser]]</code> file for this regional form if new animations were created for the new model. (optional)

As knowledge of creating custom Pokémon is a requirement for this guide, you are expected to know how to make these files. Help can be found on the Cobblemon discord.

=== Step 3: Create a "species feature" ===
On the data side of things, the creation of a regional form starts with the [[Species_Features|species feature]]. A species feature is what allows a Pokémon to have a different set of stats and visuals applied to their regional forms. You will be creating a short JSON file that will be named after your custom region or idea. '''The feature can be named whatever you want it to be called.'''

# Create a new text file and name it after your region or idea. Include the extension of<code>.json</code>
#* Example: The alolan species feature is named <code>alolan.json</code>
#* Remember to use lowercase and make sure that the file does not end in any other extension like ".txt"
# Insert the following data into this new species feature JSON:
#* '''Remember to change <code>"custom_feature"</code> to match your file name! It must stay in quotes.'''
<syntaxhighlight>
{
"keys": ["custom_feature"],
"type": "flag",
"isAspect": true,
"default": false
}
</syntaxhighlight>
# <li value="3"> Save the file
# Place this new species feature file into the <code>species_feature</code> folder of your addon

<code>"isAspect": true</code> means that this new feature is both a <code>feature</code> and <code>aspect</code>!
Now that the species feature is made, you can apply it to a Pokémon's <code>form</code>

=== Step 4: Create a "species addition" file with "form" data ===
A <code>[[Species_Additions|species_addition]]</code> file is an efficient way of ''adding'' data to existing species files without having to rewrite the main species file. This allows your additions to be more compatible with other addons affecting the same Pokémon. You will be adding your regional <code>form</code> data to a species through this method.

# Create a new text file and name it after your Pokémon. Include the extension of <code>.json</code>
#* Example: <code>bulbasaur.json</code>
# Insert the following data into this new species_addition JSON:
<syntaxhighlight>
{
"target": "cobblemon:example",
"features": ["custom_feature"],
"forms": [
{
example form data
}
]
}
</syntaxhighlight>
# <li value="3"> Change <code>"cobblemon:example"</code> to reference the Pokémon you want to add a form to. It must remain in quotes.
#* Example: <code>"cobblemon:bulbasaur"</code>
# Change <code>"custom_feature"</code> to the feature you made earlier. It must remain in quotes.
# Write all the data for your form inside of the curly brackets
#* The average form data set is too long to list as an example for this guide. It's like writing data for an entirely different Pokémon, which is kind of what a regional variant is like.
#* If you need an example, you can look at the <code>"forms"</code> data for [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/resources/data/cobblemon/species/generation1/vulpix.json Vulpix on the Gitlab.] It starts on line 196 and ends on line 350.
#* Remember to include evolution data if this regional variant can evolve.
# Write your species feature name into the <code>"aspects"</code> section of your <code>"forms"</code> data.
#* Include the line for aspects if it doesn't exist yet. It should look like this:
<syntaxhighlight>
"aspects": ["custom_feature"]
</syntaxhighlight>
# <li value="7"> Save the file.
# Place this new species addition file into the <code>species_additions</code> folder of your addon.

Now your target Pokémon's new form should have the data that allows it to function differently in battles. Next you will create the data that allows it to spawn differently.

=== Step 5: Create the spawns for your regional form ===
The <code>[[Spawn_Pool_World|spawn_pool_world]]</code> folder holds all the spawning files for each Pokémon. You will be creating a new file for your regional variant. It can be as simple or complicated as you make it. It is recommended that you use the normal form's spawn file as a base for your regional form. Those spawn files can be found on the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/data/cobblemon/spawn_pool_world Gitlab.]

To keep things simple, this part of the guide will show you how to recycle a spawn file by changing the Pokémon name and biome conditions.
# Obtain your target Pokémon's <code>spawn_pool_world</code> JSON.
# Rename the file to anything you want. The name must be different than the original.
#* Example: <code>regional_bulbasaur</code>
# Open the file and locate all the strings for <code>"id"</code> and <code>"pokemon"</code>
# Edit the Pokémon's name '''and include''' the name of your species feature after like this example:
#* You must use a space after the Pokémon name for the <code>"pokemon"</code> string.
<syntaxhighlight>
"id": "bulbasaur-alolan-1",
"pokemon": "bulbasaur alolan",
</syntaxhighlight>
# <li value="5">Locate all the strings for <code>"biomes"</code> if they exist
# Change the listed biome(s) to something different!
#* This will allow the regional variant to spawn in biomes the normal variant does not.
#* The list of biome tags can be found [https://docs.google.com/document/d/1iB0EJSc2r6mRJXIo1n3XpHbZ5udwJVnrh2pXdhTyH8c/edit here.]
# Save the file
# Place this new spawn file in the <code>spawn_pool_world</code> folder of your addon

This should be the last of the data folder files. By now, your regional variant can stand on its own data-wise. It should have different stats, and spawns. Now it just needs a different look.

=== Step 6: Create the resolver file for your regional form ===
Back in step 2, you should have already made the files for <code>models</code>, <code>textures</code>, <code>animations</code>, and <code>posers</code>. The last thing you need to do is assign them to your regional variant by creating a new <code>[[resolver]]</code> file.

# Obtain your target Pokémon's <code>resolver</code> JSON.
# Change the name of this resolver to <code>1_<pokemon>_base</code>
#* You change the number from 0 to 1 so it can load after the normal variant's data
#* Sometimes a number greater than 1 is needed, especially if your target Pokémon has gender variants.
# Open the resolver file and locate the string for <code>"order"</code>.
# Change the value of "order" from 0 to 1.
#* Again, sometimes this value needs to be greater than 1.
# Add the name of your species feature to the <code>"aspects"</code> string
#* Example: <code>"aspects": ["alolan"]</code>
#* This allows any Pokémon that spawned with this feature/aspect to use any following model, textures, or poser.
# Assign any <code>poser</code>, <code>model</code>, or <code>textures</code> that you made in Step 2.
# Save the file
# Place this new resolver in the <code>resolvers</code> folder of your addon

=== Step 7: Test your addon in game ===
Load your addon in game to see if your regional form looks different from the normal one. You can have Blockbench open to edit any relevant asset file '''in the resourcepacks folder''' if needed.
# Copy your addon folder and place it in the "resourcepacks" and "datapacks" folder in the Minecraft root directory.
# Start up Minecraft and click on ''Options'', then ''Resource Packs''. Select your pack to load it.
# Load/create a '''Creative''' world save that contains your addon in the "datapack" folder.
# Once in the world, you can run the command <code>/pokespawn <target pokemon> <species feature></code>.
# Ensure your new regional form is working properly.
# Check if your regional form spawns where you assigned it to. You can use <code>/checkspawn <rarity></code> when in the assigned biome.
#* You can run the command <code>/locate biome <assigned biome></code> to get coordinates to the assigned biome. You can then click on the coordinates it gave you and be teleported instantly.
# Make any desired edits to the asset files and save. Refresh resource packs with F3+T to see the changes you make.
# Make any desired edits to the data files and save. '''You need to quit to main menu, and load the world again if you want to see those changes.'''
#* The command for <code>/reload</code> does not work with Cobblemon addons unfortunately.

You should now have a functional regional variant!

{{Addon Creation}}

Species

2024-12-21T08:35:08Z

Frank The Farmer: Updated links to fakemon generator

{{TOC|right}}
== Preface ==
The <code>species</code> JSON contains all the data of each Pokémon and its various forms. The species file is '''everything''' a Pokémon is without the visual aspects. Moves, abilities, forms, size, evolutions, and so much more are contained in this single file for every Pokémon. Cobblemon already includes most of this data for all 1,017 Pokémon.

Creating a custom Pokémon is as simple as creating a new species file! You can borrow an existing Pokémon's species file and swap the name for a new one or you can create a new file from scratch. It is highly recommended that you use the [https://tools.cobblemon.com/fakemon/ Cobblemon Fakemon Generator] to create new species files.

=== The Species File ===
The species file contains large amounts of data about Pokémon that connect to all the other systems that make Pokémon function in game. Some properties in the file are self explanatory, while others are not so clear. This section will provide lots of helpful information and links to help you understand all the different systems that connect to the species file.

==== Helpful Information ====
Some very helpful links and resources will be listed below. They can help you with understanding the mechanics of both the mod and Pokémon in general.

===== '''Where to get species files''' =====
* [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/data/cobblemon/species The Cobblemon Gitlab] - This is where Cobblemon's source code is hosted. You can find the species files of all Pokémon in that link. They should be in folders sorted by generation.

===== '''Where to find official Pokémon data''' =====
* [[bulbapedia:List of Pokémon by National Pokédex number|Bulbagarden]] - This website has information about Pokémon both from the games and the anime. You can find many references about each Pokémon here.
* [https://pokemondb.net/pokedex/all Pokémon Database] - This website has all kinds of information about Pokémon, but is more focused on stats. A lot of that data is the same or similar to what's written in the species files.
* [https://www.serebii.net/pokemon/nationalpokedex.shtml Serebii] - This website probably has the most information about Pokémon. Serebii provides accurate data and media references with images of these media appearances.


===== '''Behaviors and AI information''' =====
* [[Pokémon/Behaviour| Behavior Wiki Page]] - This wiki page will list and explain all the different behavior properties you can write for a Pokémon. This assigns the Pokémon its AI behavior. You can also copy a similar Pokémon's behavior code block if you are unsure how to create one.

===== '''Forms, Features, and Aspects''' =====
* [[Tutorials/Regional_Forms|Regional Forms]] - This links to a tutorial about setting up regional forms. Regional forms usually have different stats and this tutorial can show you how to set them up.
* [[Tutorials/Multiple_Visual_Variants|Multiple Visual Forms]] - This links to a tutorial about creating multiple visual forms like the different Torterra trees. These kinds of forms usually keep the same stats as the normal form and this tutorial can show you how to set them up.
* [[Species_Features|Species Features]] - This is the wiki page about species features. Features are what create "Aspects." Aspects are what allows for all the different visual forms for Pokémon.

===== '''Evolutions''' =====
* [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/data/cobblemon/species The Cobblemon Gitlab] - It is recommended that you use an existing Pokémon's evolution data as a template for evolutions. All existing evolution methods should be written into their respective pokemon's species file.
* [https://tools.cobblemon.com/fakemon/ Cobblemon Fakemon Generator] - You can also generate evolution methods using the Fakemon generator. It will give you all the evolution methods when creating new species files.
* [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/kotlin/com/cobblemon/mod/common/pokemon/evolution/requirements Evolution Requirements From the Cobblemon Gitlab] - This links to a folder on the gitlab that has the code files to all the possible evolution requirements for you to reference. All of these methods are used by at least one official Pokémon. It is recommended that you look up this Pokémon's species file to replicate its evolution method.


===== '''Shoulder Effects''' =====
Shoulder effects grant special buffs to the player if certain Pokémon are on their shoulders. Version 1.4 removed the shoulder effects so they could be rebalanced at a later date, but you can still apply effect data through datapacks. As of version 1.4, no shoulder mountable Pokémon has shoulder effect data in their species file.

If you wish to apply shoulder effect data to a Pokémon, you can include the following code block and switch the effect as you please:
* You can find a list of effects on the [https://minecraft.wiki/w/Effect#Effect_list Minecraft Wiki]. Mileage may vary.
"shoulderEffects": [
{
"type": "potion_effect",
"effect": "minecraft:slow_falling",
"amplifier": 0,
"ambient": true,
"showParticles": false,
"showIcon": false
}
]

Version 1.3 shoulder effects:
* <code>haste</code>
* <code>water_breathing</code>
* <code>speed</code>
* <code>slow_falling</code>


===== '''Moves and Learning Methods''' =====
This section of the species file determines the moves a Pokémon can learn. There are 4 methods of learning moves. Only 1 of them is currently implemented and that's <code>level</code> learning.

Every move from the official games should be in Cobblemon. In order for moves to be read properly, they must be written in the correct format for the move list. The method type goes on the left side of a colon and the move name goes on the right side of the colon. '''Moves that contain 2 or more words must be bunched together into one "word" and can't contain any spaces, underscores, commas, or hyphens.''' Everything must remain in lowercase as well.

Example of each method and name format:
* <code>"5:quickattack"</code> : '''Level''' - This would let a Pokémon learn <code>quick attack</code> at level 5. The number determines what level the move will be learned at.
* <code>"egg:thunder"</code> : '''Egg Move''' - This would let a Pokémon inherit <code>thunder</code> from one of its parents. It will hatch from its egg knowing this move when breeding gets implemented.
* <code>"tm:thunderbolt"</code> : '''TMs''' - This would allow a Pokémon to use a <code>thunderbolt</code> TM when TMs get implemented.
* <code>"tutor:10000000voltthunderbolt"</code> : '''Tutor''' - This would allow a Pokémon to learn <code>10,000,000 Volt Thunderbolt</code> from a tutor when tutors get implemented.

===== '''Item Drops''' =====
Cobblemon drops work differently than vanilla drops. You need to set a target amount of drops, then it tries to achieve this drop amount by rolling for drops in the entries listed. If an entry passes a percentage check, then it will count as 1 towards the targeted amount. Once this target amount is achieved, it will stop trying to roll for drops even if it did not finish reading all the entries. If it runs out of entries and did not achieve this target, then it will also stop rolling for drops. Once it stops rolling, all of the drops that passed the percentage check will drop where the Pokémon was defeated.

Example code block for drops:
* Since amount is set to 1 and there is only 1 entry, then it will only roll for drops from this 1 entry.
* The sweet berries entry does not list a percentage value, so by default its 100%.
* This would make Vulpix drop 2-3 berries 100% of the time
"drops": {
"amount": "1",
"entries": [
{
"item": "minecraft:sweet_berries",
"quantityRange": "2-3"
}
]
},


===== '''Hitbox and Base Scale''' =====
The size of the Pokémon model and its hitbox are controlled by the species file. If you want to change any of these values and see the results, '''you must load the singleplayer world from the main menu.''' The <code>/reload</code> command does not work with Cobblemon datapacks. Loading the world again is the proper way to refresh Cobblemon datapacks.
* <code>baseScale</code> will size the Pokémon up or down. A value of 1 will let the model be at a one to one scale with its size in blockbench.
* <code>hitbox</code> has 3 values you can change, but you will only want to change the <code>height</code> and <code>width</code> of the hitbox. In game, you can press <code>F3+B</code> to show the hitboxes on entities.
** Height is how many blocks high the Pokémon is.
** A hitbox width of 1 will let the hitbox be as wide as 1 Minecraft block with the Pokémon at the center of the hitbox. Width is akin to diameter, but it's Minecraft so everything is a cube. Try not to think about it too much.


===== '''Height and Weight''' =====
The height and weight that will be used for the Pokédex when it gets implemented. The unit for height is in decimeters. The unit for weight is in hectograms. Dividing these values by 10 will give you the metric units for meters and kilograms.
* <code>height</code> doesn't do anything significant and is misleading a lot of the time in the Pokédex. Sometimes it measures distance from the ground, and sometimes it measures how long a Pokémon is.
* <code>weight</code> will determine the damage value of weight based moves like heavy slam. Make sure you set these weights to hectograms or these moves may do unintentional amounts of damage.

====='''Gender'''=====
Gender is managed via the <code>maleRatio</code> property.
* This property should have a decimal value between 0 and 1, and is the percent chance for a Pokémon to spawn as a male.
** A value of <code>0.1</code> for example would lead to a 10% chance to spawn as a male.
* The special value of <code>-1</code> is reserved for genderless Pokémon.

===== '''Lighting Data''' =====
Lighting data allows for compatibility with some of the more popular dynamic lighting mods. A Pokémon can be assigned a light level and can be set to only emit light when on land, underwater, or both!
* <code>lightLevel</code> - The light level emitted by the Pokémon. A range of 0 to 15.
* <code>liquidGlowMode</code> - If the effect runs while in a liquid or on land. Your options are <code>LAND</code>, <code>UNDERWATER</code> or <code>BOTH</code>

Example code block for lightingData:
* Any pokemon assigned this data will emit a light level of 14 when on land
"lightingData": {
"lightLevel": 14,
"liquidGlowMode": "LAND"
}


==== Species File Breakdown ====
As far as the writer of this article is concerned, Vulpix has one of the most fleshed out species files. This makes Vulpix a great example to explain the different sections of the species file. You can reference some of the resources listed above and compare them with the written data below. Hover over the underlined text to see more information.
{
"<abbr title="Whether or not this pokémon is fully implemented. This determines whether it will show up in /spawnallpokemon or similar commands.">implemented</abbr>": <abbr title="Because it's set to true, vulpix will appear when using the /spawnallpokemon command.">true</abbr>,
"<abbr title="Here you will create the name of a new Pokémon species">name</abbr>": "<abbr title="The name of this species.">Vulpix</abbr>",
"<abbr title="The pokédex number for this pokémon -- currently not significant, but just in case, try and pick a unique digit above 2000.">nationalPokedexNumber</abbr>": <abbr title="This is Vulpix's national dex number!">37</abbr>,
"<abbr title="Elemental typings of your Pokémon, these are completely up to you. (But of course it must be an official typing.) You do not need to have a secondary typing if you don't want one.">primaryType</abbr>": "<abbr title="Vulpix is a fire type, so we assign it fire here.">fire</abbr>",
"<abbr title="Here we define the list of abilities. You can have up to two abilities listed, and one hidden ability.">abilities</abbr>": [
"<abbr title="This is Vulpix's first and only ability">flashfire</abbr>",
"<abbr title="This is Vulpix's hidden ability">h:drought</abbr>"
],
"<abbr title="The base stats of your Pokémon. Again, these are up to you. You can reference some official Pokémon stats and borrow them if you can't come up with your own.">baseStats</abbr>": {
"<abbr title="Determines the amount of health a Pokémon will have.">hp</abbr>": 38,
"<abbr title="Determines the damage dealt from physical attacks.">attack</abbr>": 41,
"<abbr title="Determines the damage reduction from physical attacks">defence</abbr>": 40,
"<abbr title="Determines the damage dealt from special attacks.">special_attack</abbr>": 50,
"<abbr title="Determines the damage reduction from special attacks.">special_defence</abbr>": 65,
"<abbr title="Determines if the Pokémon will move first in battle.">speed</abbr>": 65
},
"<abbr title="We define how the pokémon behaves here. You can reference the Behavior wiki page to see more information about this section.">behaviour</abbr>": {
"<abbr title="A set of properties relating to how and when the Pokémon sleeps, if it sleeps at all.">resting</abbr>": {
"<abbr title="A true/false value. If it's true, then it can fall asleep and use its sleep animations. You probably want this set to true always!">canSleep</abbr>": <abbr title="Setting it to true will allow Vulpix to fall asleep under the following conditions.">true</abbr>,
"<abbr title="A true/false value. If true, the Pokémon will try to sleep on top of the player's bed when they hop into it, much like cats.">willSleepOnBed</abbr>": <abbr title="If given the option, Vulpix will try to sleep on a player bed.">true</abbr>,
"<abbr title="Is this Pokémon a light sleeper or a heavy sleeper?">depth</abbr>": "<abbr title="The depth of the sleep. Normal means vulpix will wake up if the player is within 16 blocks and not sneaking.">normal</abbr>",
"<abbr title="A light level or level range, between 0 and 15, which represents the light levels in which the Pokémon is able to sleep.">light</abbr>": "<abbr title="Vulpix will attempt to sleep only if it's standing in a light level of 0-4.">0-4</abbr>"
}
},
"<abbr title="How easy it is to catch your pokémon. Larger numbers mean it's easier to catch.">catchRate</abbr>": <abbr title="Values over 100 are considered 'easier' captures. Since Vulpix is a pre evolution Pokémon, its capture rate is quite high.">190</abbr>,
"<abbr title="What percentage of this pokémon are male.">maleRatio</abbr>": <abbr title="Wild Vulpix have a 25% chance of being male. This means 75% of Vulpix spawns will be females.">0.25</abbr>,
"<abbr title="Determines whether or not this Pokémon can go on the players shoulder. You can set this to true for any Pokémon, but it most likely wont look good! It will use its ground idle animation on the player shoulder if there is no dedicated shoulder animation.">shoulderMountable</abbr>": <abbr title="Vulpix is unfortunately not a shoulder mountable Pokémon.">false</abbr>,
"<abbr title="A list of available forms for Vulpix. These forms will have their own set of stats. It's almost like writing a whole new Pokémon into this section.">forms</abbr>": [
{
"<abbr title="The name of this form.">name</abbr>": "<abbr title="We simply call it Alola. All the other Alolan Pokémon forms will share this same form name.">Alola</abbr>",
"<abbr title="Alolan Vulpix's type. Form types are usually different than the base form.">primaryType</abbr>": "<abbr title="Alolan Vulpix will be an ice type.">ice</abbr>",
"<abbr title="Here we will list Alolan Vulpix's abilities.">abilities</abbr>": [
"<abbr title="Alolan Vulpix's first and only ability.">snowcloak</abbr>",
"<abbr title="Alolan Vulpix's hidden ability">h:snowwarning</abbr>"
],
"<abbr title="The base stats for Alolan Vulpix. These are usually different than the base form.">baseStats</abbr>": {
"<abbr title="Determines the amount of health a Pokémon will have.">hp</abbr>": 38,
"<abbr title="Determines the damage dealt from physical attacks.">attack</abbr>": 41,
"<abbr title="Determines the damage reduction from physical attacks">defence</abbr>": 40,
"<abbr title="Determines the damage dealt from special attacks.">special_attack</abbr>": 50,
"<abbr title="Determines the damage reduction from special attacks.">special_defence</abbr>": 65,
"<abbr title="Determines if the Pokémon will move first in battle.">speed</abbr>": 65
},
"<abbr title="How easy it is to catch your pokémon. Larger numbers mean it's easier to catch.">catchRate</abbr>": <abbr title="Values over 100 are considered 'easier' captures. Since Alolan Vulpix is a pre evolution Pokémon, its capture rate is quite high.">190</abbr>,
"<abbr title="What percentage of this pokémon are male.">maleRatio</abbr>": <abbr title="Wild Alolan Vulpix have a 25% chance of being male. This means 75% of Alolan Vulpix spawns will be females.">0.25</abbr>,
"<abbr title="How many experience granted by this pokémon upon being defeated.">baseExperienceYield</abbr>": <abbr title="Weaker Pokémon usually have this value around 50.">60</abbr>,
"<abbr title="What this pokémon's friendship stat starts at when caught.">baseFriendship</abbr>": <abbr title="Most Pokémon have this value set to 50">50</abbr>,
"<abbr title="How many effort values this pokémon gives upon being defeated.">evYield</abbr>": {
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">hp</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">attack</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">defence</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">special_attack</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">special_defence</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">speed</abbr>": 1
},
"<abbr title="How quickly this Pokémon will level up. You can look this information up online.">experienceGroup</abbr>": "<abbr title="Alolan Vulpix will level up at a 'medium fast' rate.">medium_fast</abbr>",
"<abbr title="How long it takes for this pokémon's egg to hatch.">eggCycles</abbr>": <abbr title="A value of 20 is about how long it takes to hatch a starter Pokémon egg.">20</abbr>,
"<abbr title="What egg groups this Pokémon will be able to breed with. You can look this information up online.">eggGroups</abbr>": [
"<abbr title="The egg group of this pokemon.">field</abbr>"
],
"<abbr title="Here you will list what moves the pokemon can learn and how they will learn those moves. You can check this page's section for moves to see how to write them.">moves</abbr>": [
"<abbr title="This lets Alolan Vulpix learn powder snow at level 1">1:powdersnow</abbr>",
"<abbr title="This lets Alolan Vulpix learn tail whip at level 1">1:tailwhip</abbr>",
"4:disable",
"7:roar",
"8:iceshard",
"9:babydolleyes",
"12:spite",
"16:icywind",
"18:payback",
"20:confuseray",
"23:feintattack",
"24:aurorabeam",
"26:hex",
"28:extrasensory",
"32:icebeam",
"34:safeguard",
"36:imprison",
"40:mist",
"44:auroraveil",
"47:captivate",
"48:sheercold",
"52:grudge",
"56:blizzard",
"egg:agility",
"egg:babydolleyes",
"egg:charm",
"egg:disable",
"egg:encore",
"egg:extrasensory",
"egg:flail",
"egg:freezedry",
"egg:howl",
"egg:hypnosis",
"egg:moonblast",
"egg:powerswap",
"egg:roar",
"egg:secretpower",
"egg:spite",
"egg:tailslap",
"tm:agility",
"tm:attract",
"tm:auroraveil",
"tm:blizzard",
"tm:bodyslam",
"tm:charm",
"tm:confide",
"tm:darkpulse",
"tm:dig",
"tm:doubleteam",
"tm:drainingkiss",
"tm:encore",
"tm:endure",
"tm:facade",
"tm:foulplay",
"tm:frostbreath",
"tm:frustration",
"tm:hail",
"tm:hex",
"tm:hiddenpower",
"tm:icebeam",
"tm:icywind",
"tm:imprison",
"tm:irontail",
"tm:payback",
"tm:powerswap",
"tm:protect",
"tm:psychup",
"tm:raindance",
"tm:rest",
"tm:return",
"tm:roar",
"tm:round",
"tm:safeguard",
"tm:sleeptalk",
"tm:snore",
"tm:substitute",
"tm:swagger",
"tm:swift",
"tm:tailslap",
"tm:toxic",
"tm:weatherball",
"tm:zenheadbutt",
"tutor:aquatail",
"tutor:aurorabeam",
"tutor:babydolleyes",
"tutor:blizzard",
"tutor:celebrate",
"tutor:confuseray",
"tutor:covet",
"tutor:darkpulse",
"tutor:dazzlinggleam",
"tutor:dig",
"tutor:facade",
"tutor:foulplay",
"tutor:headbutt",
"tutor:healbell",
"tutor:icebeam",
"tutor:iceshard",
"tutor:icywind",
"tutor:irontail",
"tutor:mist",
"tutor:painsplit",
"tutor:powdersnow",
"tutor:protect",
"tutor:reflect",
"tutor:rest",
"tutor:roar",
"tutor:roleplay",
"tutor:snore",
"tutor:spite",
"tutor:substitute",
"tutor:tackle",
"tutor:tailwhip",
"tutor:toxic",
"tutor:zenheadbutt"
],
"<abbr title="Labels for this pokémon. There's no real use for labels yet.">labels</abbr>": [
"<abbr title="Label for a Pokémon introduced in generation 7">gen7</abbr>",
"<abbr title="Label for a Regional form from the alola region">alola_regional</abbr>"
],
"<abbr title="Aspects are what allows a Pokémon to change its visual aspects for things like regional forms. You can read about it in this page's section on forms.">aspects</abbr>": [
"<abbr title="Alolan Vulpix will receive the aspect for alolan. This will allow it to use the alolan aspect in the resolver file to assign the alolan model instead of the kantonian one.">alolan</abbr>"
],
"<abbr title="The Pokémon's height measured in decimeters">height</abbr>": 6,
"<abbr title="The Pokémon's weight measured in hectograms">weight</abbr>": 99,
"<abbr title="Here you will list any evolution methods the form will have. They are separate from the base forms evolutions.">evolutions</abbr>": [
{
"<abbr title="The name of this evolution entry.">id</abbr>": "<abbr title="The name of this evolution entry.">vulpix_ninetales</abbr>",
"<abbr title="The evolution variant it will use to evolve.">variant</abbr>": "<abbr title="In this case, you need to interact with an item. This is the same method as using an evolution stone to evolve. But it can be configured to be any item or modded item.">item_interact</abbr>",
"<abbr title="The Pokémon that this species will evolve into.">result</abbr>": "<abbr title="Here you are specifying that alolan vulpix will evolve into alolan ninetales. Remember to use this format when making evolution data for regional forms.">ninetales form=alola</abbr>",
"<abbr title="Whether or not its held item gets consumed when evolving.">consumeHeldItem</abbr>": <abbr title="A held item is not required for this evolution, so we will leave this false for now">false</abbr>,
"<abbr title="A list of moves this Pokémon will learn when it evolves.">learnableMoves</abbr>": [
"<abbr title="When evolving into Alolan Ninetales, it will learn dazzling gleam.">dazzlinggleam</abbr>"
],
"<abbr title="Here you will list some sub requirements for evolution. You can learn more about evolution requirements on this page's section of evolution">requirements</abbr>": <abbr title="There are no sub requirements for this evolution, so we leave these brackets blank.">[]</abbr>,
"<abbr title="Here you will list what item you need to interact with to make this Pokémon evolve.">requiredContext</abbr>": "<abbr title="In this case, we are using an ice stone from the Cobblemon mod. This can be changed to any vanilla or modded item as long as you use the proper item id.">cobblemon:ice_stone</abbr>"
}
],
"cannotDynamax</abbr>": false</abbr>,
"battleOnly</abbr>": false</abbr>
}
],
"<abbr title="Here you will list any features this pokemon has. Features come from the species feature folder of the mod. You can learn more about features from this page's section on forms and features.">features</abbr>": [
"<abbr title="Even though the alolan form's data is written above, Vulpix can't access that form data unless you list alolan as a feature like this. So remember to apply alolan as a feature and an aspect!">alolan</abbr>"
],
"<abbr title="How many experience granted by this pokémon upon being defeated.">baseExperienceYield</abbr>": <abbr title="Weaker Pokémon usually have this value around 50.">60</abbr>,
"<abbr title="How quickly this Pokémon will level up. You can look this information up online.">experienceGroup</abbr>": "<abbr title="Vulpix will level up at a 'medium fast' rate.">medium_fast</abbr>",
"<abbr title="How long it takes for this pokémon's egg to hatch.">eggCycles</abbr>": <abbr title="A value of 20 is about how long it takes to hatch a starter Pokémon egg.">20</abbr>,
"<abbr title="What egg groups this Pokémon will be able to breed with. You can look this information up online.">eggGroups</abbr>": [
"<abbr title="The egg group of this pokemon.">field</abbr>"
],
"drops": {
"amount": "1",
"entries": [
{
"item": "minecraft:sweet_berries",
"quantityRange": "2-3"
}
]
},
"<abbr title="Here you will list what moves the pokemon can learn and how they will learn those moves. You can check this page's section for moves to see how to write them.">moves</abbr>": [
"<abbr title="This allows Kantonian Vulpix to learn ember at level 1">1:ember</abbr>",
"<abbr title="This allows Kantonian Vulpix to learn tail whip at level 1">1:tailwhip</abbr>",
"4:disable",
"7:roar",
"8:quickattack",
"9:babydolleyes",
"12:spite",
"16:incinerate",
"18:payback",
"20:confuseray",
"23:feintattack",
"24:willowisp",
"26:hex",
"28:extrasensory",
"28:flameburst",
"32:flamethrower",
"36:imprison",
"40:firespin",
"44:safeguard",
"47:captivate",
"48:inferno",
"52:grudge",
"56:fireblast",
"egg:babydolleyes",
"egg:captivate",
"egg:disable",
"egg:energyball",
"egg:extrasensory",
"egg:feintattack",
"egg:flail",
"egg:flamecharge",
"egg:flareblitz",
"egg:heatwave",
"egg:hex",
"egg:howl",
"egg:hypnosis",
"egg:memento",
"egg:powerswap",
"egg:psychup",
"egg:roar",
"egg:secretpower",
"egg:spite",
"egg:tailslap",
"tm:agility",
"tm:attract",
"tm:bodyslam",
"tm:captivate",
"tm:confide",
"tm:darkpulse",
"tm:dig",
"tm:doubleteam",
"tm:encore",
"tm:endure",
"tm:energyball",
"tm:facade",
"tm:fireblast",
"tm:firespin",
"tm:flamecharge",
"tm:flamethrower",
"tm:flareblitz",
"tm:foulplay",
"tm:frustration",
"tm:heatwave",
"tm:hex",
"tm:hiddenpower",
"tm:imprison",
"tm:incinerate",
"tm:irontail",
"tm:mysticalfire",
"tm:naturalgift",
"tm:overheat",
"tm:payback",
"tm:powerswap",
"tm:protect",
"tm:psychup",
"tm:rest",
"tm:return",
"tm:roar",
"tm:round",
"tm:safeguard",
"tm:secretpower",
"tm:sleeptalk",
"tm:snore",
"tm:substitute",
"tm:sunnyday",
"tm:swagger",
"tm:swift",
"tm:tailslap",
"tm:toxic",
"tm:weatherball",
"tm:willowisp",
"tm:zenheadbutt",
"tutor:attract",
"tutor:bide",
"tutor:bodyslam",
"tutor:burningjealousy",
"tutor:charm",
"tutor:confuseray",
"tutor:covet",
"tutor:curse",
"tutor:darkpulse",
"tutor:dig",
"tutor:disable",
"tutor:doubleedge",
"tutor:doubleteam",
"tutor:ember",
"tutor:endure",
"tutor:facade",
"tutor:feintattack",
"tutor:fireblast",
"tutor:firespin",
"tutor:flail",
"tutor:flamethrower",
"tutor:foulplay",
"tutor:frustration",
"tutor:headbutt",
"tutor:heatwave",
"tutor:hiddenpower",
"tutor:hypnosis",
"tutor:irontail",
"tutor:mimic",
"tutor:ominouswind",
"tutor:painsplit",
"tutor:protect",
"tutor:quickattack",
"tutor:rage",
"tutor:reflect",
"tutor:rest",
"tutor:return",
"tutor:roar",
"tutor:roleplay",
"tutor:safeguard",
"tutor:skullbash",
"tutor:sleeptalk",
"tutor:snore",
"tutor:spite",
"tutor:substitute",
"tutor:sunnyday",
"tutor:swagger",
"tutor:swift",
"tutor:tackle",
"tutor:tailwhip",
"tutor:takedown",
"tutor:toxic",
"tutor:willowisp",
"tutor:zenheadbutt"
],
"<abbr title="Labels for this pokémon. There's no real use for labels yet.">labels</abbr>": [
"<abbr title="Label for a Pokémon introduced in generation 1">gen1</abbr>",
"<abbr title="Label for a Pokémon from the kanto region.">kanto_regional</abbr>"
],
"<abbr title="Here you can create a string for your pokedex entry. The entry itself is written in the lang file. You are simply creating something to define in the lang file here.">pokedex</abbr>": [
"<abbr title="This line can be translated to any language in the language files and include the actual pokedex entry.">cobblemon.species.vulpix.desc</abbr>"
],
"<abbr title="Here you will list any evolution methods">evolutions</abbr>": [
{
"<abbr title="The name of this evolution entry.">id</abbr>": "<abbr title="The name of this evolution entry.">vulpix_ninetales</abbr>",
"<abbr title="The evolution variant it will use to evolve.">variant</abbr>": "<abbr title="In this case, you need to interact with an item. This is the same method as using an evolution stone to evolve. But it can be configured to be any item or modded item.">item_interact</abbr>",
"<abbr title="The Pokémon that this species will evolve into.">result</abbr>": "<abbr title="Here you are specifying that vulpix will evolve into ninetales.">ninetales</abbr>",
"<abbr title="Whether or not its held item gets consumed when evolving.">consumeHeldItem</abbr>": <abbr title="A held item is not required for this evolution, so we will leave this false for now">false</abbr>,
"<abbr title="A list of moves this Pokémon will learn when it evolves.">learnableMoves</abbr>": <abbr title="Vulpix wont learn any special moves when it evolves into ninetales, so this will be left empty.">[]</abbr>,
"<abbr title="Here you will list some sub requirements for evolution. You can learn more about evolution requirements on this page's section of evolution">requirements</abbr>": <abbr title="There are no sub requirements for this evolution, so we leave these brackets blank.">[]</abbr>,
"<abbr title="Here you will list what item you need to interact with to make this Pokémon evolve.">requiredContext</abbr>": "<abbr title="In this case, we are using a fire stone from the Cobblemon mod. This can be changed to any vanilla or modded item as long as you use the proper item id.">cobblemon:fire_stone</abbr>"
}
],
"<abbr title="Determines the size of the model. Based on the size of the model in blockbench. A value of 1 will put it at a one to one scale with what you made in blockbench. Remember that you can't use the /reload command to see the changes you make here.">baseScale</abbr>": <abbr title="A value of 0.7 means the model will only be at 70% the size of what you made in blockbench. This can be useful for scaling models down so you can get more detail on smaller Pokémon like joltik.">0.7</abbr>,
"<abbr title="Here you will determine the size of this Pokémon's hitbox. You can learn more about it in this page's hitbox section.">hitbox</abbr>": {
"<abbr title="A width value of 1 should let the hitbox be the size of a normal block in minecraft. Play around with this value until it looks right to you.">width</abbr>": 0.9,
"<abbr title="A height value of 1 should let the hitbox be the size of a normal block in minecraft. Play around with this value until it looks right to you.">height</abbr>": 1.1,
"<abbr title="Determines whether the hitbox is fixed in place. This should most likely be set to false.">fixed</abbr>": false
},
"<abbr title="What this pokémon's friendship stat starts at when caught.">baseFriendship</abbr>": <abbr title="Most Pokémon have this value set to 50">50</abbr>,
"<abbr title="How many effort values this pokémon gives upon being defeated.">evYield</abbr>": {
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">hp</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">attack</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">defence</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">special_attack</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">special_defence</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">speed</abbr>": 1
},
"<abbr title="The Pokémon's height measured in decimeters">height</abbr>": 6,
"<abbr title="The Pokémon's weight measured in hectograms">weight</abbr>": 99,
"<abbr title="Aspects are what allows a Pokémon to change its visual aspects for things like regional forms. Since this is for Vulpix's normal form, you'll want to leave this blank. You can read about it in this page's section on forms.">aspects</abbr>": <abbr title="The normal form for Vulpix will receive no aspects so this is left blank. This can be considered a 'default' vulpix and it will use 'default' assets for its models and textures.">[]</abbr>,
"cannotDynamax": false
}

{{Addon Creation}}

Poser

2024-12-12T10:48:50Z

Frank The Farmer: Expanded on bedrock_primary function information

{{TOC|right}}
== Preface ==
The <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]


== Poser Properties ==
Before breaking down each section of the Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!


=== Rootbone ===
The <code>rootBone</code> property specifies what bone in the model will act as the root bone for generic animations not assigned in the poser such as the evolution animation. If the model was made following the standard bone format, then it should simply be the name of the Pokémon in lower case. Punctuation and capitalization matter! So make sure it matches the root bone of your model exactly.

You are '''required''' to assign this root bone properly or else it will break the model in certain generic animations! These animations animate the root bone and do not reset it to its original position when it finishes. This can cause model displacement after evolutions.

Below is a breakdown of the simple rootBone property:
"<abbr title="This property attempts to call the specified bone from the model to assign it as the root bone for generic animations.">rootBone</abbr>": "<abbr title="In this scenario, the charizard bone is being called. This charizard bone should contain all other bones so generic animations can move the entire model for whatever they animate.">charizard</abbr>",


=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a negative Z value that is some multiple of 5.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon.

For the sake of clarity, you should always refer to animations like faints, cries, or physicals as '''Named Animations'''. This is to help everyone distinguish them from the animations that are applied to poses. This distinction is important because you can assign both <code>animations</code> and <code>namedAnimations</code> to a pose. This is to allow you to assign different cries, faints, or attack animations to different poses like your floating or flying poses. This allows for water attack animations if you make the animation to support it. This process will be detailed later. Below is a list of currently available Named Animation types and Poses to choose from. 

==== Animations & Named Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.
* '''<battle_move>''': <code>animation.<pokemon>.<battle_move_name></code> - The animation that plays when a pokemon uses a specific move in battle. This animation property would assign a pokemon's animation to an '''existing''' action effect. Something like a custom flamethrower animation for Charizard or a Pokémon's signature move for example.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.


==== Basic Animation Calling Functions ====
Below are the 3 methods to call a <code>Pose</code> or <code>namedAnimation</code> animation. Each of them serve a purpose in layering animations on the Pokémon. <code>Pose</code> animations must always use <code>q.bedrock()</code> to serve as the base animation that can be overwritten by other animations when called. <code>NamedAnimations</code> can either use <code>q.bedrock_stateful()</code> to layer over the base animation or use <code>q.bedrock_primary()</code> to overwrite the base animation while it is playing. The default function used in each named animation type can be changed if your animation supports it. If you want the cry to overwrite rather than layer, then just be sure to animate it properly.


===== q.bedrock =====
The <code>q.bedrock()</code> function is the familiar animation calling format from the [[Old_Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},


===== q.bedrock_stateful =====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


===== q.bedrock_primary =====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


<code>q.bedrock_primary</code> comes with a couple of extra properties and they should be written in the following order:
# group: <code>'blastoise'</code> - The animation JSON that the game will search for the following animation. This should always be the name of a Pokémon.
# animation: <code>'status'</code> - The animation the game will call from the previously mentioned animation JSON. Primary animations are usually your attack animations or faints, but you can assign it to other named animations if desired.
# (optional) excluded labels: <code>'look'</code> - Exclusive labeled animations that wont get overwritten by this primary animation. The only reasonable use of excluded labels is to exclude the look animation from being overwritten. This is so they can keep looking at a target when using an animation.
# curve: <code>'q.curve('symmetrical_wide')'</code> - The interpolation curve that this primary animation will use to transition to and from the pose it is written under.


Since Primary animations behave in a similar way to swapping poses, they can use special interpolation curve types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 common primary animations in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', 'look', q.curve('symmetrical_wide'))"


====== q.curve ======
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",

=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting. 

List of Currently Implemented Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isInWaterOrRain"</code>: The Pokémon must be touching water or in rain. Again, not necessarily underwater.
* <code>"isUnderWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},


=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each placeholder features a very simple animation that swings a limb back and forth. For now, you'll have to figure out how to configure these yourself lol

Here is a list of all the Placeholder animations:
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L172 "q.quadruped_walk()"]</code> - A basic walk animation for Pokémon with 4 legs
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L192 "q.biped_walk()"]</code> - A basic walking animation for Pokémon who stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L208 "q.bimanual_swing()"]</code> - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L224 "q.sine_wing_flap()"]</code> - A basic wing flap animation for a pair of wings on a Pokémon.



== Poser File Breakdown ==
Soon™


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that not all Pokémon have a bone called <code>head</code>.

Here is an example of a poser file for a custom <code>riolu</code> that includes all currently implemented poses and their appropriate animations.
* Riolu obviously can't fly. This is just an example as no Pokémon can do everything currently.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 2.3,
"portraitTranslation": [-0.1, 0.58, 0],
"profileScale": 0.75,
"profileTranslation": [0, 0.68, 0],
"animations": {
"faint": "q.bedrock_primary('riolu', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('riolu', 'cry')",
"recoil": "q.bedrock_stateful('riolu', 'recoil')",
"physical": "q.bedrock_primary('riolu', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('riolu', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('riolu', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'battle_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('riolu', 'blink')"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"hover": {
"poseTypes": ["HOVER"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"fly": {
"poseTypes": ["FLY"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_fly')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('riolu', 'sleep')"]
},
"shoulder_left": {
"poseTypes": ["SHOULDER_LEFT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_left')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"shoulder_right": {
"poseTypes": ["SHOULDER_RIGHT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_right')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
}
}
}

{{Addon Creation}}

Poser

2024-12-12T07:00:28Z

Frank The Farmer: Expanded information on some existing properties. Updated conditions

{{TOC|right}}
== Preface ==
The <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]


== Poser Properties ==
Before breaking down each section of the Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!


=== Rootbone ===
The <code>rootBone</code> property specifies what bone in the model will act as the root bone for generic animations not assigned in the poser such as the evolution animation. If the model was made following the standard bone format, then it should simply be the name of the Pokémon in lower case. Punctuation and capitalization matter! So make sure it matches the root bone of your model exactly.

You are '''required''' to assign this root bone properly or else it will break the model in certain generic animations! These animations animate the root bone and do not reset it to its original position when it finishes. This can cause model displacement after evolutions.

Below is a breakdown of the simple rootBone property:
"<abbr title="This property attempts to call the specified bone from the model to assign it as the root bone for generic animations.">rootBone</abbr>": "<abbr title="In this scenario, the charizard bone is being called. This charizard bone should contain all other bones so generic animations can move the entire model for whatever they animate.">charizard</abbr>",


=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a negative Z value that is some multiple of 5.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon.

For the sake of clarity, you should always refer to animations like faints, cries, or physicals as '''Named Animations'''. This is to help everyone distinguish them from the animations that are applied to poses. This distinction is important because you can assign both <code>animations</code> and <code>namedAnimations</code> to a pose. This is to allow you to assign different cries, faints, or attack animations to different poses like your floating or flying poses. This allows for water attack animations if you make the animation to support it. This process will be detailed later. Below is a list of currently available Named Animation types and Poses to choose from. 

==== Animations & Named Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.
* '''<battle_move>''': <code>animation.<pokemon>.<battle_move_name></code> - The animation that plays when a pokemon uses a specific move in battle. This animation property would assign a pokemon's animation to an '''existing''' action effect. Something like a custom flamethrower animation for Charizard or a Pokémon's signature move for example.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.


==== Basic Animation Calling Functions ====
Below are the 3 methods to call a <code>Pose</code> or <code>namedAnimation</code> animation. Each of them serve a purpose in layering animations on the Pokémon. <code>Pose</code> animations must always use <code>q.bedrock()</code> to serve as the base animation that can be overwritten by other animations when called. <code>NamedAnimations</code> can either use <code>q.bedrock_stateful()</code> to layer over the base animation or use <code>q.bedrock_primary()</code> to overwrite the base animation while it is playing. The default function used in each named animation type can be changed if your animation supports it. If you want the cry to overwrite rather than layer, then just be sure to animate it properly.


===== q.bedrock =====
The <code>q.bedrock()</code> function is the familiar animation calling format from the [[Old_Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},


===== q.bedrock_stateful =====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


===== q.bedrock_primary =====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


Since Primary animations behave in a similar way to swapping poses, they can use special transition animation types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 primary animation in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"


====== q.curve ======
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",

=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting. 

List of Currently Implemented Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isInWaterOrRain"</code>: The Pokémon must be touching water or in rain. Again, not necessarily underwater.
* <code>"isUnderWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},


=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each placeholder features a very simple animation that swings a limb back and forth. For now, you'll have to figure out how to configure these yourself lol

Here is a list of all the Placeholder animations:
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L172 "q.quadruped_walk()"]</code> - A basic walk animation for Pokémon with 4 legs
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L192 "q.biped_walk()"]</code> - A basic walking animation for Pokémon who stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L208 "q.bimanual_swing()"]</code> - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L224 "q.sine_wing_flap()"]</code> - A basic wing flap animation for a pair of wings on a Pokémon.



== Poser File Breakdown ==
Soon™


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that not all Pokémon have a bone called <code>head</code>.

Here is an example of a poser file for a custom <code>riolu</code> that includes all currently implemented poses and their appropriate animations.
* Riolu obviously can't fly. This is just an example as no Pokémon can do everything currently.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 2.3,
"portraitTranslation": [-0.1, 0.58, 0],
"profileScale": 0.75,
"profileTranslation": [0, 0.68, 0],
"animations": {
"faint": "q.bedrock_primary('riolu', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('riolu', 'cry')",
"recoil": "q.bedrock_stateful('riolu', 'recoil')",
"physical": "q.bedrock_primary('riolu', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('riolu', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('riolu', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'battle_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('riolu', 'blink')"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"hover": {
"poseTypes": ["HOVER"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"fly": {
"poseTypes": ["FLY"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_fly')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('riolu', 'sleep')"]
},
"shoulder_left": {
"poseTypes": ["SHOULDER_LEFT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_left')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"shoulder_right": {
"poseTypes": ["SHOULDER_RIGHT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_right')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
}
}
}

{{Addon Creation}}

Old Poser

2024-12-12T05:24:19Z

Frank The Farmer: Old Poser update

{{TOC|right}}
== Preface ==
This page is for the now outdated poser json format. There is still backwards support for it in the mod, but there is no reason you should still be using it today. Please use the current [[Poser]] wiki page.

The <code>poser</code> JSON controls all the animations of a Pokémon. It contains information on when the Pokémon will perform certain animations. You can set your Pokémon to only ever perform one animation if you’d like, or you can give it different animations for just about every action it performs! It can even be used to adjust certain properties of an animation so you don't have to edit the animation itself.

Due to the way the official models are implemented, there are no official posers for them. Poser data for custom Pokémon is often shared amongst different addon creators. Help and techniques for poser files can be found in the Cobblemon Discord server.

=== Poser File Breakdown ===
The <code>poser</code> file requires an <code>animation</code> JSON to assign animations to a <code>model</code>. You're always going to want to be familiar with all the animations that were made for a model. If you assign an animation type that doesn't exist in the animation JSON then the game will crash! Also, if a bone you listed in the poser doesn't exist on the model then the game will crash! Once you figure out what animations were made for your target Pokémon model, you can simply apply the existing animations to appropriate <code>poses</code>.

Sometimes there may be animations that don't seem to have a matching pose, such as <code>blink</code> animations. These can be applied using the <code>quirk</code> animation system. This system allows you to layer certain animations over an animation that is already playing in game. Making use of the quirk system can really help your Pokémon feel more alive!

Here is a breakdown of an example poser file which includes all the different properties that can be assigned. Hover over the underlined text to see more information. '''Every kind of possible poser function is included in this example at least once! So make sure that you review the whole file to see why some things are written the way they are.''' This example is not meant to be used as a template.

{
"<abbr title="Tells the game which bone on the model is the head. In this case, the head bone is simply named head.">head</abbr>": "<abbr title="The bone from your model that will act as the head for the look animation that plays when a Pokémon wants to look in certain directions. Can be any other appropriate bone and not all Pokémon need to do this!">head</abbr>",
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileTranslation</abbr>": [0, 0.15, 0],
"<abbr title="This points to the faint animation for this Pokémon. If you have no faint animation, you can delete this line. Hover over each of the following words to see what each one means.">faint</abbr>": "<abbr title="Bedrock means that its checking for animations in the bedrock folder. This is where all animations should be stored.">bedrock</abbr>(<abbr title="Charizard is the prefix of the animation name that it's looking for. The animation it should be reading is named 'charizard.animation.faint' and its looking for all animations that start with 'charizard'.">charizard</abbr>, <abbr title="Faint is the suffix of the animation that it's looking for. This is usually named after animation types. The animation it should be reading is named 'charizard.animation.faint' and its looking for all animations that start with 'charizard' and end in 'faint'">faint</abbr>, <abbr title="This true or false value determines whether or not the selected animation will overwrite all other animations. This is important if you want to prioritize this animation over all others. In this case, the faint animation will always play over any other animation when the Pokémon faints! This can prevent the faint animation from not working sometimes.">true</abbr>)",
"<abbr title="This points to the cry animation for this Pokémon. Cries play whenever the Pokémon is called out of the pokeball. This occurs in and out of battle.">cry</abbr>": "<abbr title="This points towards charizard's cry animation">bedrock(charizard, cry)</abbr>",
"<abbr title="Here we are defining a list of our poses.">poses</abbr>": {
"<abbr title="The name of your pose. In this case, its called 'battle-idle'. Here, we will list animations that will play when the Pokémon is in battle.">battle-idle</abbr>": {
"<abbr title="Here we are defining the name of the pose.">poseName</abbr>": "<abbr title="The name of this pose is 'battle-idle'">battle-idle</abbr>",
"<abbr title="This is transition time between animations measured in minecraft ticks. You probably won't need to mess with this.>transformTicks</abbr>": 10,
"<abbr title="Here, we are telling the game when this animation will take place.">poseTypes</abbr>": [<abbr title="One of the pose types that will use the following animation. 'STAND - when stationary on the ground.' In the next line, we will define that the following animation will only work in battle">"STAND"</abbr>],
"<abbr title="This property controls whether the animation will play during battle or not.">isBattle</abbr>": <abbr title="Setting it to true will make the following animation play only while the Pokémon is idle while it's also in battle!">true</abbr>,
"<abbr title="This property controls whether the animation will play while the Pokémon is in water or not.">isTouchingWater</abbr>": <abbr title="Setting it to false will prevent the following animation from playing whenever the Pokémon touches water, but only while it's also in battle! So if this Pokémon starts battle in water, it is not allowed to use this pose and its assigned animation.">false</abbr>,
"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for this battle-idle pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for this battle-idle pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
],
"<abbr title="Here you will list which animations will play during these poses.">animations</abbr>": ["<abbr title="The animation you are telling it to use when your Pokémon is standing, while in battle, but not touching water.">bedrock(charizard, battle_idle)</abbr>"],
"<abbr title="This property allows you to play other animations over the main list of animations for this pose. The most common type of quirk animations are blinks, but you can apply any animation you wish as a quirk.">quirks</abbr>": [
{
"<abbr title="Here we are defining the name of this quirk">name</abbr>": "<abbr title="The name of this quirk will simply be called 'blink'.">blink</abbr>",
"<abbr title="The number of times the animation should play for the quirk. By default, this value is 1.">loopTimes</abbr>": <abbr title="For this example, we will let the blink animation play 5 times. After the blink plays 5 times, it will then start a timer before it can play again.">5</abbr>,
"<abbr title="The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time. Default value is 8.">minSecondsBetweenOccurrences</abbr>": <abbr title="After 8 seconds, there is a chance that this quirk animation will play.">8</abbr>,
"<abbr title="The decimal-friendly number of seconds that is the maximum between the quirk playing once and it playing a second time. Default value is 30.">maxSecondsBetweenOccurrences</abbr>": <abbr title="It will take 20 seconds at most for the quirk animation to play again.">20</abbr>,
"<abbr title="Here, you are going to list the animation that you want to play as a quirk. Given the data of the previous lines, this animation will play 5 times every 8-20 seconds.">animations</abbr>": ["<abbr title="This points towards charizard's blink animation">bedrock(charizard, blink)</abbr>"]
},
{
"<abbr title="Here we are defining the name of a second quirk">name</abbr>": "<abbr title="The name of this quirk will simply be called 'wing_Flap'.">wing_flap</abbr>",
"<abbr title="Here, you are going to list the animation that you want to play as a quirk. Since there is no data for loops or timers, then it will play at the default values. This would be once every 8-30 seconds.">animations</abbr>": ["<abbr title="This points towards charizard's wing flapping animation. This animation doesn't actually exist. Its only for the example.">bedrock(charizard, wing_flap)</abbr>"]
}
]
},
"<abbr title="Here we are defining the name of the pose.">standing</abbr>": {
"<abbr title="Here we are again defining the name of the pose.">poseName</abbr>": "<abbr title="The name of your pose. In this case, its called standing. The pose will control the idle animation for when the Pokémon is out of battle.">standing</abbr>",
"<abbr title="This is transition time between animations measured in minecraft ticks. You probably won't need to mess with this.>transformTicks</abbr>": 10,
"<abbr title="Here, we are telling the game when this animation will take place.">poseTypes</abbr>": ["<abbr title="One of the pose types that will use the following animation. STAND - when stationary on the ground">STAND</abbr>", "<abbr title="One of the pose types that will use the following animation. NONE - when not doing anything at all">NONE</abbr>", "<abbr title="One of the pose types that will use the following animation. PORTRAIT - when in a portrait like on your party UI">PORTRAIT</abbr>", "<abbr title="One of the pose types that will use the following animation. PROFILE - when in summary screens">PROFILE</abbr>" ],
"<abbr title="This property controls whether the animation will play during battle or not.">isBattle</abbr>": <abbr title="Setting it to false will prevent this animation from playing whenever the Pokémon is in battle. Setting it to false can prevent conflicts with the battle-idle pose. This one line helps separate the battle-idle from the normal idle.">false</abbr>,
"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model.">part</abbr>": "<abbr title="Here we are selecting charizard's right wing">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="We changed charizard's bone locations for the battle-idle. Here we are resetting them to their original location for the standing pose.">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose.">isVisible</abbr>": <abbr title="Here we are setting charizard's right wing to be visible for this pose.">true</abbr>
},
{
"<abbr title="Here, we are selecting a bone from the model.">part</abbr>": "<abbr title="Here we are selecting charizard's left wing">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="We changed charizard's bone locations for the battle-idle. Here we are resetting them to their original location for the standing pose.">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose.">isVisible</abbr>": <abbr title="Here we are setting charizard's left wing to be visible for this pose.">true</abbr>
}
],
"<abbr title="Here you will list which animations will play during these poses.">animations</abbr>": [
"<abbr title="Allows the Pokémon to move its head around to observe its surroundings. You can delete this if your Pokémon doesn't have a head bone, or you just don't want them looking around.">look</abbr>",
"<abbr title="The animation you are telling it to use when your Pokémon is standing while not in battle, doing nothing, or in the mod's UI. In this case, you are telling it to use its ground idle animation.">bedrock(charizard, ground_idle)</abbr>"
],
"<abbr title="This property allows you to play other animations over the main list of animations for this pose.">quirks</abbr>": [
{
"<abbr title="Here we are defining the name of this quirk">name</abbr>": "<abbr title="The name of this quirk will simply be called 'blink'.">blink</abbr>",
"<abbr title="Here, you are going to list the animation that you want to play as a quirk. Since there is no data for loops or timers, then it will play at the default values. This would be once every 8-30 seconds.">animations</abbr>": ["<abbr title="This points towards charizard's blink animation.">bedrock(charizard, blink)</abbr>"]
}
]
},
"<abbr title="Here we are defining the name of the pose.">walking</abbr>": {
"<abbr title="Here we are defining the name of the pose.">poseName</abbr>": "<abbr title="The name of your pose. In this case, its called walking">walking</abbr>",
"<abbr title="Here, we are telling the game when this animation will take place.">poseTypes</abbr>": ["<abbr title="One of the pose types that will use the following animation. WALK - when traveling on the ground">WALK</abbr>"],
"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model.">part</abbr>": "<abbr title="Here we are selecting charizard's right wing">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="We changed charizard's bone locations for the battle-idle. Here we are resetting them to their original location for the standing pose.">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose.">isVisible</abbr>": <abbr title="Here we are setting charizard's right wing to be visible for this pose.">true</abbr>
},
{
"<abbr title="Here, we are selecting a bone from the model.">part</abbr>": "<abbr title="Here we are selecting charizard's left wing">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="We changed charizard's bone locations for the battle-idle. Here we are resetting them to their original location for the standing pose.">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose.">isVisible</abbr>": <abbr title="Here we are setting charizard's left wing to be visible for this pose.">true</abbr>
}
],
"<abbr title="Here you will list which animations will play during this pose. In this case, we are listing 3 different animations that will layer over each other when they get played in game.">animations</abbr>": [
"<abbr title="Allows the Pokémon to move its head around to observe its surroundings. This animation has priority over head bone. This means the other 2 animations cant animated the head bone if charizard is looking at the player.">look</abbr>",
"<abbr title="This points to charizard's ground walk animation. Due to the way charizard's animations were made, this specified animation only animates the bottom half of charizard. If you do not include the matching ground idle after this, the arms of charizard will t-pose while it walks.">bedrock(charizard, ground_walk)</abbr>",
"<abbr title="This points to charizard's ground idle animation. Due to the way charizard's animations were made, this specified animation only animates the top half of charizard. Adding this animation will allow charizard's arms and wings to be animated while it walks.">bedrock(charizard, ground_idle)</abbr>"
],
"<abbr title="This property allows you to play other animations over the main list of animations for this pose.">quirks</abbr>": [
{
"<abbr title="Here we are defining the name of this quirk">name</abbr>": "<abbr title="The name of this quirk will simply be called 'blink'.">blink</abbr>",
"<abbr title="Here, you are going to list the animation that you want to play as a quirk. Since there is no data for loops or timers, then it will play at the default values. This would be once every 8-30 seconds.">animations</abbr>": ["<abbr title="This points towards charizard's blink animation.">bedrock(charizard, blink)</abbr>"]
}
]
}
}
}


=== Advanced Poser Functions And When to Use Them ===
Posers can do a lot more than just assign one animation to a pose. Certain things can be tweaked in the poser to make your Pokémon livelier in game. If you enjoy making many different animations for Pokémon, then this section will help you implement them in game. Using these advanced feature can help you make custom Pokémon that are on the same level of quality as the official Pokémon!

Remember that you can have an unzipped copy of your addon as a resourcepack in the game for easier editing. Since the poser file is a part of the resources of an addon, it can be refreshed in game by pressing <code>F3 + T</code>. This reloads all your resourcepacks and allows you to see the changes you've made to the poser only if the poser you are editing is in the resourcepack folder. '''It is highly recommended to use unzipped folders to test addon stuff when implementing them into the game!''' You can simply make your file edits, save the file, and then refresh your resourcepack in game to see the changes immediately!

==== Layered Animations ====
Layered animations are two or more animations that are listed together in your <code>animations</code> list. The most common example would be adding the <code>look</code> animation on top of your <code>ground_idle</code> animation for your standing pose. You're able to list more than two animations and your main limit would be running out of bones to animate.

The first animation listed should have priority control over the bones of the model. This is how Pokémon are able to look at you while walking around. The look animation has priority over the head bone, or whatever bone is listed as the head. This head bone will always attempt to look at a player if the player approaches.

Another example of layering animations would be having 2 kinds of animations that are meant to be played together and separate. A great example of this is charizard's walk animation. The walking animation itself only moves the legs for when it's walking. It combines the ground idle and the ground walk animations for its walking pose. The walk animation only controls the bottom half of the body, while the ground idle only controls the top half of the body. If you only listed its walk animation and it started walking, then the top half of charizard would t-pose whenever it walks.
Charizard's walking animation list for its walking pose:
"<abbr title="Here you will list which animations will play during these poses.">animations</abbr>": [
"<abbr title="Allows the Pokémon to move its head around to observe its surroundings. You can delete this if your Pokémon doesn't have a head bone, or you just don't want them looking around.">look</abbr>",
"<abbr title="This points to charizard's ground walk animation. Due to the way charizard's animations were made, this specified animation only animates the bottom half of charizard. If you do not include the matching ground idle after this, the arms of charizard will t-pose while it walks.">bedrock(charizard, ground_walk)</abbr>",
"<abbr title="This points to charizard's ground idle animation. Due to the way charizard's animations were made, this specified animation only animates the top half of charizard. Adding this animation will allow charizard's arms and wings to be animated while it walks.">bedrock(charizard, ground_idle)</abbr>"
]


==== Animation Overwrites ====
This function is mostly used for cases where you want an animation to be played exclusively for certain situations. You simply write <code>, true</code> after your animation type in your animations list. The most common use for this function would be writing it into your faint so the faint animation should always be playing when a Pokémon faints. Sometimes animations don't change properly and this can fix it most of the time.

Below is an example of the faint using this overwrite function. What's going to happen in game is that when charizard faints, it will always play the faint animation over other animations it was already doing. This is fine because the faint animation animates the whole model. The cry animation does not contain this function because we want the cry to play over the idle animation, but not completely overwrite everything! If it did, then charizard would t-pose whenever it tried to do it's cry animation because it only animates the head bone.

"<abbr title="This points to the faint animation for this Pokémon. If you have no faint animation, you can delete this line.">faint</abbr>": "<abbr title="This points to charizard's faint animation">bedrock(charizard, faint</abbr>, <abbr title="Adding 'true' like this will force this faint animation to play over all other animations whenever charizard faints.">true</abbr>)",
"<abbr title="This points to the cry animation for this Pokémon. Cries play whenever the Pokémon is called out of the pokeball. This occurs in and out of battle.">cry</abbr>": "<abbr title="This points to charizard's cry animation. Since it does not contain 'true' written after it, then this cry animation will not completely overwrite other animations when it plays. It should simply animate the bones it's supposed to while the rest of the bones can be controlled by another animation.">bedrock(charizard, cry)</abbr>",


==== Quirks ====
Quirk animations are extra animations that you can have play over the main animation list. What makes them different from the previous animation overwrite function is that these quirks can have extra properties applied to them. You can make them loop a certain number of times and include timers for these quirks. The most common example of a quirk animation would be the blink animations. By default, a quirk animation should play once every 8-20 seconds!

Making a quirk in your poser file would largely depend on an animator making these quirky little animations to play in game. You can do more than just blinking animations. You can make a Pokémon roar, sneeze, or dance and have it play as a quirk for its standing pose or any other pose. A timer can then be applied to these quirk animations so you could end up with something like charizard doing a roar every 30-60 seconds when its idle. It's a very flexible sub system for animations that is only limited by your creativity.

Here is a list of properties that can affect quirks:
"loopTimes": Int = 1 // The number of times the animation should play for the quirk
"minSecondsBetweenOccurrences": Float = 8 // The decimal-friendly number of seconds that is the
minimum between the quirk playing once and it playing a second time
"maxSecondsBetweenOccurrences": Float = 30 // What do you think
"animations": List<Animation> = [] // The list of animations to play (together) when this quirk runs
"name": String // The name of the quirk

Below is an example of a modified quirk animation. What this will do is eventually make charizard play the blink animation 5 times in a row. Then after the animation plays, an 8-20 second timer begins to play this quirk again. The quirk timer starts after the quirk animations end.

"<abbr title="This property allows you to play other animations over the main list of animations for this pose. The most common type of quirk animations are blinks, but you can apply any animation you wish as a quirk.">quirks</abbr>": [
{
"<abbr title="Here we are defining the name of this quirk">name</abbr>": "<abbr title="The name of this quirk will simply be called 'blink'.">blink</abbr>",
"<abbr title="The number of times the animation should play for the quirk. By default, this value is 1.">loopTimes</abbr>": <abbr title="For this example, we will let the blink animation play 5 times. After the blink plays 5 times, it will then start a timer before it can play again.">5</abbr>,
"<abbr title="The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time. Default value is 8.">minSecondsBetweenOccurrences</abbr>": <abbr title="After 8 seconds, there is a chance that this quirk animation will play.">8</abbr>,
"<abbr title="The decimal-friendly number of seconds that is the maximum between the quirk playing once and it playing a second time. Default value is 30.">maxSecondsBetweenOccurrences</abbr>": <abbr title="It will take 20 seconds at most for the quirk animation to play again.">20</abbr>,
"<abbr title="Here, you are going to list the animation that you want to play as a quirk. Given the data of the previous lines, this animation will play 5 times every 8-20 seconds.">animations</abbr>": ["<abbr title="This points towards charizard's blink animation">bedrock(charizard, blink)</abbr>"]
}


==== Transformed Parts ====
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


==== Animation Conditions ====
This function allows you to have more control over when an animation is allowed to play. The current conditions we can use are for battle and for touching water. This can be used to make animations specific to being in battle or in water. You can also mix and match the battle and water conditions if you really want more specific animations. This can result in having a ground idle, ground battle idle, water idle, and water battle idle!

This function is mostly for helping you organize your animations for each pose. Setting a condition to true will only allow the animation to play when this condition is met. Setting it to false will prevent the animation from being played when this condition is met. This allows you to set 2 or more animations per <code>poseType</code>. This basic fundamental is what allows us to have battle animations that can only play in battle!

Transformed parts work really well with this function! Combining these 2 functions is what allows Rillaboom to use its drum only when in battle. You can allow certain model parts to appear visible only when these conditions are met. Keep these functions in mind the next time you make a custom Pokémon model. You can create livelier animations using this system!

Below is an example of these animation conditions being used. In this example, the battle idle will only play when charizard is in battle, but never while charizard is in water.


"<abbr title="Here we are defining a list of our poses.">poses</abbr>": {
"<abbr title="The name of your pose. In this case, its called 'battle-idle'. Here, we will list animations that will play when the Pokémon is in battle.">battle-idle</abbr>": {
"<abbr title="Here we are defining the name of the pose.">poseName</abbr>": "<abbr title="The name of this pose is 'battle-idle'">battle-idle</abbr>",
"<abbr title="This is transition time between animations measured in minecraft ticks. You probably won't need to mess with this.>transformTicks</abbr>": 10,
"<abbr title="Here, we are telling the game when this animation will take place.">poseTypes</abbr>": [<abbr title="One of the pose types that will use the following animation. 'STAND - when stationary on the ground.' In the next line, we will define that the following animation will only work in battle">"STAND"</abbr>],
"<abbr title="This property controls whether the animation will play during battle or not.">isBattle</abbr>": <abbr title="Setting it to true will make the following animation play only while the Pokémon is idle while it's also in battle!">true</abbr>,
"<abbr title="This property controls whether the animation will play while the Pokémon is in water or not.">isTouchingWater</abbr>": <abbr title="Setting it to false will prevent the following animation from playing whenever the Pokémon touches water, but only while it's also in battle! So if this Pokémon starts battle in water, it is not allowed to use this pose and its assigned animation.">false</abbr>,
"<abbr title="Here you will list which animations will play during these poses.">animations</abbr>": ["<abbr title="The animation you are telling it to use when your Pokémon is standing, while in battle, but not touching water.">bedrock(charizard, battle_idle)</abbr>"]
},


=== Poser File Example ===
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that some Pokémon don't use a <code>head bone</code>.

Here is an example of a poser file for a custom <code>starly</code> that includes all currently implemented poses and their appropriate animations.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"head": "head",
"portraitScale": 2.3,
"portraitTranslation": [ -0.1, -0.9, 0 ],
"profileScale": 1.1,
"profileTranslation": [ -0.05, 0.15, 0 ],
"faint": "bedrock(starly, faint, true)",
"cry": "bedrock(starly, cry)",
"poses": {
"battle-idle": {
"poseName": "battle-idle",
"transformTicks": 10,
"poseTypes": ["STAND"],
"isBattle": true,
"animations": ["bedrock(starly, battle_idle)"],
"quirks": [
{
"name": "blink",
"animations": ["bedrock(starly, blink)"]
}
]
},
"standing": {
"poseName": "standing",
"transformTicks": 10,
"poseTypes": [
"STAND",
"NONE",
"PORTRAIT",
"PROFILE"
],
"isBattle": false,
"animations": [
"bedrock(starly, ground_idle)"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
},
"walking": {
"poseName": "walking",
"transformTicks": 10,
"poseTypes": [
"WALK"
],
"animations": [
"bedrock(starly, ground_walk)"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
},
"hovering": {
"poseName": "hovering",
"transformTicks": 10,
"poseTypes": [
"HOVER"
],
"animations": [
"bedrock(starly, air_idle)"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
},
"flying": {
"poseName": "flying",
"transformTicks": 10,
"poseTypes": [
"FLY"
],
"animations": [
"bedrock(starly, air_fly)"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
},
"sleeping": {
"poseName": "sleeping",
"transformTicks": 10,
"poseTypes": [
"SLEEP"
],
"animations": [
"bedrock(starly, sleep)"
]
},
"leftshoulder": {
"poseName": "leftshoulder",
"transformTicks": 10,
"poseTypes": [
"SHOULDER_LEFT"
],
"animations": [
"bedrock(starly, left_shoulder)",
"look"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
},
"rightshoulder": {
"poseName": "rightshoulder",
"transformTicks": 10,
"poseTypes": [
"SHOULDER_RIGHT"
],
"animations": [
"bedrock(starly, right_shoulder)",
"look"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
},
"swimming": {
"poseName": "swimming",
"transformTicks": 10,
"poseTypes": [
"SWIM"
],
"animations": [
"bedrock(starly, water_swim)"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
},
"floating": {
"poseName": "floating",
"transformTicks": 10,
"poseTypes": [
"FLOAT"
],
"animations": [
"bedrock(starly, water_idle)"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
}
}
}
{{Addon Creation}}

Poser

2024-12-12T05:23:15Z

Frank The Farmer: Quicksave. Poser page under construction

Under construction. Dont look or else!

{{TOC|right}}
== Preface ==
The new <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]


== Poser Properties ==
Before breaking down each section of the new Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!


=== Rootbone ===
The <code>rootBone</code> property specifies what bone in the model will act as the root bone for generic animations not assigned in the poser such as the evolution animation. If the model was made following the standard bone format, then it should simply be the name of the Pokémon in lower case. Punctuation and capitalization matter! So make sure it matches the root bone of your model exactly.

You are '''required''' to assign this root bone properly or else it will break the model in certain generic animations! These animations animate the root bone and do not reset it to its original position when it finishes. This can cause model displacement after evolutions.

Below is a breakdown of the simple rootBone property:
"<abbr title="This property attempts to call the specified bone from the model to assign it as the root bone for generic animations.">rootBone</abbr>": "<abbr title="In this scenario, the charizard bone is being called. This charizard bone should contain all other bones so generic animations can move the entire model for whatever they animate.">charizard</abbr>",


=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a negative Z value that is some multiple of 5.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon. Animation types would include your faints, cries, and attack animations. Below is a list of currently available Animation types and Poses to choose from. 

==== Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.
* '''<battle_move>''': <code>animation.<pokemon>.<battle_move_name></code> - The animation that plays when a pokemon uses a specific move in battle. This animation property would assign a pokemon's animation to an '''existing''' action effect. Something like a custom flamethrower animation for Charizard or a Pokémon's signature move for example.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.


==== q.bedrock ====
The <code>q.bedrock()</code> function is the familiar animation calling format from the [[Old_Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},


==== q.bedrock_stateful ====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


==== q.bedrock_primary ====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


Since Primary animations behave in a similar way to swapping poses, they can use special transition animation types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 primary animation in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"


==== q.curve ====
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",

=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting. 

List of Currently Implemented Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isTouchingWaterOrRain"</code>: The Pokémon must be touching water or rain. Again, not necessarily underwater.
* <code>"isSubmergedInWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},


=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each placeholder features a very simple animation that swings a limb back and forth. For now, you'll have to figure out how to configure these yourself lol

Here is a list of all the Placeholder animations:
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L172 "q.quadruped_walk()"]</code> - A basic walk animation for Pokémon with 4 legs
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L192 "q.biped_walk()"]</code> - A basic walking animation for Pokémon who stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L208 "q.bimanual_swing()"]</code> - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L224 "q.sine_wing_flap()"]</code> - A basic wing flap animation for a pair of wings on a Pokémon.



== Poser File Breakdown ==
Soon™


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that not all Pokémon have a bone called <code>head</code>.

Here is an example of a poser file for a custom <code>riolu</code> that includes all currently implemented poses and their appropriate animations.
* Riolu obviously can't fly. This is just an example as no Pokémon can do everything currently.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 2.3,
"portraitTranslation": [-0.1, 0.58, 0],
"profileScale": 0.75,
"profileTranslation": [0, 0.68, 0],
"animations": {
"faint": "q.bedrock_primary('riolu', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('riolu', 'cry')",
"recoil": "q.bedrock_stateful('riolu', 'recoil')",
"physical": "q.bedrock_primary('riolu', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('riolu', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('riolu', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'battle_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('riolu', 'blink')"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"hover": {
"poseTypes": ["HOVER"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"fly": {
"poseTypes": ["FLY"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_fly')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('riolu', 'sleep')"]
},
"shoulder_left": {
"poseTypes": ["SHOULDER_LEFT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_left')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"shoulder_right": {
"poseTypes": ["SHOULDER_RIGHT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_right')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
}
}
}

{{Addon Creation}}

Old Poser

2024-12-12T05:20:12Z

Frank The Farmer: Frank The Farmer moved page Poser to Old Poser: Outdated json. The new poser page will become the standard going forward and should no longer be called "New_Poser"

{{TOC|right}}
== Preface ==
The <code>poser</code> JSON controls all the animations of a Pokémon. It contains information on when the Pokémon will perform certain animations. You can set your Pokémon to only ever perform one animation if you’d like, or you can give it different animations for just about every action it performs! It can even be used to adjust certain properties of an animation so you don't have to edit the animation itself.

Due to the way the official models are implemented, there are no official posers for them. Poser data for custom Pokémon is often shared amongst different addon creators. Help and techniques for poser files can be found in the Cobblemon Discord server.

=== Poser File Breakdown ===
The <code>poser</code> file requires an <code>animation</code> JSON to assign animations to a <code>model</code>. You're always going to want to be familiar with all the animations that were made for a model. If you assign an animation type that doesn't exist in the animation JSON then the game will crash! Also, if a bone you listed in the poser doesn't exist on the model then the game will crash! Once you figure out what animations were made for your target Pokémon model, you can simply apply the existing animations to appropriate <code>poses</code>.

Sometimes there may be animations that don't seem to have a matching pose, such as <code>blink</code> animations. These can be applied using the <code>quirk</code> animation system. This system allows you to layer certain animations over an animation that is already playing in game. Making use of the quirk system can really help your Pokémon feel more alive!

Here is a breakdown of an example poser file which includes all the different properties that can be assigned. Hover over the underlined text to see more information. '''Every kind of possible poser function is included in this example at least once! So make sure that you review the whole file to see why some things are written the way they are.''' This example is not meant to be used as a template.

{
"<abbr title="Tells the game which bone on the model is the head. In this case, the head bone is simply named head.">head</abbr>": "<abbr title="The bone from your model that will act as the head for the look animation that plays when a Pokémon wants to look in certain directions. Can be any other appropriate bone and not all Pokémon need to do this!">head</abbr>",
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileTranslation</abbr>": [0, 0.15, 0],
"<abbr title="This points to the faint animation for this Pokémon. If you have no faint animation, you can delete this line. Hover over each of the following words to see what each one means.">faint</abbr>": "<abbr title="Bedrock means that its checking for animations in the bedrock folder. This is where all animations should be stored.">bedrock</abbr>(<abbr title="Charizard is the prefix of the animation name that it's looking for. The animation it should be reading is named 'charizard.animation.faint' and its looking for all animations that start with 'charizard'.">charizard</abbr>, <abbr title="Faint is the suffix of the animation that it's looking for. This is usually named after animation types. The animation it should be reading is named 'charizard.animation.faint' and its looking for all animations that start with 'charizard' and end in 'faint'">faint</abbr>, <abbr title="This true or false value determines whether or not the selected animation will overwrite all other animations. This is important if you want to prioritize this animation over all others. In this case, the faint animation will always play over any other animation when the Pokémon faints! This can prevent the faint animation from not working sometimes.">true</abbr>)",
"<abbr title="This points to the cry animation for this Pokémon. Cries play whenever the Pokémon is called out of the pokeball. This occurs in and out of battle.">cry</abbr>": "<abbr title="This points towards charizard's cry animation">bedrock(charizard, cry)</abbr>",
"<abbr title="Here we are defining a list of our poses.">poses</abbr>": {
"<abbr title="The name of your pose. In this case, its called 'battle-idle'. Here, we will list animations that will play when the Pokémon is in battle.">battle-idle</abbr>": {
"<abbr title="Here we are defining the name of the pose.">poseName</abbr>": "<abbr title="The name of this pose is 'battle-idle'">battle-idle</abbr>",
"<abbr title="This is transition time between animations measured in minecraft ticks. You probably won't need to mess with this.>transformTicks</abbr>": 10,
"<abbr title="Here, we are telling the game when this animation will take place.">poseTypes</abbr>": [<abbr title="One of the pose types that will use the following animation. 'STAND - when stationary on the ground.' In the next line, we will define that the following animation will only work in battle">"STAND"</abbr>],
"<abbr title="This property controls whether the animation will play during battle or not.">isBattle</abbr>": <abbr title="Setting it to true will make the following animation play only while the Pokémon is idle while it's also in battle!">true</abbr>,
"<abbr title="This property controls whether the animation will play while the Pokémon is in water or not.">isTouchingWater</abbr>": <abbr title="Setting it to false will prevent the following animation from playing whenever the Pokémon touches water, but only while it's also in battle! So if this Pokémon starts battle in water, it is not allowed to use this pose and its assigned animation.">false</abbr>,
"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for this battle-idle pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for this battle-idle pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
],
"<abbr title="Here you will list which animations will play during these poses.">animations</abbr>": ["<abbr title="The animation you are telling it to use when your Pokémon is standing, while in battle, but not touching water.">bedrock(charizard, battle_idle)</abbr>"],
"<abbr title="This property allows you to play other animations over the main list of animations for this pose. The most common type of quirk animations are blinks, but you can apply any animation you wish as a quirk.">quirks</abbr>": [
{
"<abbr title="Here we are defining the name of this quirk">name</abbr>": "<abbr title="The name of this quirk will simply be called 'blink'.">blink</abbr>",
"<abbr title="The number of times the animation should play for the quirk. By default, this value is 1.">loopTimes</abbr>": <abbr title="For this example, we will let the blink animation play 5 times. After the blink plays 5 times, it will then start a timer before it can play again.">5</abbr>,
"<abbr title="The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time. Default value is 8.">minSecondsBetweenOccurrences</abbr>": <abbr title="After 8 seconds, there is a chance that this quirk animation will play.">8</abbr>,
"<abbr title="The decimal-friendly number of seconds that is the maximum between the quirk playing once and it playing a second time. Default value is 30.">maxSecondsBetweenOccurrences</abbr>": <abbr title="It will take 20 seconds at most for the quirk animation to play again.">20</abbr>,
"<abbr title="Here, you are going to list the animation that you want to play as a quirk. Given the data of the previous lines, this animation will play 5 times every 8-20 seconds.">animations</abbr>": ["<abbr title="This points towards charizard's blink animation">bedrock(charizard, blink)</abbr>"]
},
{
"<abbr title="Here we are defining the name of a second quirk">name</abbr>": "<abbr title="The name of this quirk will simply be called 'wing_Flap'.">wing_flap</abbr>",
"<abbr title="Here, you are going to list the animation that you want to play as a quirk. Since there is no data for loops or timers, then it will play at the default values. This would be once every 8-30 seconds.">animations</abbr>": ["<abbr title="This points towards charizard's wing flapping animation. This animation doesn't actually exist. Its only for the example.">bedrock(charizard, wing_flap)</abbr>"]
}
]
},
"<abbr title="Here we are defining the name of the pose.">standing</abbr>": {
"<abbr title="Here we are again defining the name of the pose.">poseName</abbr>": "<abbr title="The name of your pose. In this case, its called standing. The pose will control the idle animation for when the Pokémon is out of battle.">standing</abbr>",
"<abbr title="This is transition time between animations measured in minecraft ticks. You probably won't need to mess with this.>transformTicks</abbr>": 10,
"<abbr title="Here, we are telling the game when this animation will take place.">poseTypes</abbr>": ["<abbr title="One of the pose types that will use the following animation. STAND - when stationary on the ground">STAND</abbr>", "<abbr title="One of the pose types that will use the following animation. NONE - when not doing anything at all">NONE</abbr>", "<abbr title="One of the pose types that will use the following animation. PORTRAIT - when in a portrait like on your party UI">PORTRAIT</abbr>", "<abbr title="One of the pose types that will use the following animation. PROFILE - when in summary screens">PROFILE</abbr>" ],
"<abbr title="This property controls whether the animation will play during battle or not.">isBattle</abbr>": <abbr title="Setting it to false will prevent this animation from playing whenever the Pokémon is in battle. Setting it to false can prevent conflicts with the battle-idle pose. This one line helps separate the battle-idle from the normal idle.">false</abbr>,
"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model.">part</abbr>": "<abbr title="Here we are selecting charizard's right wing">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="We changed charizard's bone locations for the battle-idle. Here we are resetting them to their original location for the standing pose.">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose.">isVisible</abbr>": <abbr title="Here we are setting charizard's right wing to be visible for this pose.">true</abbr>
},
{
"<abbr title="Here, we are selecting a bone from the model.">part</abbr>": "<abbr title="Here we are selecting charizard's left wing">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="We changed charizard's bone locations for the battle-idle. Here we are resetting them to their original location for the standing pose.">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose.">isVisible</abbr>": <abbr title="Here we are setting charizard's left wing to be visible for this pose.">true</abbr>
}
],
"<abbr title="Here you will list which animations will play during these poses.">animations</abbr>": [
"<abbr title="Allows the Pokémon to move its head around to observe its surroundings. You can delete this if your Pokémon doesn't have a head bone, or you just don't want them looking around.">look</abbr>",
"<abbr title="The animation you are telling it to use when your Pokémon is standing while not in battle, doing nothing, or in the mod's UI. In this case, you are telling it to use its ground idle animation.">bedrock(charizard, ground_idle)</abbr>"
],
"<abbr title="This property allows you to play other animations over the main list of animations for this pose.">quirks</abbr>": [
{
"<abbr title="Here we are defining the name of this quirk">name</abbr>": "<abbr title="The name of this quirk will simply be called 'blink'.">blink</abbr>",
"<abbr title="Here, you are going to list the animation that you want to play as a quirk. Since there is no data for loops or timers, then it will play at the default values. This would be once every 8-30 seconds.">animations</abbr>": ["<abbr title="This points towards charizard's blink animation.">bedrock(charizard, blink)</abbr>"]
}
]
},
"<abbr title="Here we are defining the name of the pose.">walking</abbr>": {
"<abbr title="Here we are defining the name of the pose.">poseName</abbr>": "<abbr title="The name of your pose. In this case, its called walking">walking</abbr>",
"<abbr title="Here, we are telling the game when this animation will take place.">poseTypes</abbr>": ["<abbr title="One of the pose types that will use the following animation. WALK - when traveling on the ground">WALK</abbr>"],
"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model.">part</abbr>": "<abbr title="Here we are selecting charizard's right wing">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="We changed charizard's bone locations for the battle-idle. Here we are resetting them to their original location for the standing pose.">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose.">isVisible</abbr>": <abbr title="Here we are setting charizard's right wing to be visible for this pose.">true</abbr>
},
{
"<abbr title="Here, we are selecting a bone from the model.">part</abbr>": "<abbr title="Here we are selecting charizard's left wing">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="We changed charizard's bone locations for the battle-idle. Here we are resetting them to their original location for the standing pose.">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose.">isVisible</abbr>": <abbr title="Here we are setting charizard's left wing to be visible for this pose.">true</abbr>
}
],
"<abbr title="Here you will list which animations will play during this pose. In this case, we are listing 3 different animations that will layer over each other when they get played in game.">animations</abbr>": [
"<abbr title="Allows the Pokémon to move its head around to observe its surroundings. This animation has priority over head bone. This means the other 2 animations cant animated the head bone if charizard is looking at the player.">look</abbr>",
"<abbr title="This points to charizard's ground walk animation. Due to the way charizard's animations were made, this specified animation only animates the bottom half of charizard. If you do not include the matching ground idle after this, the arms of charizard will t-pose while it walks.">bedrock(charizard, ground_walk)</abbr>",
"<abbr title="This points to charizard's ground idle animation. Due to the way charizard's animations were made, this specified animation only animates the top half of charizard. Adding this animation will allow charizard's arms and wings to be animated while it walks.">bedrock(charizard, ground_idle)</abbr>"
],
"<abbr title="This property allows you to play other animations over the main list of animations for this pose.">quirks</abbr>": [
{
"<abbr title="Here we are defining the name of this quirk">name</abbr>": "<abbr title="The name of this quirk will simply be called 'blink'.">blink</abbr>",
"<abbr title="Here, you are going to list the animation that you want to play as a quirk. Since there is no data for loops or timers, then it will play at the default values. This would be once every 8-30 seconds.">animations</abbr>": ["<abbr title="This points towards charizard's blink animation.">bedrock(charizard, blink)</abbr>"]
}
]
}
}
}


=== Advanced Poser Functions And When to Use Them ===
Posers can do a lot more than just assign one animation to a pose. Certain things can be tweaked in the poser to make your Pokémon livelier in game. If you enjoy making many different animations for Pokémon, then this section will help you implement them in game. Using these advanced feature can help you make custom Pokémon that are on the same level of quality as the official Pokémon!

Remember that you can have an unzipped copy of your addon as a resourcepack in the game for easier editing. Since the poser file is a part of the resources of an addon, it can be refreshed in game by pressing <code>F3 + T</code>. This reloads all your resourcepacks and allows you to see the changes you've made to the poser only if the poser you are editing is in the resourcepack folder. '''It is highly recommended to use unzipped folders to test addon stuff when implementing them into the game!''' You can simply make your file edits, save the file, and then refresh your resourcepack in game to see the changes immediately!

==== Layered Animations ====
Layered animations are two or more animations that are listed together in your <code>animations</code> list. The most common example would be adding the <code>look</code> animation on top of your <code>ground_idle</code> animation for your standing pose. You're able to list more than two animations and your main limit would be running out of bones to animate.

The first animation listed should have priority control over the bones of the model. This is how Pokémon are able to look at you while walking around. The look animation has priority over the head bone, or whatever bone is listed as the head. This head bone will always attempt to look at a player if the player approaches.

Another example of layering animations would be having 2 kinds of animations that are meant to be played together and separate. A great example of this is charizard's walk animation. The walking animation itself only moves the legs for when it's walking. It combines the ground idle and the ground walk animations for its walking pose. The walk animation only controls the bottom half of the body, while the ground idle only controls the top half of the body. If you only listed its walk animation and it started walking, then the top half of charizard would t-pose whenever it walks.
Charizard's walking animation list for its walking pose:
"<abbr title="Here you will list which animations will play during these poses.">animations</abbr>": [
"<abbr title="Allows the Pokémon to move its head around to observe its surroundings. You can delete this if your Pokémon doesn't have a head bone, or you just don't want them looking around.">look</abbr>",
"<abbr title="This points to charizard's ground walk animation. Due to the way charizard's animations were made, this specified animation only animates the bottom half of charizard. If you do not include the matching ground idle after this, the arms of charizard will t-pose while it walks.">bedrock(charizard, ground_walk)</abbr>",
"<abbr title="This points to charizard's ground idle animation. Due to the way charizard's animations were made, this specified animation only animates the top half of charizard. Adding this animation will allow charizard's arms and wings to be animated while it walks.">bedrock(charizard, ground_idle)</abbr>"
]


==== Animation Overwrites ====
This function is mostly used for cases where you want an animation to be played exclusively for certain situations. You simply write <code>, true</code> after your animation type in your animations list. The most common use for this function would be writing it into your faint so the faint animation should always be playing when a Pokémon faints. Sometimes animations don't change properly and this can fix it most of the time.

Below is an example of the faint using this overwrite function. What's going to happen in game is that when charizard faints, it will always play the faint animation over other animations it was already doing. This is fine because the faint animation animates the whole model. The cry animation does not contain this function because we want the cry to play over the idle animation, but not completely overwrite everything! If it did, then charizard would t-pose whenever it tried to do it's cry animation because it only animates the head bone.

"<abbr title="This points to the faint animation for this Pokémon. If you have no faint animation, you can delete this line.">faint</abbr>": "<abbr title="This points to charizard's faint animation">bedrock(charizard, faint</abbr>, <abbr title="Adding 'true' like this will force this faint animation to play over all other animations whenever charizard faints.">true</abbr>)",
"<abbr title="This points to the cry animation for this Pokémon. Cries play whenever the Pokémon is called out of the pokeball. This occurs in and out of battle.">cry</abbr>": "<abbr title="This points to charizard's cry animation. Since it does not contain 'true' written after it, then this cry animation will not completely overwrite other animations when it plays. It should simply animate the bones it's supposed to while the rest of the bones can be controlled by another animation.">bedrock(charizard, cry)</abbr>",


==== Quirks ====
Quirk animations are extra animations that you can have play over the main animation list. What makes them different from the previous animation overwrite function is that these quirks can have extra properties applied to them. You can make them loop a certain number of times and include timers for these quirks. The most common example of a quirk animation would be the blink animations. By default, a quirk animation should play once every 8-20 seconds!

Making a quirk in your poser file would largely depend on an animator making these quirky little animations to play in game. You can do more than just blinking animations. You can make a Pokémon roar, sneeze, or dance and have it play as a quirk for its standing pose or any other pose. A timer can then be applied to these quirk animations so you could end up with something like charizard doing a roar every 30-60 seconds when its idle. It's a very flexible sub system for animations that is only limited by your creativity.

Here is a list of properties that can affect quirks:
"loopTimes": Int = 1 // The number of times the animation should play for the quirk
"minSecondsBetweenOccurrences": Float = 8 // The decimal-friendly number of seconds that is the
minimum between the quirk playing once and it playing a second time
"maxSecondsBetweenOccurrences": Float = 30 // What do you think
"animations": List<Animation> = [] // The list of animations to play (together) when this quirk runs
"name": String // The name of the quirk

Below is an example of a modified quirk animation. What this will do is eventually make charizard play the blink animation 5 times in a row. Then after the animation plays, an 8-20 second timer begins to play this quirk again. The quirk timer starts after the quirk animations end.

"<abbr title="This property allows you to play other animations over the main list of animations for this pose. The most common type of quirk animations are blinks, but you can apply any animation you wish as a quirk.">quirks</abbr>": [
{
"<abbr title="Here we are defining the name of this quirk">name</abbr>": "<abbr title="The name of this quirk will simply be called 'blink'.">blink</abbr>",
"<abbr title="The number of times the animation should play for the quirk. By default, this value is 1.">loopTimes</abbr>": <abbr title="For this example, we will let the blink animation play 5 times. After the blink plays 5 times, it will then start a timer before it can play again.">5</abbr>,
"<abbr title="The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time. Default value is 8.">minSecondsBetweenOccurrences</abbr>": <abbr title="After 8 seconds, there is a chance that this quirk animation will play.">8</abbr>,
"<abbr title="The decimal-friendly number of seconds that is the maximum between the quirk playing once and it playing a second time. Default value is 30.">maxSecondsBetweenOccurrences</abbr>": <abbr title="It will take 20 seconds at most for the quirk animation to play again.">20</abbr>,
"<abbr title="Here, you are going to list the animation that you want to play as a quirk. Given the data of the previous lines, this animation will play 5 times every 8-20 seconds.">animations</abbr>": ["<abbr title="This points towards charizard's blink animation">bedrock(charizard, blink)</abbr>"]
}


==== Transformed Parts ====
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


==== Animation Conditions ====
This function allows you to have more control over when an animation is allowed to play. The current conditions we can use are for battle and for touching water. This can be used to make animations specific to being in battle or in water. You can also mix and match the battle and water conditions if you really want more specific animations. This can result in having a ground idle, ground battle idle, water idle, and water battle idle!

This function is mostly for helping you organize your animations for each pose. Setting a condition to true will only allow the animation to play when this condition is met. Setting it to false will prevent the animation from being played when this condition is met. This allows you to set 2 or more animations per <code>poseType</code>. This basic fundamental is what allows us to have battle animations that can only play in battle!

Transformed parts work really well with this function! Combining these 2 functions is what allows Rillaboom to use its drum only when in battle. You can allow certain model parts to appear visible only when these conditions are met. Keep these functions in mind the next time you make a custom Pokémon model. You can create livelier animations using this system!

Below is an example of these animation conditions being used. In this example, the battle idle will only play when charizard is in battle, but never while charizard is in water.


"<abbr title="Here we are defining a list of our poses.">poses</abbr>": {
"<abbr title="The name of your pose. In this case, its called 'battle-idle'. Here, we will list animations that will play when the Pokémon is in battle.">battle-idle</abbr>": {
"<abbr title="Here we are defining the name of the pose.">poseName</abbr>": "<abbr title="The name of this pose is 'battle-idle'">battle-idle</abbr>",
"<abbr title="This is transition time between animations measured in minecraft ticks. You probably won't need to mess with this.>transformTicks</abbr>": 10,
"<abbr title="Here, we are telling the game when this animation will take place.">poseTypes</abbr>": [<abbr title="One of the pose types that will use the following animation. 'STAND - when stationary on the ground.' In the next line, we will define that the following animation will only work in battle">"STAND"</abbr>],
"<abbr title="This property controls whether the animation will play during battle or not.">isBattle</abbr>": <abbr title="Setting it to true will make the following animation play only while the Pokémon is idle while it's also in battle!">true</abbr>,
"<abbr title="This property controls whether the animation will play while the Pokémon is in water or not.">isTouchingWater</abbr>": <abbr title="Setting it to false will prevent the following animation from playing whenever the Pokémon touches water, but only while it's also in battle! So if this Pokémon starts battle in water, it is not allowed to use this pose and its assigned animation.">false</abbr>,
"<abbr title="Here you will list which animations will play during these poses.">animations</abbr>": ["<abbr title="The animation you are telling it to use when your Pokémon is standing, while in battle, but not touching water.">bedrock(charizard, battle_idle)</abbr>"]
},


=== Poser File Example ===
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that some Pokémon don't use a <code>head bone</code>.

Here is an example of a poser file for a custom <code>starly</code> that includes all currently implemented poses and their appropriate animations.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"head": "head",
"portraitScale": 2.3,
"portraitTranslation": [ -0.1, -0.9, 0 ],
"profileScale": 1.1,
"profileTranslation": [ -0.05, 0.15, 0 ],
"faint": "bedrock(starly, faint, true)",
"cry": "bedrock(starly, cry)",
"poses": {
"battle-idle": {
"poseName": "battle-idle",
"transformTicks": 10,
"poseTypes": ["STAND"],
"isBattle": true,
"animations": ["bedrock(starly, battle_idle)"],
"quirks": [
{
"name": "blink",
"animations": ["bedrock(starly, blink)"]
}
]
},
"standing": {
"poseName": "standing",
"transformTicks": 10,
"poseTypes": [
"STAND",
"NONE",
"PORTRAIT",
"PROFILE"
],
"isBattle": false,
"animations": [
"bedrock(starly, ground_idle)"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
},
"walking": {
"poseName": "walking",
"transformTicks": 10,
"poseTypes": [
"WALK"
],
"animations": [
"bedrock(starly, ground_walk)"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
},
"hovering": {
"poseName": "hovering",
"transformTicks": 10,
"poseTypes": [
"HOVER"
],
"animations": [
"bedrock(starly, air_idle)"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
},
"flying": {
"poseName": "flying",
"transformTicks": 10,
"poseTypes": [
"FLY"
],
"animations": [
"bedrock(starly, air_fly)"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
},
"sleeping": {
"poseName": "sleeping",
"transformTicks": 10,
"poseTypes": [
"SLEEP"
],
"animations": [
"bedrock(starly, sleep)"
]
},
"leftshoulder": {
"poseName": "leftshoulder",
"transformTicks": 10,
"poseTypes": [
"SHOULDER_LEFT"
],
"animations": [
"bedrock(starly, left_shoulder)",
"look"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
},
"rightshoulder": {
"poseName": "rightshoulder",
"transformTicks": 10,
"poseTypes": [
"SHOULDER_RIGHT"
],
"animations": [
"bedrock(starly, right_shoulder)",
"look"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
},
"swimming": {
"poseName": "swimming",
"transformTicks": 10,
"poseTypes": [
"SWIM"
],
"animations": [
"bedrock(starly, water_swim)"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
},
"floating": {
"poseName": "floating",
"transformTicks": 10,
"poseTypes": [
"FLOAT"
],
"animations": [
"bedrock(starly, water_idle)"
],
"quirks": [
{
"name": "blink",
"animations": [
"bedrock(starly, blink)"
]
}
]
}
}
}
{{Addon Creation}}

Poser

2024-12-12T03:56:45Z

Frank The Farmer: Tweak to Translation information

Under construction. Dont look or else!

{{TOC|right}}
== Preface ==
The new <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]

== Poser Properties ==
Before breaking down each section of the new Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!

=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon. Animation types would include your faints, cries, and attack animations. Below is a list of currently available Animation types and Poses to choose from. 

==== Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.

==== q.bedrock_stateful ====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


==== q.bedrock_primary ====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


Since Primary animations behave in a similar way to swapping poses, they can use special transition animation types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 primary animation in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"


==== q.curve ====
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",

==== q.bedrock ====
The <code>q.bedrock()</code> function is the familiar animation format from the [[Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},

=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a negative Z value that is some multiple of 5.

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting. 

List of Currently Implemented Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isTouchingWaterOrRain"</code>: The Pokémon must be touching water or rain. Again, not necessarily underwater.
* <code>"isSubmergedInWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},


=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each placeholder features a very simple animation that swings a limb back and forth. For now, you'll have to figure out how to configure these yourself lol

Here is a list of all the Placeholder animations:
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L172 "q.quadruped_walk()"]</code> - A basic walk animation for Pokémon with 4 legs
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L192 "q.biped_walk()"]</code> - A basic walking animation for Pokémon who stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L208 "q.bimanual_swing()"]</code> - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L224 "q.sine_wing_flap()"]</code> - A basic wing flap animation for a pair of wings on a Pokémon.



== Poser File Breakdown ==
Soon™


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that not all Pokémon have a bone called <code>head</code>.

Here is an example of a poser file for a custom <code>riolu</code> that includes all currently implemented poses and their appropriate animations.
* Riolu obviously can't fly. This is just an example as no Pokémon can do everything currently.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 2.3,
"portraitTranslation": [-0.1, 0.58, 0],
"profileScale": 0.75,
"profileTranslation": [0, 0.68, 0],
"animations": {
"faint": "q.bedrock_primary('riolu', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('riolu', 'cry')",
"recoil": "q.bedrock_stateful('riolu', 'recoil')",
"physical": "q.bedrock_primary('riolu', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('riolu', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('riolu', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'battle_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('riolu', 'blink')"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"hover": {
"poseTypes": ["HOVER"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"fly": {
"poseTypes": ["FLY"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_fly')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('riolu', 'sleep')"]
},
"shoulder_left": {
"poseTypes": ["SHOULDER_LEFT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_left')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"shoulder_right": {
"poseTypes": ["SHOULDER_RIGHT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_right')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
}
}
}

{{Addon Creation}}

Species

2024-08-20T23:14:43Z

Frank The Farmer: Fakemon Generator Link updated

{{TOC|right}}
== Preface ==
The <code>species</code> JSON contains all the data of each Pokémon and its various forms. The species file is '''everything''' a Pokémon is without the visual aspects. Moves, abilities, forms, size, evolutions, and so much more are contained in this single file for every Pokémon. Cobblemon already includes most of this data for all 1,017 Pokémon.

Creating a custom Pokémon is as simple as creating a new species file! You can borrow an existing Pokémon's species file and swap the name for a new one or you can create a new file from scratch. It is highly recommended that you use the [https://cobblemon-fakemon-generator.timinc.us/ Cobblemon Fakemon Generator] to create new species files.

=== The Species File ===
The species file contains large amounts of data about Pokémon that connect to all the other systems that make Pokémon function in game. Some properties in the file are self explanatory, while others are not so clear. This section will provide lots of helpful information and links to help you understand all the different systems that connect to the species file.

==== Helpful Information ====
Some very helpful links and resources will be listed below. They can help you with understanding the mechanics of both the mod and Pokémon in general.

===== '''Where to get species files''' =====
* [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/data/cobblemon/species The Cobblemon Gitlab] - This is where Cobblemon's source code is hosted. You can find the species files of all Pokémon in that link. They should be in folders sorted by generation.

===== '''Where to find official Pokémon data''' =====
* [[bulbapedia:List of Pokémon by National Pokédex number|Bulbagarden]] - This website has information about Pokémon both from the games and the anime. You can find many references about each Pokémon here.
* [https://pokemondb.net/pokedex/all Pokémon Database] - This website has all kinds of information about Pokémon, but is more focused on stats. A lot of that data is the same or similar to what's written in the species files.
* [https://www.serebii.net/pokemon/nationalpokedex.shtml Serebii] - This website probably has the most information about Pokémon. Serebii provides accurate data and media references with images of these media appearances.


===== '''Behaviors and AI information''' =====
* [[Pokémon/Behaviour| Behavior Wiki Page]] - This wiki page will list and explain all the different behavior properties you can write for a Pokémon. This assigns the Pokémon its AI behavior. You can also copy a similar Pokémon's behavior code block if you are unsure how to create one.

===== '''Forms, Features, and Aspects''' =====
* [[Tutorials/Regional_Forms|Regional Forms]] - This links to a tutorial about setting up regional forms. Regional forms usually have different stats and this tutorial can show you how to set them up.
* [[Tutorials/Multiple_Visual_Variants|Multiple Visual Forms]] - This links to a tutorial about creating multiple visual forms like the different Torterra trees. These kinds of forms usually keep the same stats as the normal form and this tutorial can show you how to set them up.
* [[Species_Features|Species Features]] - This is the wiki page about species features. Features are what create "Aspects." Aspects are what allows for all the different visual forms for Pokémon.

===== '''Evolutions''' =====
* [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/data/cobblemon/species The Cobblemon Gitlab] - It is recommended that you use an existing Pokémon's evolution data as a template for evolutions. All existing evolution methods should be written into their respective pokemon's species file.
* [https://tmetcalfe89.github.io/cobblemon-fakemon-generator/ Cobblemon Fakemon Generator] - You can also generate evolution methods using the Fakemon generator. It will give you all the evolution methods when creating new species files.
* [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/kotlin/com/cobblemon/mod/common/pokemon/evolution/requirements Evolution Requirements From the Cobblemon Gitlab] - This links to a folder on the gitlab that has the code files to all the possible evolution requirements for you to reference. All of these methods are used by at least one official Pokémon. It is recommended that you look up this Pokémon's species file to replicate its evolution method.


===== '''Shoulder Effects''' =====
Shoulder effects grant special buffs to the player if certain Pokémon are on their shoulders. Version 1.4 removed the shoulder effects so they could be rebalanced at a later date, but you can still apply effect data through datapacks. As of version 1.4, no shoulder mountable Pokémon has shoulder effect data in their species file.

If you wish to apply shoulder effect data to a Pokémon, you can include the following code block and switch the effect as you please:
* You can find a list of effects on the [https://minecraft.wiki/w/Effect#Effect_list Minecraft Wiki]. Mileage may vary.
"shoulderEffects": [
{
"type": "potion_effect",
"effect": "minecraft:slow_falling",
"amplifier": 0,
"ambient": true,
"showParticles": false,
"showIcon": false
}
]

Version 1.3 shoulder effects:
* <code>haste</code>
* <code>water_breathing</code>
* <code>speed</code>
* <code>slow_falling</code>


===== '''Moves and Learning Methods''' =====
This section of the species file determines the moves a Pokémon can learn. There are 4 methods of learning moves. Only 1 of them is currently implemented and that's <code>level</code> learning.

Every move from the official games should be in Cobblemon. In order for moves to be read properly, they must be written in the correct format for the move list. The method type goes on the left side of a colon and the move name goes on the right side of the colon. '''Moves that contain 2 or more words must be bunched together into one "word" and can't contain any spaces, underscores, commas, or hyphens.''' Everything must remain in lowercase as well.

Example of each method and name format:
* <code>"5:quickattack"</code> : '''Level''' - This would let a Pokémon learn <code>quick attack</code> at level 5. The number determines what level the move will be learned at.
* <code>"egg:thunder"</code> : '''Egg Move''' - This would let a Pokémon inherit <code>thunder</code> from one of its parents. It will hatch from its egg knowing this move when breeding gets implemented.
* <code>"tm:thunderbolt"</code> : '''TMs''' - This would allow a Pokémon to use a <code>thunderbolt</code> TM when TMs get implemented.
* <code>"tutor:10000000voltthunderbolt"</code> : '''Tutor''' - This would allow a Pokémon to learn <code>10,000,000 Volt Thunderbolt</code> from a tutor when tutors get implemented.

===== '''Item Drops''' =====
Cobblemon drops work differently than vanilla drops. You need to set a target amount of drops, then it tries to achieve this drop amount by rolling for drops in the entries listed. If an entry passes a percentage check, then it will count as 1 towards the targeted amount. Once this target amount is achieved, it will stop trying to roll for drops even if it did not finish reading all the entries. If it runs out of entries and did not achieve this target, then it will also stop rolling for drops. Once it stops rolling, all of the drops that passed the percentage check will drop where the Pokémon was defeated.

Example code block for drops:
* Since amount is set to 1 and there is only 1 entry, then it will only roll for drops from this 1 entry.
* The sweet berries entry does not list a percentage value, so by default its 100%.
* This would make Vulpix drop 2-3 berries 100% of the time
"drops": {
"amount": "1",
"entries": [
{
"item": "minecraft:sweet_berries",
"quantityRange": "2-3"
}
]
},


===== '''Hitbox and Base Scale''' =====
The size of the Pokémon model and its hitbox are controlled by the species file. If you want to change any of these values and see the results, '''you must load the singleplayer world from the main menu.''' The <code>/reload</code> command does not work with Cobblemon datapacks. Loading the world again is the proper way to refresh Cobblemon datapacks.
* <code>baseScale</code> will size the Pokémon up or down. A value of 1 will let the model be at a one to one scale with its size in blockbench.
* <code>hitbox</code> has 3 values you can change, but you will only want to change the <code>height</code> and <code>width</code> of the hitbox. In game, you can press <code>F3+B</code> to show the hitboxes on entities.
** Height is how many blocks high the Pokémon is.
** A hitbox width of 1 will let the hitbox be as wide as 1 Minecraft block with the Pokémon at the center of the hitbox. Width is akin to diameter, but it's Minecraft so everything is a cube. Try not to think about it too much.


===== '''Height and Weight''' =====
The height and weight that will be used for the Pokédex when it gets implemented. The unit for height is in decimeters. The unit for weight is in hectograms. Dividing these values by 10 will give you the metric units for meters and kilograms.
* <code>height</code> doesn't do anything significant and is misleading a lot of the time in the Pokédex. Sometimes it measures distance from the ground, and sometimes it measures how long a Pokémon is.
* <code>weight</code> will determine the damage value of weight based moves like heavy slam. Make sure you set these weights to hectograms or these moves may do unintentional amounts of damage.

====='''Gender'''=====
Gender is managed via the <code>maleRatio</code> property.
* This property should have a decimal value between 0 and 1, and is the percent chance for a Pokémon to spawn as a male.
** A value of <code>0.1</code> for example would lead to a 10% chance to spawn as a male.
* The special value of <code>-1</code> is reserved for genderless Pokémon.

===== '''Lighting Data''' =====
Lighting data allows for compatibility with some of the more popular dynamic lighting mods. A Pokémon can be assigned a light level and can be set to only emit light when on land, underwater, or both!
* <code>lightLevel</code> - The light level emitted by the Pokémon. A range of 0 to 15.
* <code>liquidGlowMode</code> - If the effect runs while in a liquid or on land. Your options are <code>LAND</code>, <code>UNDERWATER</code> or <code>BOTH</code>

Example code block for lightingData:
* Any pokemon assigned this data will emit a light level of 14 when on land
"lightingData": {
"lightLevel": 14,
"liquidGlowMode": "LAND"
}


==== Species File Breakdown ====
As far as the writer of this article is concerned, Vulpix has one of the most fleshed out species files. This makes Vulpix a great example to explain the different sections of the species file. You can reference some of the resources listed above and compare them with the written data below. Hover over the underlined text to see more information.
{
"<abbr title="Whether or not this pokémon is fully implemented. This determines whether it will show up in /spawnallpokemon or similar commands.">implemented</abbr>": <abbr title="Because it's set to true, vulpix will appear when using the /spawnallpokemon command.">true</abbr>,
"<abbr title="Here you will create the name of a new Pokémon species">name</abbr>": "<abbr title="The name of this species.">Vulpix</abbr>",
"<abbr title="The pokédex number for this pokémon -- currently not significant, but just in case, try and pick a unique digit above 2000.">nationalPokedexNumber</abbr>": <abbr title="This is Vulpix's national dex number!">37</abbr>,
"<abbr title="Elemental typings of your Pokémon, these are completely up to you. (But of course it must be an official typing.) You do not need to have a secondary typing if you don't want one.">primaryType</abbr>": "<abbr title="Vulpix is a fire type, so we assign it fire here.">fire</abbr>",
"<abbr title="Here we define the list of abilities. You can have up to two abilities listed, and one hidden ability.">abilities</abbr>": [
"<abbr title="This is Vulpix's first and only ability">flashfire</abbr>",
"<abbr title="This is Vulpix's hidden ability">h:drought</abbr>"
],
"<abbr title="The base stats of your Pokémon. Again, these are up to you. You can reference some official Pokémon stats and borrow them if you can't come up with your own.">baseStats</abbr>": {
"<abbr title="Determines the amount of health a Pokémon will have.">hp</abbr>": 38,
"<abbr title="Determines the damage dealt from physical attacks.">attack</abbr>": 41,
"<abbr title="Determines the damage reduction from physical attacks">defence</abbr>": 40,
"<abbr title="Determines the damage dealt from special attacks.">special_attack</abbr>": 50,
"<abbr title="Determines the damage reduction from special attacks.">special_defence</abbr>": 65,
"<abbr title="Determines if the Pokémon will move first in battle.">speed</abbr>": 65
},
"<abbr title="We define how the pokémon behaves here. You can reference the Behavior wiki page to see more information about this section.">behaviour</abbr>": {
"<abbr title="A set of properties relating to how and when the Pokémon sleeps, if it sleeps at all.">resting</abbr>": {
"<abbr title="A true/false value. If it's true, then it can fall asleep and use its sleep animations. You probably want this set to true always!">canSleep</abbr>": <abbr title="Setting it to true will allow Vulpix to fall asleep under the following conditions.">true</abbr>,
"<abbr title="A true/false value. If true, the Pokémon will try to sleep on top of the player's bed when they hop into it, much like cats.">willSleepOnBed</abbr>": <abbr title="If given the option, Vulpix will try to sleep on a player bed.">true</abbr>,
"<abbr title="Is this Pokémon a light sleeper or a heavy sleeper?">depth</abbr>": "<abbr title="The depth of the sleep. Normal means vulpix will wake up if the player is within 16 blocks and not sneaking.">normal</abbr>",
"<abbr title="A light level or level range, between 0 and 15, which represents the light levels in which the Pokémon is able to sleep.">light</abbr>": "<abbr title="Vulpix will attempt to sleep only if it's standing in a light level of 0-4.">0-4</abbr>"
}
},
"<abbr title="How easy it is to catch your pokémon. Larger numbers mean it's easier to catch.">catchRate</abbr>": <abbr title="Values over 100 are considered 'easier' captures. Since Vulpix is a pre evolution Pokémon, its capture rate is quite high.">190</abbr>,
"<abbr title="What percentage of this pokémon are male.">maleRatio</abbr>": <abbr title="Wild Vulpix have a 25% chance of being male. This means 75% of Vulpix spawns will be females.">0.25</abbr>,
"<abbr title="Determines whether or not this Pokémon can go on the players shoulder. You can set this to true for any Pokémon, but it most likely wont look good! It will use its ground idle animation on the player shoulder if there is no dedicated shoulder animation.">shoulderMountable</abbr>": <abbr title="Vulpix is unfortunately not a shoulder mountable Pokémon.">false</abbr>,
"<abbr title="A list of available forms for Vulpix. These forms will have their own set of stats. It's almost like writing a whole new Pokémon into this section.">forms</abbr>": [
{
"<abbr title="The name of this form.">name</abbr>": "<abbr title="We simply call it Alola. All the other Alolan Pokémon forms will share this same form name.">Alola</abbr>",
"<abbr title="Alolan Vulpix's type. Form types are usually different than the base form.">primaryType</abbr>": "<abbr title="Alolan Vulpix will be an ice type.">ice</abbr>",
"<abbr title="Here we will list Alolan Vulpix's abilities.">abilities</abbr>": [
"<abbr title="Alolan Vulpix's first and only ability.">snowcloak</abbr>",
"<abbr title="Alolan Vulpix's hidden ability">h:snowwarning</abbr>"
],
"<abbr title="The base stats for Alolan Vulpix. These are usually different than the base form.">baseStats</abbr>": {
"<abbr title="Determines the amount of health a Pokémon will have.">hp</abbr>": 38,
"<abbr title="Determines the damage dealt from physical attacks.">attack</abbr>": 41,
"<abbr title="Determines the damage reduction from physical attacks">defence</abbr>": 40,
"<abbr title="Determines the damage dealt from special attacks.">special_attack</abbr>": 50,
"<abbr title="Determines the damage reduction from special attacks.">special_defence</abbr>": 65,
"<abbr title="Determines if the Pokémon will move first in battle.">speed</abbr>": 65
},
"<abbr title="How easy it is to catch your pokémon. Larger numbers mean it's easier to catch.">catchRate</abbr>": <abbr title="Values over 100 are considered 'easier' captures. Since Alolan Vulpix is a pre evolution Pokémon, its capture rate is quite high.">190</abbr>,
"<abbr title="What percentage of this pokémon are male.">maleRatio</abbr>": <abbr title="Wild Alolan Vulpix have a 25% chance of being male. This means 75% of Alolan Vulpix spawns will be females.">0.25</abbr>,
"<abbr title="How many experience granted by this pokémon upon being defeated.">baseExperienceYield</abbr>": <abbr title="Weaker Pokémon usually have this value around 50.">60</abbr>,
"<abbr title="What this pokémon's friendship stat starts at when caught.">baseFriendship</abbr>": <abbr title="Most Pokémon have this value set to 50">50</abbr>,
"<abbr title="How many effort values this pokémon gives upon being defeated.">evYield</abbr>": {
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">hp</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">attack</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">defence</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">special_attack</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">special_defence</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">speed</abbr>": 1
},
"<abbr title="How quickly this Pokémon will level up. You can look this information up online.">experienceGroup</abbr>": "<abbr title="Alolan Vulpix will level up at a 'medium fast' rate.">medium_fast</abbr>",
"<abbr title="How long it takes for this pokémon's egg to hatch.">eggCycles</abbr>": <abbr title="A value of 20 is about how long it takes to hatch a starter Pokémon egg.">20</abbr>,
"<abbr title="What egg groups this Pokémon will be able to breed with. You can look this information up online.">eggGroups</abbr>": [
"<abbr title="The egg group of this pokemon.">field</abbr>"
],
"<abbr title="Here you will list what moves the pokemon can learn and how they will learn those moves. You can check this page's section for moves to see how to write them.">moves</abbr>": [
"<abbr title="This lets Alolan Vulpix learn powder snow at level 1">1:powdersnow</abbr>",
"<abbr title="This lets Alolan Vulpix learn tail whip at level 1">1:tailwhip</abbr>",
"4:disable",
"7:roar",
"8:iceshard",
"9:babydolleyes",
"12:spite",
"16:icywind",
"18:payback",
"20:confuseray",
"23:feintattack",
"24:aurorabeam",
"26:hex",
"28:extrasensory",
"32:icebeam",
"34:safeguard",
"36:imprison",
"40:mist",
"44:auroraveil",
"47:captivate",
"48:sheercold",
"52:grudge",
"56:blizzard",
"egg:agility",
"egg:babydolleyes",
"egg:charm",
"egg:disable",
"egg:encore",
"egg:extrasensory",
"egg:flail",
"egg:freezedry",
"egg:howl",
"egg:hypnosis",
"egg:moonblast",
"egg:powerswap",
"egg:roar",
"egg:secretpower",
"egg:spite",
"egg:tailslap",
"tm:agility",
"tm:attract",
"tm:auroraveil",
"tm:blizzard",
"tm:bodyslam",
"tm:charm",
"tm:confide",
"tm:darkpulse",
"tm:dig",
"tm:doubleteam",
"tm:drainingkiss",
"tm:encore",
"tm:endure",
"tm:facade",
"tm:foulplay",
"tm:frostbreath",
"tm:frustration",
"tm:hail",
"tm:hex",
"tm:hiddenpower",
"tm:icebeam",
"tm:icywind",
"tm:imprison",
"tm:irontail",
"tm:payback",
"tm:powerswap",
"tm:protect",
"tm:psychup",
"tm:raindance",
"tm:rest",
"tm:return",
"tm:roar",
"tm:round",
"tm:safeguard",
"tm:sleeptalk",
"tm:snore",
"tm:substitute",
"tm:swagger",
"tm:swift",
"tm:tailslap",
"tm:toxic",
"tm:weatherball",
"tm:zenheadbutt",
"tutor:aquatail",
"tutor:aurorabeam",
"tutor:babydolleyes",
"tutor:blizzard",
"tutor:celebrate",
"tutor:confuseray",
"tutor:covet",
"tutor:darkpulse",
"tutor:dazzlinggleam",
"tutor:dig",
"tutor:facade",
"tutor:foulplay",
"tutor:headbutt",
"tutor:healbell",
"tutor:icebeam",
"tutor:iceshard",
"tutor:icywind",
"tutor:irontail",
"tutor:mist",
"tutor:painsplit",
"tutor:powdersnow",
"tutor:protect",
"tutor:reflect",
"tutor:rest",
"tutor:roar",
"tutor:roleplay",
"tutor:snore",
"tutor:spite",
"tutor:substitute",
"tutor:tackle",
"tutor:tailwhip",
"tutor:toxic",
"tutor:zenheadbutt"
],
"<abbr title="Labels for this pokémon. There's no real use for labels yet.">labels</abbr>": [
"<abbr title="Label for a Pokémon introduced in generation 7">gen7</abbr>",
"<abbr title="Label for a Regional form from the alola region">alola_regional</abbr>"
],
"<abbr title="Aspects are what allows a Pokémon to change its visual aspects for things like regional forms. You can read about it in this page's section on forms.">aspects</abbr>": [
"<abbr title="Alolan Vulpix will receive the aspect for alolan. This will allow it to use the alolan aspect in the resolver file to assign the alolan model instead of the kantonian one.">alolan</abbr>"
],
"<abbr title="The Pokémon's height measured in decimeters">height</abbr>": 6,
"<abbr title="The Pokémon's weight measured in hectograms">weight</abbr>": 99,
"<abbr title="Here you will list any evolution methods the form will have. They are separate from the base forms evolutions.">evolutions</abbr>": [
{
"<abbr title="The name of this evolution entry.">id</abbr>": "<abbr title="The name of this evolution entry.">vulpix_ninetales</abbr>",
"<abbr title="The evolution variant it will use to evolve.">variant</abbr>": "<abbr title="In this case, you need to interact with an item. This is the same method as using an evolution stone to evolve. But it can be configured to be any item or modded item.">item_interact</abbr>",
"<abbr title="The Pokémon that this species will evolve into.">result</abbr>": "<abbr title="Here you are specifying that alolan vulpix will evolve into alolan ninetales. Remember to use this format when making evolution data for regional forms.">ninetales form=alola</abbr>",
"<abbr title="Whether or not its held item gets consumed when evolving.">consumeHeldItem</abbr>": <abbr title="A held item is not required for this evolution, so we will leave this false for now">false</abbr>,
"<abbr title="A list of moves this Pokémon will learn when it evolves.">learnableMoves</abbr>": [
"<abbr title="When evolving into Alolan Ninetales, it will learn dazzling gleam.">dazzlinggleam</abbr>"
],
"<abbr title="Here you will list some sub requirements for evolution. You can learn more about evolution requirements on this page's section of evolution">requirements</abbr>": <abbr title="There are no sub requirements for this evolution, so we leave these brackets blank.">[]</abbr>,
"<abbr title="Here you will list what item you need to interact with to make this Pokémon evolve.">requiredContext</abbr>": "<abbr title="In this case, we are using an ice stone from the Cobblemon mod. This can be changed to any vanilla or modded item as long as you use the proper item id.">cobblemon:ice_stone</abbr>"
}
],
"cannotDynamax</abbr>": false</abbr>,
"battleOnly</abbr>": false</abbr>
}
],
"<abbr title="Here you will list any features this pokemon has. Features come from the species feature folder of the mod. You can learn more about features from this page's section on forms and features.">features</abbr>": [
"<abbr title="Even though the alolan form's data is written above, Vulpix can't access that form data unless you list alolan as a feature like this. So remember to apply alolan as a feature and an aspect!">alolan</abbr>"
],
"<abbr title="How many experience granted by this pokémon upon being defeated.">baseExperienceYield</abbr>": <abbr title="Weaker Pokémon usually have this value around 50.">60</abbr>,
"<abbr title="How quickly this Pokémon will level up. You can look this information up online.">experienceGroup</abbr>": "<abbr title="Vulpix will level up at a 'medium fast' rate.">medium_fast</abbr>",
"<abbr title="How long it takes for this pokémon's egg to hatch.">eggCycles</abbr>": <abbr title="A value of 20 is about how long it takes to hatch a starter Pokémon egg.">20</abbr>,
"<abbr title="What egg groups this Pokémon will be able to breed with. You can look this information up online.">eggGroups</abbr>": [
"<abbr title="The egg group of this pokemon.">field</abbr>"
],
"drops": {
"amount": "1",
"entries": [
{
"item": "minecraft:sweet_berries",
"quantityRange": "2-3"
}
]
},
"<abbr title="Here you will list what moves the pokemon can learn and how they will learn those moves. You can check this page's section for moves to see how to write them.">moves</abbr>": [
"<abbr title="This allows Kantonian Vulpix to learn ember at level 1">1:ember</abbr>",
"<abbr title="This allows Kantonian Vulpix to learn tail whip at level 1">1:tailwhip</abbr>",
"4:disable",
"7:roar",
"8:quickattack",
"9:babydolleyes",
"12:spite",
"16:incinerate",
"18:payback",
"20:confuseray",
"23:feintattack",
"24:willowisp",
"26:hex",
"28:extrasensory",
"28:flameburst",
"32:flamethrower",
"36:imprison",
"40:firespin",
"44:safeguard",
"47:captivate",
"48:inferno",
"52:grudge",
"56:fireblast",
"egg:babydolleyes",
"egg:captivate",
"egg:disable",
"egg:energyball",
"egg:extrasensory",
"egg:feintattack",
"egg:flail",
"egg:flamecharge",
"egg:flareblitz",
"egg:heatwave",
"egg:hex",
"egg:howl",
"egg:hypnosis",
"egg:memento",
"egg:powerswap",
"egg:psychup",
"egg:roar",
"egg:secretpower",
"egg:spite",
"egg:tailslap",
"tm:agility",
"tm:attract",
"tm:bodyslam",
"tm:captivate",
"tm:confide",
"tm:darkpulse",
"tm:dig",
"tm:doubleteam",
"tm:encore",
"tm:endure",
"tm:energyball",
"tm:facade",
"tm:fireblast",
"tm:firespin",
"tm:flamecharge",
"tm:flamethrower",
"tm:flareblitz",
"tm:foulplay",
"tm:frustration",
"tm:heatwave",
"tm:hex",
"tm:hiddenpower",
"tm:imprison",
"tm:incinerate",
"tm:irontail",
"tm:mysticalfire",
"tm:naturalgift",
"tm:overheat",
"tm:payback",
"tm:powerswap",
"tm:protect",
"tm:psychup",
"tm:rest",
"tm:return",
"tm:roar",
"tm:round",
"tm:safeguard",
"tm:secretpower",
"tm:sleeptalk",
"tm:snore",
"tm:substitute",
"tm:sunnyday",
"tm:swagger",
"tm:swift",
"tm:tailslap",
"tm:toxic",
"tm:weatherball",
"tm:willowisp",
"tm:zenheadbutt",
"tutor:attract",
"tutor:bide",
"tutor:bodyslam",
"tutor:burningjealousy",
"tutor:charm",
"tutor:confuseray",
"tutor:covet",
"tutor:curse",
"tutor:darkpulse",
"tutor:dig",
"tutor:disable",
"tutor:doubleedge",
"tutor:doubleteam",
"tutor:ember",
"tutor:endure",
"tutor:facade",
"tutor:feintattack",
"tutor:fireblast",
"tutor:firespin",
"tutor:flail",
"tutor:flamethrower",
"tutor:foulplay",
"tutor:frustration",
"tutor:headbutt",
"tutor:heatwave",
"tutor:hiddenpower",
"tutor:hypnosis",
"tutor:irontail",
"tutor:mimic",
"tutor:ominouswind",
"tutor:painsplit",
"tutor:protect",
"tutor:quickattack",
"tutor:rage",
"tutor:reflect",
"tutor:rest",
"tutor:return",
"tutor:roar",
"tutor:roleplay",
"tutor:safeguard",
"tutor:skullbash",
"tutor:sleeptalk",
"tutor:snore",
"tutor:spite",
"tutor:substitute",
"tutor:sunnyday",
"tutor:swagger",
"tutor:swift",
"tutor:tackle",
"tutor:tailwhip",
"tutor:takedown",
"tutor:toxic",
"tutor:willowisp",
"tutor:zenheadbutt"
],
"<abbr title="Labels for this pokémon. There's no real use for labels yet.">labels</abbr>": [
"<abbr title="Label for a Pokémon introduced in generation 1">gen1</abbr>",
"<abbr title="Label for a Pokémon from the kanto region.">kanto_regional</abbr>"
],
"<abbr title="Here you can create a string for your pokedex entry. The entry itself is written in the lang file. You are simply creating something to define in the lang file here.">pokedex</abbr>": [
"<abbr title="This line can be translated to any language in the language files and include the actual pokedex entry.">cobblemon.species.vulpix.desc</abbr>"
],
"<abbr title="Here you will list any evolution methods">evolutions</abbr>": [
{
"<abbr title="The name of this evolution entry.">id</abbr>": "<abbr title="The name of this evolution entry.">vulpix_ninetales</abbr>",
"<abbr title="The evolution variant it will use to evolve.">variant</abbr>": "<abbr title="In this case, you need to interact with an item. This is the same method as using an evolution stone to evolve. But it can be configured to be any item or modded item.">item_interact</abbr>",
"<abbr title="The Pokémon that this species will evolve into.">result</abbr>": "<abbr title="Here you are specifying that vulpix will evolve into ninetales.">ninetales</abbr>",
"<abbr title="Whether or not its held item gets consumed when evolving.">consumeHeldItem</abbr>": <abbr title="A held item is not required for this evolution, so we will leave this false for now">false</abbr>,
"<abbr title="A list of moves this Pokémon will learn when it evolves.">learnableMoves</abbr>": <abbr title="Vulpix wont learn any special moves when it evolves into ninetales, so this will be left empty.">[]</abbr>,
"<abbr title="Here you will list some sub requirements for evolution. You can learn more about evolution requirements on this page's section of evolution">requirements</abbr>": <abbr title="There are no sub requirements for this evolution, so we leave these brackets blank.">[]</abbr>,
"<abbr title="Here you will list what item you need to interact with to make this Pokémon evolve.">requiredContext</abbr>": "<abbr title="In this case, we are using a fire stone from the Cobblemon mod. This can be changed to any vanilla or modded item as long as you use the proper item id.">cobblemon:fire_stone</abbr>"
}
],
"<abbr title="Determines the size of the model. Based on the size of the model in blockbench. A value of 1 will put it at a one to one scale with what you made in blockbench. Remember that you can't use the /reload command to see the changes you make here.">baseScale</abbr>": <abbr title="A value of 0.7 means the model will only be at 70% the size of what you made in blockbench. This can be useful for scaling models down so you can get more detail on smaller Pokémon like joltik.">0.7</abbr>,
"<abbr title="Here you will determine the size of this Pokémon's hitbox. You can learn more about it in this page's hitbox section.">hitbox</abbr>": {
"<abbr title="A width value of 1 should let the hitbox be the size of a normal block in minecraft. Play around with this value until it looks right to you.">width</abbr>": 0.9,
"<abbr title="A height value of 1 should let the hitbox be the size of a normal block in minecraft. Play around with this value until it looks right to you.">height</abbr>": 1.1,
"<abbr title="Determines whether the hitbox is fixed in place. This should most likely be set to false.">fixed</abbr>": false
},
"<abbr title="What this pokémon's friendship stat starts at when caught.">baseFriendship</abbr>": <abbr title="Most Pokémon have this value set to 50">50</abbr>,
"<abbr title="How many effort values this pokémon gives upon being defeated.">evYield</abbr>": {
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">hp</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">attack</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">defence</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">special_attack</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">special_defence</abbr>": 0,
"<abbr title="Defeating this Pokémon will grant the following amount of effort values in this stat.">speed</abbr>": 1
},
"<abbr title="The Pokémon's height measured in decimeters">height</abbr>": 6,
"<abbr title="The Pokémon's weight measured in hectograms">weight</abbr>": 99,
"<abbr title="Aspects are what allows a Pokémon to change its visual aspects for things like regional forms. Since this is for Vulpix's normal form, you'll want to leave this blank. You can read about it in this page's section on forms.">aspects</abbr>": <abbr title="The normal form for Vulpix will receive no aspects so this is left blank. This can be considered a 'default' vulpix and it will use 'default' assets for its models and textures.">[]</abbr>,
"cannotDynamax": false
}

{{Addon Creation}}

Tutorials/Creating A Model

2024-07-19T08:48:37Z

Frank The Farmer: I oopsie daisied once more

{{TOC|right}}
== Preface ==
'''This is not a guide to Blockbench.''' This '''extensive''' tutorial will guide you in the creation of a compatible Cobblemon model. Cobblemon models have certain requirements in order to work in Minecraft. There are several mistakes you might make when creating a model which may result in you having to start all over. This tutorial was created in collaboration with Cobblemon community members who have made these fatal mistakes. Some experience with Blockbench is recommended, but '''never required.'''

"Like 80% of the work for making a Pokémon is done through Blockbench. The rest are some files to assign the stuff you make into the game." -FrankTheFarmer

=== Step 1: Get access to Blockbench ===
Blockbench is a free 3D Modeling program capable of doing everything you need to make a Cobblemon model. You can create a model, paint it, and animate it all at the same time using Blockbench. Watching some Blockbench tutorials before getting started is recommended.

# Open your browser and go to https://www.blockbench.net
# <code>DOWNLOAD</code> the app '''or''' click on <code>OPEN WEB APP</code>

Blockbench can also be used on mobile devices!

'''Disclaimer''': This guide is tailored towards the Blockbench app on PC.

=== Step 2: Create the model file ===
You will be creating the project file in Blockbench. Although this step seems simple, if you choose the wrong model type or UV mode then it will not work with Cobblemon's custom Pokémon system.

# Open up Blockbench
# Click on File > New > Bedrock Entity
# '''In lowercase only''', type the name of your custom Pokémon in both <code>File Name</code> and <code>Model Identifier</code>
# Make sure Default UV Mode is set to <code>Box UV</code>
# Leave <code>Texture Size</code> alone
# Click <code>Confirm</code>

You have created the foundation of your model file!

Despite being for the Java version of Minecraft, Cobblemon uses Bedrock entities to allow for flexible animations.

=== Step 3: Creating cubes the right way ===
There are many ways to create a Pokémon model. There is no “right way” to make a cube to build your design; however, '''there are several things that can break your model involving these cubes.'''

Before you get started, you should know that there are several things you should '''never''' do when creating cubes. As you create your model, keep the following tips in mind:
* '''Don't''' use capital letters when naming your cubes or groups. Minecraft might crash trying to read them. '''Always stick with lowercase letters when naming things!'''
* '''Don't''' use decimals in <code>Size</code> values! Minecraft can't handle "2.5" pixels properly. <code>Position</code>, <code>Inflate</code>, <code>Pivot Point</code>, and <code>Rotation</code> values can use decimals without issues.
** These decimal values will get rounded up or down in game and break the geometry.
* '''Don't''' change the UV Mode of the cube. They should all be “Box UV” by default, but if just one cube is changed to Per-face UV, the whole resource pack will refuse to load.
* '''Don't''' forget to save! It can take hours or days to make your model. Save often!
* Make sure your model is facing <code>North</code>! '''It should be facing towards the N on the floor.''' It may walk backwards or sideways in game if not facing North.
* Your model does not always need to be on a 1 to 1 scale. It can be sized down in game to affect texture details.

With that in mind, you can start creating cubes in Blockbench!
# Create a cube by clicking the <code>Add Cube</code> button under "Outliner" or press Ctrl + N
# Change the elements of this cube as needed
# Repeat these steps when more cubes are needed to build your model

'''Tip''': You can change one of the size values to 0 to create a 2D plane. These are usually called <code>panes</code> and can be used to create flat textures for certain situations. Remember to paint the back side of these panes!

=== Step 4: Arrange your cubes into "bones" ===
As you create the cubes for your model, you will want group them into folders. These groups of cubes are called <code>bones</code>. Only bones can be selected in the <code>Animate</code> tab. Bones can even go inside of other bones. You are essentially building a skeleton. Sort these bones out to make animating the model easier later on.
[[File:Example_of_Arm.png|thumb|350px|caption|Sceptile's arm bone structure.]]
# Decide which cubes should be grouped together as a <code>bone</code>.example: grouping several cubes together to make a "foot" bone. Then grouping other cubes to make a "leg" bone.
# Create a group by clicking the <code>Add Group</code> button under "Outliner" or press Ctrl + G
# Name this new bone. It is recommended to use names of body parts like arm, arm 2, hand, etc.
# Click and drag associated cubes into this new bone folder.
# Assign an appropriate pivot point to this new bone. This controls the location it will rotate from.
# Repeat these steps when more bones are needed for animation

Bones can use the same properties under the "Element" section. How you use these properties with bones is up to you. You can reference official models that have a similar body type to your custom Pokémon.

=== Step 5: Arranging your bones the right way ===
There are many ways to create a Pokémon model. Unfortunately, there is a "right way" to arrange your bones so it won't break something in game; however, '''this will never restrict your creative freedom!''' There are only 2 "bones" required to make your model functional with Cobblemon and it shouldn't interfere with your design.

'''You may want to come back to these steps after creating all of the cubes necessary to make your model complete'''
[[File:CharmanderAndItsBones.png|thumb|350px|caption|Charmander with its "root folder" and "head" bone.]]
# Create a new bone group and name this folder after your custom Pokémon
# Drag all bones and cubes into this new folder until it holds everything.
#*This folder that holds everything is known as the <code>root folder</code>
# Ensure the XYZ Pivot Point values of the root folder are all at 0.
#* This stops the model from sinking into the ground in game.
# Create or pick the <code>head</code> bone for your Pokémon.
#*This will be the bone that rotates when it uses the "look" animation.
#* Sometimes a Pokémon wont have a traditional head like Spheal for example. You'll have to get creative with which bone shall be the head bone.
# Ensure this head bone is named <code>head</code>.
#* You mostly name it "head" for simplicity with the <code>poser file</code>.
#* If your Pokémon is shaped differently, then just remember to use the name of the bone that works best in its poser file.

The root folder is crucial for making the in-game model's position look exactly the way it does in Blockbench. If the Pivot values are not 0, then it will shift in some direction.

Having a head bone allows the Pokémon to use the look animation without issues. In the past, many creators have unknowingly assigned the head bone as "head" in their poser files despite not having an actual bone with that name in their model. '''If the model did not have this matching <code>head</code> bone, the game would crash!'''

=== Step 6: Create your textures ===
This step will only help you with the creation of the files. Any artistic help will have to be sourced from somewhere else. It is recommended to watch some tutorials or ask for help in the Cobblemon discord.
[[File:PaintingACharmander.png|thumb|450px|caption|Charmander getting painted in Blockbench.]]
# Click on "Create Texture" or press Ctrl+Shift+T.
# Name the texture after your Pokémon.
# Ensure Pixel Density is set to <code>16x</code>
#* Other densities may break textures.
#* The model can later be sized up or down to affect details.
# Click confirm. The default settings are usually fine.
# Navigate to the <code>Paint</code> tab in the top-right corner of Blockbench
# Paint the model until satisfied.
# Click the Save icon on your texture, or press Ctrl+S
# Make sure the PNG is called <code><pokemon>.png</code>
# Repeat these steps for the shiny texture. (optional)

It is recommended that you save these PNGs in a folder you can easily access later.

=== Step 7: Animate your Pokémon ===
Again, this step will only help you with the creation of the files. Animations are not required to make your Pokémon work in game. This step may be skipped.

'''Remember that animations can only select bones. And if you change the bone names during or after this process, then you need to update your animations!'''
# Navigate to the <code>Animate</code> tab in the top-right corner of Blockbench
# Under the "ANIMATIONS" section, click the <code>Add Animation</code> button.
# Name your animation <code>animation.<pokemon>.<animation type></code>
#* There is a list of animation type examples below
# Select a desired loop mode. This can be changed later.
# Click <code>Confirm</code>
# Animate your Pokémon until satisfied.
# Repeat the previous steps to create new animations.
# Save your animations as a group. Click on the top-most save icon.
# Name this animation JSON <code><pokemon>.animation.json</code>

Cobblemon has a limited selection of Pose types that animations can use in game. The Quirk animation system(Future link) can expand this. You should at least create some core animations like idles, walks, and faints. You can name your animations using the following naming scheme.

Current list of Poses and animations you should make for them:
* "STAND" - <code>animation.<pokemon>.ground_idle</code>
** This pose type is also used for battle-idles - <code>animation.<pokemon>.battle_idle</code>
* "WALK" - <code>animation.<pokemon>.ground_walk</code>
* "HOVER" - <code>animation.<pokemon>.air_idle</code>
* "FLY" - <code>animation.<pokemon>.air_fly</code>
* "FLOAT" - <code>animation.<pokemon>.water_idle</code>
* "SWIM" - <code>animation.<pokemon>.water_swim</code>
* "SLEEP" - <code>animation.<pokemon>.sleep</code>
* "SHOULDER_LEFT" - <code>animation.<pokemon>.shoulder_left</code>
* "SHOULDER_RIGHT" - <code>animation.<pokemon>.shoulder_right</code>
* "faint" - <code>animation.<pokemon>.faint</code>
* "cry" - <code>animation.<pokemon>.cry</code>

=== Step 8: Export Bedrock Geometry ===
By now, you should already have your textures and animations saved somewhere. All that's left is to export your model file. Afterwards, everything you have made should be ready to use in resource packs!

# Click on File > Export > Export Bedrock Geometry
# Name this file <code><pokemon>.geo.json</code>
# Save it somewhere easily accessible

This step is done last in case any edits needed to be made to the model.

Congratulations! You should now have a model, textures, and animations, which is most of the work for creating a custom Pokémon. Provided you followed this guide, your model should not be causing any issues when put in game.

{{Addon Creation}}
[[Category:Tutorial]]

Fossils File

2024-07-16T05:23:36Z

Frank The Farmer: OOpsie daisy formatted this json wrong. I was in the neighborhood

{{TOC|right}}
== Preface ==
The JSONs in the <code>fossils</code> folder control the resulting Pokémon from the <code>fossil machine</code>. These files specify what items are considered a fossil and what Pokémon should be created if these fossils are placed into the machine. They are short files where you simply select any Pokémon and any item in the game.

== File And Folder Format ==
Below is an example of how you would arrange a <code>fossil.json</code> into a datapack:

==== Folder Structure ====
<div class="treeview">
*''(addon name)''
** '''pack.mcmeta'''
**data
***cobblemon
****fossils
*****'''<pokemon>.json'''
</div>

== Fossil Breakdown ==
The fossil files are able to select any loaded Pokémon [[species]] to come out of the fossil machine. The <code>"result"</code> line functions like the <code>/pokegive</code> or <code>/pokespawn</code> commands, so you can include other data like level or regional forms. You can select up to 3 items you wish to serve as the "fossils."

Here is a breakdown of the <code>arctozolt</code> fossil file:
{
"<abbr title="Here you will specify what Pokémon will be generated from the machine and any extra data to apply to that Pokémon.">result</abbr>": "<abbr title="In this case, Arctozolt will be created if all the following items are placed into the machine. Because there is no other data specified, it will be a normal level 1 Arctozolt.">arctozolt</abbr>",
"<abbr title="Here you will list items to be used as fossils for the machine.">fossils</abbr>": [
"<abbr title="The item ID for the fossilized dino">cobblemon:fossilized_dino</abbr>",
"<abbr title="The item ID for the fossilized bird">cobblemon:fossilized_bird</abbr>"
]
}

 Here is some extra info about fossil files:
* If your <code>result</code> pokemon doesn't exist or includes a typo, then the species will be chose at random from '''all loaded species'''.
* Since the <code>result</code> functions like the commands that generate Pokémon, you can generate them as shiny or with special abilities.
* The <code>fossils</code> don't need to come out of the suspicious sand or gravel blocks. You can use any item from the game.
* The <code>fossils</code> list doesn't support NBT data.

== Fossil Examples ==
Here are some fossil files you can use as a template to generate your own Pokémon.

* Cranidos' fossil file:
{
"result": "cranidos",
"fossils": [
"cobblemon:skull_fossil"
]
}

* A custom Porygon file that will generate as a level 10 shiny:
{
"result": "porygon shiny=yes level=10",
"fossils": [
"cobblemon:upgrade",
"cobblemon:dubious_disc",
"cobblemon:rare_candy"
]
}

{{Addon Creation}}

Tutorials/Creating A Custom Pokemon

2024-06-23T06:50:42Z

Frank The Farmer: SHOW FILE EXTENSIONS OR ELSE

{{TOC|right}}
== Preface ==
This beginner friendly step-by-step guide will walk you through adding custom Pokémon through resource and data packs. Cobblemon addons have certain requirements in order to work in Minecraft. There are several mistakes you can make along the way that can cause the game to crash. This tutorial was created in collaboration with Cobblemon community members who have made these mistakes.

Knowledge of coding and resource packs is not necessary! In this tutorial, you will mostly be replacing data in existing file templates and building a custom Pokémon out of cubes. Experience with Blockbench is recommended, but never required! If at any point your addon is not working, you can look for help in the Cobblemon discord server.

== Overview ==
This guide will teach you:
* How to format your models and animations
* Where to place your files
* How to configure stats for your Pokémon
* How to configure evolutions for your Pokémon
* How to configure spawning for your Pokémon

What you will be creating are two things together; a resource pack and a data pack.
Resource packs primarily operate within the assets folder, while data packs operate within the data folder.

The reason we need to make two different things is that the data pack handles all the information (stuff a server needs), and the resource pack handles all the assets like models, textures, and more (stuff the client needs).

In this guide we will be creating both as a single pack.

As a brief summary:
* <code>Data packs</code> as a stand-alone are useful for servers, as servers have no need for assets
* <code>Resource packs</code> are useful for players playing on servers that already have the data
* A single pack with data pack and resource pack files together are useful to players who are playing single player, and need both the data and the assets. These combined data and resource files are often called <code>Addons</code>.

== Recommended Tools ==
While creating an addon can be done with a browser and some default PC tools, it's highly recommended that you download some of the following software. They can be very helpful if you want to make more than one custom Pokémon.
* '''Blockbench Desktop App''' - It will make accessing assets easier
* '''A Text Editor''' - They can be helpful for editing multiple files at once
** Recommendations:
**# Visual Studio Code
**# Notepad++
* '''Zip File Software''' - They can help you zip up your addon to be shared
** Recommendations:
**# 7zip


Cobblemon addons use a lot of <code>json</code> files. These are human-readable sets of data for Minecraft to read. Here are some JSON terms to help you understand these files.

'''JSON terminology'''
* <code>"key": "value"</code> - Property, aka "key-value pair". <code>key</code> must have quotes around it in JSON. <code>value</code> can be any of the following:
* <code>{}</code> - Object. contains properties, as above.
* <code>[]</code> - Array. Is an ordered list of "entries" of any of the other data types.
* <code>"abc"</code> - String. Quotes around any set of characters. Cannot have line returns in the middle of them.
* <code>1</code> - Number. Doesn't have quotes. Some values can be decimal friendly.
* <code>true/false</code> - Boolean. Doesn't have quotes. One of possibly either `true` or `false`

'''JSON quirks'''
* Must have commas between properties.
* Cannot have commas after properties if there's not another property.
** You can't have any commas before any sort of closing bracket.

== Creating a Custom Pokémon ==
=== Part 1: Arrange the folders for this addon ===
Due to some files sharing the same names later in this guide, you will be creating the folder structure and <code>pack.mcmeta</code> now. This is to prevent confusion going forward.

# Create a new text file and name it <code>pack.mcmeta</code>
#* Ensure that it doesn't end in other file extensions like .txt. You may need to search "how to show file extensions" for whatever operating system you have.
#* This file tells Minecraft "this is a resourcepack/datapack"
# Open the file and insert the following data:
#* Hover over the underlined text to see more information.
{
"<abbr title="This lets Minecraft know that it is a datapack">pack</abbr>": {
"<abbr title="Here you will list the pack format number for a specific version of Minecraft">pack_format</abbr>": <abbr title="As of 1.20.1, the current resourcepack format number is 15. But it will still load if this number isn't correct!">15</abbr>,
"<abbr title="Here you will write a short description of your datapack">description</abbr>": "<abbr title="Your short datapack description">Example description</abbr>"
}
}
# <li value=3> Save the file and put it aside for now.
# Create a series of folders arranged like the following example:
==== Folder Structure ====
<div class="treeview">
*''(addon name)''
** '''pack.mcmeta'''
**assets
***cobblemon
****bedrock
*****pokemon
******animations
*******<folder named after your pokemon>
******models
*******<folder named after your pokemon>
******posers
******resolvers
*******<folder named after your pokemon>
****lang
****textures
*****pokemon
******<folder named after your pokemon>
**data
***cobblemon
****spawn_pool_world
****species
*****custom
</div>
After this folder tree for your addon is made, you can simply drop the files into the associated folders as you create them.
Remember that the <code>pack.mcmeta</code> is a file, not a folder to add. It must be one folder deep in order for Minecraft to recognize this pack as a resource pack or data pack when in the appropriate game folders.

=== Part 2: Create your Pokémon's assets in Blockbench ===
'''This is not a guide to Blockbench.''' This '''extensive''' part of the tutorial will guide you in the creation of a compatible Cobblemon model. Cobblemon models have certain requirements in order to work in Minecraft. There are several mistakes you might make when creating a model which may result in you having to start all over.

This part of the guide is a slightly watered down version of the [[Tutorials/Creating A Model|model creation tutorial]] to keep things more beginner friendly.

==== Step 1: Get access to Blockbench ====
Blockbench is a free 3D Modeling program capable of doing everything you need to make a Cobblemon model. You can create a model, paint it, and animate it all at the same time using Blockbench. Watching some Blockbench tutorials before getting started is recommended.

# Open your browser and go to https://www.blockbench.net
# <code>DOWNLOAD</code> the app '''or''' click on <code>OPEN WEB APP</code>

Blockbench can also be used on mobile devices!

'''Disclaimer''': This guide is tailored towards the Blockbench app on PC.

==== Step 2: Create the model file ====
You will be creating the project file in Blockbench. Although this step seems simple, if you choose the wrong model type or UV mode then it will not work with Cobblemon's custom Pokémon system.

# Open up Blockbench
# Click on File > New > Bedrock Entity
# '''In lowercase only''', type the name of your custom Pokémon in both <code>File Name</code> and <code>Model Identifier</code>
# Make sure Default UV Mode is set to <code>Box UV</code>
# Leave <code>Texture Size</code> alone
# Click <code>Confirm</code>

You have created the foundation of your model file!

Despite being for the Java version of Minecraft, Cobblemon uses Bedrock entities to allow for flexible animations.

==== Step 3: Creating cubes the right way ====
There are many ways to create a Pokémon model. There is no “right way” to make a cube to build your design; however, '''there are several things that can break your model involving these cubes.'''

Before you get started, you should know that there are several things you should '''never''' do when creating cubes. As you create your model, keep the following tips in mind:
* '''Don't''' use capital letters when naming your cubes or groups. Minecraft might crash trying to read them.
** '''Always stick with lowercase letters when naming things!'''
* '''Don't''' use decimals in <code>Size</code> values! Minecraft can't handle "2.5" pixels properly.
** These decimal values will get rounded up or down in game and break the geometry.
** <code>Position</code>, <code>Inflate</code>, <code>Pivot Point</code>, and <code>Rotation</code> values can use decimals without issues.
* '''Don't''' change the UV Mode of the cube. They should all be “Box UV” by default.
** If just one cube is changed to Per-face UV, the whole resource pack will refuse to load.
* '''Don't''' forget to save! It can take hours or days to make your model. Save often!
* Make sure your model is facing <code>North</code>! '''It should be facing towards the N on the floor.'''
** It may walk backwards or sideways in game if not facing North.
* Your model does not always need to be on a 1 to 1 scale. It can be sized down in game to affect texture details.

With that in mind, you can start creating cubes in Blockbench!
# Create a cube by clicking the <code>Add Cube</code> button under "Outliner" or press Ctrl + N
# Change the elements of this cube as needed
# Repeat these steps when more cubes are needed to build your model

'''Tip''': You can change one of the size values to 0 to create a 2D plane. These are usually called <code>panes</code> and can be used to create flat textures for certain situations. Remember to paint the back side of these panes!

==== Step 4: Arrange your cubes into "bones" ====
As you create the cubes for your model, you will want group them into folders. These groups of cubes are called <code>bones</code>. Only bones can be selected in the <code>Animate</code> tab. Bones can even go inside of other bones. You are essentially building a skeleton. Sort these bones out to make animating the model easier later on.
[[File:Example_of_Arm.png|thumb|350px|caption|Sceptile's arm bone structure.]]
# Decide which cubes should be grouped together as a <code>bone</code>.example: grouping several cubes together to make a "foot" bone. Then grouping other cubes to make a "leg" bone.
# Create a group by clicking the <code>Add Group</code> button under "Outliner" or press Ctrl + G
# Name this new bone. It is recommended to use names of body parts like arm, arm 2, hand, etc.
# Click and drag associated cubes into this new bone folder.
# Assign an appropriate pivot point to this new bone. This controls the location it will rotate from.
# Repeat these steps when more bones are needed for animation

Bones can use the same properties under the "Element" section. How you use these properties with bones is up to you. You can reference official models that have a similar body type to your custom Pokémon.

==== Step 5: Arranging your bones the right way ====
There are many ways to create a Pokémon model. Unfortunately, there is a "right way" to arrange your bones so it won't break something in game; however, '''this will never restrict your creative freedom!''' There are only 2 "bones" required to make your model functional with Cobblemon and it shouldn't interfere with your design.

'''You may want to come back to these steps after creating all of the cubes necessary to make your model complete'''
[[File:CharmanderAndItsBones.png|thumb|350px|caption|Charmander with its "root folder" and "head" bone.]]
# Create a new bone group and name this folder after your custom Pokémon
# Drag all bones and cubes into this new folder until it holds everything.
#*This folder that holds everything is known as the <code>root folder</code>
# Ensure the XYZ Pivot Point values of the root folder are all at 0.
#* This stops the model from sinking into the ground in game.
# Create or pick the <code>head</code> bone for your Pokémon.
#*This will be the bone that rotates when it uses the "look" animation.
#* Sometimes a Pokémon wont have a traditional head like Spheal for example. You'll have to get creative with which bone shall be the head bone.
# Ensure this head bone is named <code>head</code>.
#* You mostly name it "head" for simplicity with the <code>poser file</code>.
#* If your Pokémon is shaped differently, then just remember to use the name of the bone that works best in its poser file.

The root folder is crucial for making the in-game model's position look exactly the way it does in Blockbench. If the Pivot values are not 0, then it will shift in some direction.

Having a head bone allows the Pokémon to use the look animation without issues. In the past, many creators have unknowingly assigned the head bone as "head" in their poser files despite not having an actual bone with that name in their model. '''If the model did not have this matching <code>head</code> bone, the game would crash!'''

==== Step 6: Create your textures ====
This step will only help you with the creation of the files. Any artistic help will have to be sourced from somewhere else. It is recommended to watch some tutorials or ask for help in the Cobblemon discord server.
[[File:PaintingACharmander.png|thumb|450px|caption|Charmander getting painted in Blockbench.]]
# Click on "Create Texture" or press Ctrl+Shift+T.
# Name the texture after your Pokémon.
# Ensure Pixel Density is set to <code>16x</code>
#* Other densities may break textures.
#* The model can later be sized up or down to affect details.
# Click confirm. The default settings are usually fine.
# Navigate to the <code>Paint</code> tab in the top-right corner of Blockbench
# Paint the model until satisfied.
# Click the Save icon on your texture, or press Ctrl+S
# Make sure the PNG is called <code><pokemon>.png</code>
# Place this PNG in your Pokémon's <code>texture</code> folder of your addon.
#* The folder path for this PNG should be like so: <code> <your_addon>/assets/cobblemon/textures/pokemon/<your_pokemon>/<pokemon>.png </code>
# Repeat these steps for the shiny texture. (optional)

==== Step 7: Animate your Pokémon ====
Again, this step will only help you with the creation of the files. Animations are not required to make your Pokémon work in game. This step may be skipped.

'''Remember that animations can only select bones. And if you change the bone names during or after this process, then you need to update your animations!'''
# Navigate to the <code>Animate</code> tab in the top-right corner of Blockbench
# Under the "ANIMATIONS" section, click the <code>Add Animation</code> button.
# Name your animation <code>animation.<pokemon>.<animation type></code>
#* There is a list of animation type examples below
#* A full list of animation types that the developers make can be found [[Tutorials/Creating_A_Model#Step_7:_Animate_your_Pokémon| here.]]
# Select a desired loop mode. This can be changed later.
# Click <code>Confirm</code>
# Animate your Pokémon until satisfied.
# Repeat the previous steps to create new animations.
# Save your animations as a group. Click on the top-most save icon.
# Name this animation JSON <code><pokemon>.animation.json</code>
# Place this animation JSON in your Pokémon's <code>animation</code> folder of your addon.
#* The folder path for this JSON should be like so: <code><your_addon>/assets/cobblemon/bedrock/pokemon/animations/<your_pokemon>/<pokemon>.animation.json</code>

Cobblemon has a limited selection of Pose types that animations can use in game. You should at least create some core animations like idles, walks, and faints. You can name your animations using the following naming scheme.

Beginner list of Poses and animations you should make for your Pokemon:
* "STAND" - <code>animation.<pokemon>.ground_idle</code>
* "WALK" - <code>animation.<pokemon>.ground_walk</code>
* "faint" - <code>animation.<pokemon>.faint</code>

The full list of usable pose types and the animations that work with them can be found on the full version of the [[Tutorials/Creating_A_Model#Step_7:_Animate_your_Pokémon| model guide.]]

==== Step 8: Export Bedrock Geometry ====
By now, you should already have your textures and animations saved somewhere. All that's left is to export your model file. Afterwards, everything you have made should be ready to use in resource packs!

# Click on File > Export > Export Bedrock Geometry
# Name this file <code><pokemon>.geo.json</code>
# Place this model JSON in your Pokémon's <code>model</code> folder of your addon.
#* The folder path for this JSON should be like so: <code><your_addon>/assets/cobblemon/bedrock/pokemon/models/<your_pokemon>/<pokemon>.geo.json </code>

This step is done last in case any edits needed to be made to the model.

Congratulations! You should now have a model, textures, and animations, which is most of the work for creating a custom Pokémon. Provided you followed this guide, your model should not be causing any issues when put in game.

=== Part 3: Create your Pokémon's Poser file ===
<code>Posers</code> are JSON files that create a set of animations for a Pokémon to use. The poser file contains information on when the Pokémon will perform certain animations. You can set your Pokémon to only ever perform one animation if you’d like, or you can give it different animations for just about every action it performs!

You will be creating a poser file for the idle, walk, and faint animation you should have created if following this guide. '''Later in this guide''', you will have to come back and edit some of the <code>portrait</code> and <code>profile</code> values in the file so they look nice in the menus!

# Create a new text file and name it after your Pokémon. Include the file extension of <code>.json</code>
#* Example: <code>bulbasaur.json</code>
#* Make sure this new file name ends in .json and not any other file extension like .txt. You may need to search "how to show file extensions" for whatever operating system you have.
# Open this new JSON in your preferred text editor
# Copy and paste this entire poser example into the JSON
#* Hover over the underlined text to see more information.
{
"<abbr title="Tells the game which bone is the head. In this case, the head bone is simply named head.">head</abbr>": "<abbr title="The bone from your model that will act as the head for the look animation that plays when a Pokémon wants to look in certain directions. Can be any other appropriate bone and not all Pokémon need to do this!">head</abbr>",
"<abbr title="These refer to the portraits on the party menu on the left side of the screen. This will require some trial and error. I advise coming back to this after you’ve implemented your Pokémon. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale": 1</abbr>,
"<abbr title="These refer to the portraits on the party menu on the left side of the screen. This will require some trial and error. I advise coming back to this after you’ve implemented your Pokémon. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation": [ 0, 0.5, 0 ]</abbr>,
"<abbr title="These refer to the full body view of the Pokémon often seen in GUI, but most notably the summary UI. Like the previous code block, this section will require some trial and error, and you should come back to edit this later. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale": 1</abbr>,
"<abbr title="These refer to the full body view of the Pokémon often seen in GUI, but most notably the summary UI. Like the previous code block, this section will require some trial and error, and you should come back to edit this later. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileTranslation": [ 0, 0.4, 0 ]</abbr>,
"<abbr title="This points to the faint animation for this Pokémon. If you have no faint animation, you can delete this line.">faint</abbr>": "<abbr title="The animation you are telling it to use when your Pokémon faints. If you have correctly named all your files and animations, this should be as simple as changing 'pokemon' to be your Pokémon’s name.">bedrock(pokemon, faint)</abbr>",
"<abbr title="Here we are defining a list of our poses.">poses</abbr>": {
"<abbr title="Here we are defining the name of the pose.">standing</abbr>": {
"<abbr title="Here we are again defining the name of the pose.">poseName</abbr>": "<abbr title="The name of your pose. In this case, its called standing">standing</abbr>",
"<abbr title="This is transition time between animations. You probably won't need to mess with this.>transformTicks": 10</abbr>,
"<abbr title="Here, we are telling the game when this animation will take place.">poseTypes</abbr>": [
"<abbr title="One of the pose types that will use the following animation. STAND - when stationary on the ground">STAND</abbr>",
"<abbr title="One of the pose types that will use the following animation. NONE - when not doing anything at all">NONE</abbr>",
"<abbr title="One of the pose types that will use the following animation. PORTRAIT - when in a portrait like on your party UI">PORTRAIT</abbr>",
"<abbr title="One of the pose types that will use the following animation. PROFILE - when in summary screens">PROFILE</abbr>"
],
"<abbr title="Here you will list which animations will play during these poses.">animations</abbr>": [
"<abbr title="Allows the Pokémon to move its head around to observe its surroundings. You can delete this if your Pokémon doesn't have a head bone, or you just don't want them looking around.">look</abbr>",
"<abbr title="The animation you are telling it to use when your Pokémon is standing, doing nothing, or in the mod's UI. If you have correctly named all your files and animations, this should be as simple as changing 'pokemon' to be your Pokémon’s name.">bedrock(pokemon, ground_idle)</abbr>"
]
},
"<abbr title="Here we are defining the name of the pose.">walking</abbr>": {
"<abbr title="Here we are again defining the name of the pose.">poseName</abbr>": "<abbr title="The name of your pose. In this case, its called walking">walking</abbr>",
"<abbr title="This is transition time between animations. You probably won't need to mess with this.>transformTicks": 10</abbr>,
"<abbr title="Here, we are telling the game when this animation will take place.">poseTypes</abbr>": [ "<abbr title="One of the pose types that will use the following animation. WALK - when traveling on the ground">WALK</abbr>" ],
"<abbr title="Here you will list which animations will play during these poses.">animations</abbr>": [ "<abbr title="The animation you are telling it to use when your Pokémon is walking on land. If you have correctly named all your files and animations, this should be as simple as changing 'pokemon' to be your Pokémon’s name.">bedrock(pokemon, ground_walk)</abbr>" ]
}
}
}
# <li value=4> In the section for <code>"faint"</code>, change "pokemon" in <code>"bedrock(pokemon, faint)"</code> to be your Pokémon's name.
#* Don't put the name in quotes.
# In the section for <code>"standing"</code>, change "pokemon" in <code>"bedrock(pokemon, ground_idle)"</code> to be your Pokémon's name.
#* Don't put the name in quotes.
# In the section for <code>"walking"</code>, change "pokemon" in <code>"bedrock(pokemon, ground_walk)"</code> to be your Pokémon's name.
#* Don't put the name in quotes.
# Save the file
# Place this new poser JSON into the <code>posers</code> folder of your addon.

You just created the poser file! When it's time to test your addon in game, it should use the animations you created earlier.

=== Part 4: Create your Pokémon's Resolver file ===
<code>Resolvers</code> are JSON files that assign a Pokémon its <code>model</code>, <code>textures</code>, and <code>animations</code>. The resolver files control all the things that allow a Pokémon to function visually!

You will be creating the resolver file for your Pokémon. At this part of the guide, you should already have files for model, texture, animation, and poser. Now they just need to be linked to your Pokémon using the resolver file.

# Create a new text file and name it <code>"0_<pokemon>_base.json"</code>
#* Example: <code>0_treecko_base.json</code>
#* Make sure this new file name ends in .json and not any other file extension like .txt. You may need to search "how to show file extensions" for whatever operating system you have.
# Open this new JSON in your preferred text editor
# Copy and paste this entire resolver example into the JSON
#*Hover over the underlined text to see more information.
{
"<abbr title="Here you are saying what Pokémon species will get the following assets">species</abbr>": "<abbr title="In this example, Treecko will get the following assets. You will want to change 'treecko' to be your Pokémon's name">cobblemon:treecko</abbr>",
"<abbr title="This is the load order of the forms in this file. Since this file contains the default variants for this Pokémon, load order should be 0. Addons may create more forms later, and they will use a higher number. This is what '0_' and '_base' in the file name represent. '0_' represents the load order, and '_base' represents that these are the default forms.">order": 0</abbr>,
"<abbr title="Here you will list all of your Pokémon's visual variations. This is how the shiny version uses the same model but with a different texture.">variations</abbr>": [
{
"<abbr title="'Aspects' are traits a Pokémon has. In this section, we are determining what the Pokémon will look like if it has no aspects. This can be considered the 'default' assets.">aspects": []</abbr>,
"<abbr title="Here you are telling the Pokémon what poser file to use.">poser</abbr>": "<abbr title="In this example, it will use the treecko poser. You will want to change 'treecko' to be your Pokémon's name">cobblemon:treecko</abbr>",
"<abbr title="Here you are telling the Pokémon what model file to use.">model</abbr>": "<abbr title="In this example, it will use the treecko model. You will want to change 'treecko' to be your Pokémon's name">cobblemon:treecko.geo</abbr>",
"<abbr title="Here you are telling the Pokémon what texture PNG to use.">texture</abbr>": "<abbr title="In this example, it will use 'treecko.png' from the 'treecko' folder. You will want to change both instances of 'treecko' to be your Pokémon's name">cobblemon:textures/pokemon/treecko/treecko.png</abbr>",
"<abbr title="This can be used to add additional textures on top of the main texture like with emissive textures or Arbok's chest patterns. This is unfortunately not covered in this guide.">layers": []</abbr>
},
{
"<abbr title="In this section, we are determining what the Pokémon will look like if it is 'shiny'.">aspects</abbr>": [
"<abbr title="Here you are specifying that any shiny Treecko will use the following texture. If you don't list a model or poser like this example, then it will use the 'default' ones that you created above.">shiny</abbr>"
],
"<abbr title="Here you are telling the shiny Pokémon what texture PNG to use. The texture will be applied to the default model in this example.">texture</abbr>": "<abbr title="In this example, it will use 'treecko_shiny.png' from the 'treecko' folder. You will want to change both instances of 'treecko' to be your Pokémon's name">cobblemon:textures/pokemon/treecko/treecko_shiny.png</abbr>"
}
]
}
# <li value=4> In the section for <code>"species"</code>, change "treecko" in <code>"cobblemon:treecko"</code> to be your Pokémon's name.
# In the section for <code>"poser"</code>, change "treecko" in <code>"cobblemon:treecko"</code> to be your Pokémon's name.
# In the section for <code>"model"</code>, change "treecko" in <code>"cobblemon:treecko.geo"</code> to be your Pokémon's name.
# In the section for <code>"textures"</code>, change '''both instances''' of "treecko" in <code>"cobblemon:textures/pokemon/treecko/treecko.png"</code> to be your Pokémon's name.
# Under the <code>"shiny"</code> aspect section for <code>"textures"</code>, change '''both instances''' of "treecko" in <code>"cobblemon:textures/pokemon/treecko/treecko_shiny.png"</code> to be your Pokémon's name.
#* Don't delete the "_shiny" part of the name.
#* You can remove the shiny variation if you didn't make any shiny textures.
# Save the file
# Place this new resolver JSON into your Pokémon's <code>resolvers</code> folder of your addon.

You just created your Pokémon's resolver file. When it's time to load your addon in game, it should be using the model, textures, and animations you created for it!

=== Part 5: Create your Pokémon's Species file ===
Now that we’ve got all the assets in place, we can now create the <code>species</code> file! The species file contains all the entity data your Pokémon needs to exist. This is done from the data folder within your pack. This section will be extensive, but it will explain some of the basic properties of the <code>species file</code>. For a more detailed description of the properties in the species file, you can refer to [https://wiki.cobblemon.com/index.php/Species its wiki page]

This part of the guide can be skipped if you are able to create your Pokémon's <code>species</code> file through this [https://tmetcalfe89.github.io/cobblemon-fakemon-generator/ Fakemon Generator] made for Cobblemon! It will automatically create a zipped species JSON after you fill out some information for your Pokémon. The Fakemon Generator is very beginner friendly and can prevent you from making typos in the process of making a species file by hand.

==== Creating the Species JSON ====
This JSON will contain all the necessary data any Pokémon needs. This includes its name, type, abilities, stats, moves, etc.

# Create a new text file and name it after your Pokémon. Include the file extension of <code>.json</code>
#* Example: <code>bulbasaur.json</code>
#* Make sure this new file name ends in .json and not any other file extension like .txt. You may need to search "how to show file extensions" for whatever operating system you have.
# Open this new JSON in your preferred text editor
# Let's start by adding an opening and a closing curly bracket to the file like so:
#* In the following sections you will be adding information '''in between''' these brackets.
{

}

==== Basic Information ====
Let's add some basic information about your Pokémon.

# Copy and paste the following data '''inside the previously created curly brackets.'''
#*Hover over the underlined text to see more information.
"<abbr title="Whether or not this Pokémon is fully implemented. This determines whether it will show up in /spawnallpokemon or similar commands">implemented</abbr>": true,
"<abbr title="The name of the Pokémon species">name</abbr>": "<abbr title="In this example, the Pokémon will be called Tentaquil!">tentaquil</abbr>",
"<abbr title="Labels for this Pokémon. These labels can be used for spawning">labels</abbr>": [ "<abbr title="Here you are labeling your Pokémon as a 'custom' Pokémon.">custom</abbr>" ],
"<abbr title="Here we point to the Pokédex descriptions for this Pokémon.">pokedex</abbr>": [
"<abbr title="These are lang keys! We will need to define these later in a lang file, which is really easy. We'll cover this, but just replace 'tentaquil' with your own Pokémon's name for now.">cobblemon.species.tentaquil.desc1</abbr>",
"<abbr title="These are lang keys! We will need to define these later in a lang file, which is really easy. We'll cover this, but just replace 'tentaquil' with your own Pokémon's name for now.">cobblemon.species.tentaquil.desc2</abbr>"
],
"<abbr title="Height for the Pokédex. The value here is written in decimeters. To convert to meters, divide this value by 10.">height</abbr>": <abbr title="Tentaquil has a height of 11 decimeters, or 1.1 meters!">11</abbr>,
"<abbr title="Weight for the Pokédex and the amount of damage for moves based on weight. The value here is written in hectograms. To convert to kilograms, divide this value by 10.">weight</abbr>": <abbr title="Tentaquil has a weight of 300 hectograms, or 30 kilograms!">300</abbr>,
"<abbr title="Whether or not this pokemon can ride on the players shoulder.">shoulderMountable</abbr>": false,
# <li value=2>Change the 3 instances of "tentaquil" to your Pokémon's name
# Change the values of <code>"height"</code>, <code>"weight"</code>, and <code>"shoulderMountable"</code> if desired.


==== Stats ====
Now let's include the stats. You can refer to the stats of official Pokémon as guidelines if you plan on making the stats more practical and faithful to the official games. You can find the mod's official <code>species</code> files on the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/data/cobblemon/species Gitlab] which are organized by generation.

# Copy and paste the following data '''in a new line after the previous data.'''
#*Hover over the underlined text to see more information.
"<abbr title="The type assigned to your Pokémon.">primaryType</abbr>": "<abbr title="In this example, the Pokémon will be a poison type. You can change this if you like, but it must be an official type.">poison</abbr>",
"<abbr title="The second type assigned to your Pokémon. This line is optional.">secondaryType</abbr>": "<abbr title="In this example, the Pokémon will also be a water type. You can change this if you like, but it must be an official type.">water</abbr>",
"<abbr title="The base stats of your pokémon. Again, these are up to you.">baseStats</abbr>": {
"<abbr title="The base hp stat of your pokémon.">hp</abbr>": 125,
"<abbr title="The base attack stat of your pokémon.">attack</abbr>": 105,
"<abbr title="The base defense stat of your pokémon.">defence</abbr>": 95,
"<abbr title="The base special attack stat of your pokémon.">special_attack</abbr>": 120,
"<abbr title="The base special defense stat of your pokémon.">special_defence</abbr>": 85,
"<abbr title="The base speed stat of your pokémon.">speed</abbr>": 70
},
"<abbr title="The catch rate of your Pokémon. The higher the value, the easier it is to catch your Pokémon.">catchRate</abbr>": <abbr title="Catch rate values can start as low as 3 for legendary Pokémon and go as high as 255 for early game Pokémon like caterpie.">100</abbr>,
"<abbr title="What percentage of this pokémon are male.">maleRatio</abbr>": <abbr title="This would make the Pokémon have a 50% male ratio. You can set this value to 0 to make a female only species like Miltank. You can also set it to -1 to make genderless Pokémon like Ditto.">0.5</abbr>,
"<abbr title="How much experience is granted by this pokémon upon being defeated.">baseExperienceYield</abbr>": <abbr title="270 would let this Pokémon drop the same amount of exp as a legendary pokemon! Weak Pokémon have a value as low as 50. Blissey has the highest value at 635.">270</abbr>,
"<abbr title="How quickly this Pokémon will level up.">experienceGroup</abbr>": "<abbr title="It is recommended that you leave this alone for now. If you spell something wrong when trying to change it, your Pokémon will not level up at all.">fluctuating</abbr>",
"<abbr title="How long it will take this Pokémon's eggs to hatch.">eggCycles</abbr>": <abbr title="This value can be as low as 15 for quick hatching eggs or as high as 120 for slow hatching eggs like legendaries.">25</abbr>,
"<abbr title="The egg groups that this Pokémon can breed with.">eggGroups</abbr>": [
"<abbr title="It is recommended that you leave these alone unless you know what you're doing. If these values aren't valid, the game will crash.">water_1</abbr>",
"<abbr title="It is recommended that you leave these alone unless you know what you're doing. If these values aren't valid, the game will crash.">monster</abbr>"
],
"<abbr title="What this pokémon's friendship stat starts at when caught.">baseFriendship</abbr>": <abbr title="For most non-legendary Pokémon, this value is usually 50.">50</abbr>,
"<abbr title="How many EV's this pokémon gives upon being defeated.">evYield</abbr>": {
"<abbr title="The amount of hp EV's this Pokémon will drop.">hp</abbr>": 2,
"<abbr title="The amount of special attack EV's this Pokémon will drop.">special_attack</abbr>": 1
},
# <li value=2> Change any of these values if desired
#* It is recommended that you leave most of these values alone if you are unsure about your Pokémon's stats. They can always be changed later.


==== Moves and Abilities ====
Here you will include the abilities and move pool for your Pokémon.

# Copy and paste the following data '''in a new line after the previous data.'''
#*Hover over the underlined text to see more information.
"<abbr title="Here we're defining our list of moves. You can list as many as you like! If you'd like to include more moves, you cannot use spaces or underscores for moves that are named with multiple words like 'double slap.' You need to smoosh the words together! It would be written in this JSON as 'doubleslap'">moves</abbr>": [
"<abbr title="This would let disable be one of the 'egg moves' for this Pokémon">egg:disable</abbr>",
"<abbr title="This would let the Pokémon learn crushclaw at level 20">20:crushclaw</abbr>",
"<abbr title="This would allow the Pokémon to use a 'rest tm' when tm's get implemented">tm:rest</abbr>",
"<abbr title="This would allow the Pokémon to learn hone claws from a tutor when that gets implemented">tutor:honeclaws</abbr>"
],
"<abbr title="Here we define the list of abilities. You can have up to two abilities listed, and one hidden ability. The names of abilities must be one word just like with the moves.">abilities</abbr>": [
"<abbr title="This would make tough claws be the only default ability for this Pokémon.">toughclaws</abbr>",
"<abbr title="This would let serene grace be the hidden ability for this Pokémon. Hidden abilities are not implemented at this time.">h:serenegrace</abbr>"
],
# <li value=2> Change any of these values if desired
#* You probably should edit the moves and abilities for your Pokémon, but it can always be done later!


==== Entity Properties ====
Here you will list some properties of your Pokémon like its behavior, drops, and size.

# Copy and paste the following data '''in a new line after the previous data.'''
#*Hover over the underlined text to see more information.
"<abbr title="This refers to the scale of the Pokémon model.">baseScale</abbr>": <abbr title=" A scale of 1 means that the Pokémon will be the same size it was modeled at in Blockbench.">1</abbr>,
"<abbr title="These are the parameters that handle hit collision. There are only values for height and width since hitboxes are square prisms.">hitbox</abbr>": {
"<abbr title="The width of the hitbox. We will change this value later in the guide.">width</abbr>": 1,
"<abbr title="The height of the hitbox. We will change this value later in the guide.">height</abbr>": 1,
"<abbr title="This determines whether the hitbox is fixed in place or not. You usually always want this on false.">fixed</abbr>": false
},
"<abbr title="Here you will define what a Pokémon will drop when defeated.">drops</abbr>": {
"<abbr title="This indicates how many drop attempts there will be.">amount</abbr>": "<abbr title="In this instance, there will be 2 attempts to drop items from the entries listed below.">2</abbr>",
"<abbr title="This lists the potential items to drop.">entries</abbr>": [
{
"<abbr title="Here you will list the item id.">item</abbr>": "<abbr title="In this example, the Pokémon will attempt to drop slime balls! You can also include drops from other mods.">minecraft:slimeball</abbr>",
"<abbr title="The amount of items that will drop.">quantityRange</abbr>": "<abbr title="In this instance, it will drop 1-2 slime balls. Since there are 2 drop attempts, as specified from 'amount,' then there's a chance at getting 4 slime balls when defeating this pokemon!">1-2</abbr>",
"<abbr title="The chance for the item to drop.">percentage</abbr>": <abbr title="This means it will have a 66% chance to drop 1-2 slimeballs.">66</abbr>
}
]
},
"<abbr title="Here we will define the behavior of the Pokémon.">behaviour</abbr>": {
"<abbr title="Here you are listing behaviors regarding movement.">moving</abbr>": {
"<abbr title="This determines whether or not a Pokémon can look around. This really depends on your model.">canLook</abbr>": <abbr title="If your Pokémon doesn't have a proper head and neck, you might want to set this to false.">true</abbr>,
"<abbr title="Here you will list behaviors about flying.">fly</abbr>": {
"<abbr title="Whether or not a Pokémon can fly. If true, it will be assigned AI to fly.">canFly</abbr>": false
},
"<abbr title="Here you will list behaviors about swimming. This would include swimming in water and lava!">swim</abbr>": {
"<abbr title="Here you will determine how fast your Pokémon moves when swimming.">swimSpeed</abbr>": 0.2,
"<abbr title="Here you will determine if your Pokémon knows how to swim. If false, then the Pokémon will float to the surface instead of swimming around in water.">canSwimInWater</abbr>": true,
"<abbr title="Whether or not a Pokémon can breathe underwater. You want this set to true for most aquatic Pokémon.">canBreatheUnderwater</abbr>": true
}
}
}
# <li value=2> Change any of these values if desired
#* It is recommended to leave these alone for now.


==== Save the file! ====
That should be enough data for your custom Pokémon to be functional in game. Now you can save the file.

# Save the file
# Place this new species JSON into the <code>custom</code> folder of your addon.


=== Part 6: Creating the lang file ===
In this section we will walk you through on how to display the Pokémon's name in game. Let's begin by making a language file!

Minecraft will take whatever text is declared in this language file to show in game if a matching key is defined. The purpose of this is so that text such as names can be translated for different languages.

# Create a new text file and name it <code>en_us.json</code>
#* If US English is not your language, you can refer to the [https://minecraft.wiki/w/Language Minecraft Wiki page for language files] to get file name for your language.
#* Make sure this new file name ends in .json and not any other file extension like .txt. You may need to search "how to show file extensions" for whatever operating system you have.
# Open this new JSON in your preferred text editor
# Copy and paste this example data into the JSON:
#* Hover over the underlined text to see more information.
#* Remember that you want to change the string on the right side of the colon to whatever language you play with. The string on the left side of the colon must remain in English to be read properly by the mod.
{
"<abbr title="Here you will specify how your Pokémon's name will appear in English.">cobblemon.species.tentaquil.name</abbr>": "<abbr title="This will be the name that appears above the Pokémon's head in game. You are allowed to use capital letters, periods, and hyphens here.">Tentaquil</abbr>",
"<abbr title="Here you will give a short description of your Pokémon for the pokédex.">cobblemon.species.tentaquil.desc1</abbr>": "<abbr title="This will appear in the English pokédex when it gets implemented.">If its bold colors do not sufficiently ward off predators, it secretes toxins that smell strongly of copper.</abbr>",
"<abbr title="Here you will give a short description of your Pokémon for the pokédex.">cobblemon.species.tentaquil.desc2</abbr>": "<abbr title="This will appear in the English pokédex when it gets implemented.">There has only been one recorded sighting of this pokémon. Until recently, this was considered to be a joke.</abbr>"
}
# Swap out "tentaquil" for the name of your Pokémon
#* The value after <code>cobblemon.species.tentaquil.name</code> is what your Pokémon's name will look like over its head. So you can use capital letters, periods, and hyphens.
# Change the descriptions of the Pokémon if desired.
# Save the file
# Place this file in the <code>lang</code> folder of your addon.

The keys ending with <code>desc1</code> and <code>desc2</code> are the Pokémon's Pokédex entries. Although the Pokédex has not been implemented yet, try to keep the entries short and brief as there may eventually be a character limit.

You can add as many Pokémon names (along with their Pokédex entries) as you want to the same language file if you are planning to add more custom Pokémon to your pack.


=== Part 7: Testing your Pokemon in Game ===
You Pokemon should now have enough data to be functional in game! Let's try loading your addon in a new creative world.
# Launch Minecraft with the Cobblemon mod enabled.
# Click on "Singleplayer"
# Click on "Create New World"
# Name this new world whatever you like
# Set it to Creative and allow cheats!
# Click on "Data Packs"
# Click on "Open Pack Folder"
# Copy your addon folder and paste it into this datapack folder.
#* Your addon should appear in the list of available datapacks
#* If it appears as red, you can still select it and load it without issues if you have been following this guide.
# Select your addon from the list of available datapacks and click done
#* It should warn you that the datapack is outdated, but you can ignore this warning!
# Click on "Create New World"
# After the world has loaded, spawn your Pokémon with this command: <code>/pokespawn <your_pokemon></code>
# Your Pokémon should have a strange looking name and should have spawned as the substitute doll, which is a green dinosaur-like doll.
#* This is because the resource pack hasn't been activated yet. We will do that next.
#* If a Pokémon can at least spawn as the substitute doll, that means all of it's data is valid.
# Open your options menu.
# Click on "Resource Packs"
# Click on "Open Pack Folder"
# Copy your addon folder and paste it into this resource pack folder.
#* Your addon should appear in the list of available resource packs
# Select your addon from the list of available resource packs and click done.
#* If you get a warning that the resource pack is outdated, you can ignore this warning!
# After the game refreshes the resourcepacks, you should be able to see the model you created!
# Ensure that your Pokémon's model, animations, and name are working properly.
# Do not close Minecraft yet. In the following sections of this guide, we will be editing the addon files while the game is loaded.

You may notice that your Pokémon does not appear properly in the Party menus and HUD. Its appearance in the GUI is controlled by the <code>poser</code> file. We will fix it in the next couple of sections.

Your Pokémon may also appear bigger or smaller than you intended. This can be corrected in its <code>species</code> file. We will fix it in the next section.

=== Part 8: Adjusting the Scale of your Pokémon in game ===
We will be adjusting the size of your Pokémon in game. This will be done by editing the <code>species</code> file you created earlier.

Remember that datapack folder that you copy and pasted your addon folder into? It was a temporary folder used for world creation. This means that your addon is now in a different folder. We want to edit the in game files so we can see the changes without having to restart the game! This section of the guide will show you how to access that folder from in game.

# Have Minecraft open in the main menu
#* You'll always want Minecraft open in this section of the guide.
# Open your options menu.
# Click on "Resource Packs"
#* Although we are looking for your addon in the datapacks folder, this is a simple way to navigate to the datapack folder.
# Click on "Open Pack Folder"
# From this new folder window, go back one folder or press <code>ALT+[UP ARROW]</code>.
# Click on the <code>saves</code> folder.
# Click on the folder named after the Creative World you made earlier in this guide.
# Click on the <code>datapacks</code> folder.
# You should see your addon folder now!
# Open your addon folder and navigate to the <code>species</code> JSON of your Pokémon.
# Open the JSON in your preferred text editor.
# Look for the following data in this file:
"<abbr title="This refers to the scale of the Pokémon model.">baseScale</abbr>": <abbr title=" A scale of 1 means that the Pokémon will be the same size it was modeled at in Blockbench.">1</abbr>,
"<abbr title="These are the parameters that handle hit collision. There are only values for height and width since hitboxes are square prisms.">hitbox</abbr>": {
"<abbr title="The width of the hitbox. We will change this value now.">width</abbr>": 1,
"<abbr title="The height of the hitbox. We will change this value now.">height</abbr>": 1,
"<abbr title="This determines whether the hitbox is fixed in place or not. You usually always want this on false.">fixed</abbr>": false
},
# <li value=13> Let's start by changing the <code>baseScale</code> value first! This controls the size of the Pokémon model.
#* By default, this value should be 1.
#* You can use decimals to get a precise size for your Pokémon.
# Change the value for <code>baseScale</code>
#* If you want your Pokémon to be bigger, make the value higher than 1
#* If you want your Pokémon to be smaller, make the value lower than 1, but higher than 0.
# Save the file.
# Load your Creative Single Player world from the main menu.
#* You always have to load the world from the main menu to see changes to <code>data</code> files.
#* The command <code>/reload</code> does not work with Cobblemon datapacks.
# Examine your Pokémon and decide if it still needs to be adjusted.
# Repeat steps 10-17 until your Pokémon's in game size is just right!
# Now that your Pokémon's size is correct, we can adjust its <code>hitbox</code> values! This controls the Pokémon's hitbox and the size of its shadow.
#* By default, this value should be 1.
#* You can use decimals to get a precise size for your Pokémon.
# Open your addon folder and navigate to the <code>species</code> JSON of your Pokémon.
# Open the JSON in your preferred text editor.
# Look for the following data in this file:
"<abbr title="These are the parameters that handle hit collision. There are only values for height and width since hitboxes are square prisms.">hitbox</abbr>": {
"<abbr title="The width of the hitbox. We will change this value now.">width</abbr>": 1,
"<abbr title="The height of the hitbox. We will change this value now.">height</abbr>": 1,
"<abbr title="This determines whether the hitbox is fixed in place or not. You usually always want this on false.">fixed</abbr>": false
},
# <li value=23> Change the values for <code>width</code> and <code>height</code>
#* If you want your Pokémon's hitbox to be bigger, make the values higher than 1
#* If you want your Pokémon's hitbox to be smaller, make the values lower than 1, but higher than 0.
# Save the file.
# Load your Creative Single Player world from the main menu.
#* You always have to load the world from the main menu to see changes to <code>data</code> files.
# Press <code>F3+B</code> to show hitboxes.
# Examine your Pokémon and decide if it still needs to be adjusted.
#* Most of the time, you want the red line around the same height as the eye(s) of your Pokémon.
#* That red line on the hitbox indicates when the entity will start suffocating. If the hitbox somehow has a block above this red line, then the entity will start suffocating.
# Repeat steps 20-27 until your Pokémon's in game hitbox is just right!
# Once your Pokémon's size and hitbox are just right, go back to the main menu of Minecraft and proceed to the next part of the guide.


=== Part 9: Adjusting your Pokémon's poser file in game ===
In this part of the guide, we will be editing the <code>poser</code> file so your Pokémon can look nice in the GUIs! This time we will be editing files in the resource pack folder! This means you can press <code>F3+T</code> to reload the resource pack in game rather than loading from the main menu like we did for the species file.

# Have Minecraft open in the main menu
#* You'll always want Minecraft open in this section of the guide.
# Open your options menu.
# Click on "Resource Packs"
# Click on "Open Pack Folder"
# From this new folder window, you should see your addon folder.
# Open your addon folder and navigate to the <code>poser</code> JSON of your Pokémon.
# Open the JSON in your preferred text editor.
# Look for the following data in this file:
"<abbr title="These refer to the portraits on the party menu on the left side of the screen. This will require some trial and error. I advise coming back to this after you’ve implemented your Pokémon. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale": 1</abbr>,
"<abbr title="These refer to the portraits on the party menu on the left side of the screen. This will require some trial and error. I advise coming back to this after you’ve implemented your Pokémon. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation": [ 0, 0.5, 0 ]</abbr>,
"<abbr title="These refer to the full body view of the Pokémon often seen in GUI, but most notably the summary UI. Like the previous code block, this section will require some trial and error, and you should come back to edit this later. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale": 1</abbr>,
"<abbr title="These refer to the full body view of the Pokémon often seen in GUI, but most notably the summary UI. Like the previous code block, this section will require some trial and error, and you should come back to edit this later. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileTranslation": [ 0, 0.4, 0 ]</abbr>,
# <li value=9> Let's start by editing <code>portraitScale</code> and <code>portraitTranslation</code>. These values control how your Pokémon looks on the right side of your screen.
#* <code>portraitScale</code> makes your Pokémon bigger or smaller in the GUI. It can be treated like a "zoom" value for the camera that renders your Pokémon in this GUI. The higher the value, the more it will zoom into your Pokémon.
#* <code>portraitTranslation</code> has a set of 3 values in brackets. These 3 values can be treated like the xyz coordinates for the camera that renders your Pokémon in the GUI. These values can use decimals and negative numbers!
#* This part requires a lot of trial and error. Sometimes if you change a value too drastically, it will stop appearing on the GUI. It is recommended to change the values in increments of 0.3 to get your bearings on how these values work.
# Change the values for <code>portraitScale</code> and <code>portraitTranslation</code>
# Save the file
# Go back to Minecraft and press <code>F3+T</code> to refresh all resource packs
# After loading, examine your Pokémon in the party GUI on the left side of your screen.
#* Generally, you want this GUI to show your Pokémon's entire face
# Repeat steps 6-13 until your Pokémon looks just right!
# Next we will edit the values for <code>profileScale</code> and <code>profileTranslation</code>. These values control how your Pokémon looks in the Party GUI when you press M.
#* <code>profileScale</code> makes your Pokémon bigger or smaller in the GUI.
#* <code>portraitTranslation</code> controls the position of the camera rendering your Pokémon in this menu. These values can use decimals and negative numbers!
#* This part also requires a lot of trial and error. It is recommended to change the values in increments of 0.3 again.
# Open your addon folder and navigate to the <code>poser</code> JSON of your Pokémon.
# Open the JSON in your preferred text editor.
# Look for the following data in this file:
"<abbr title="These refer to the portraits on the party menu on the left side of the screen. This will require some trial and error. I advise coming back to this after you’ve implemented your Pokémon. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale": 1</abbr>,
"<abbr title="These refer to the portraits on the party menu on the left side of the screen. This will require some trial and error. I advise coming back to this after you’ve implemented your Pokémon. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation": [ 0, 0.5, 0 ]</abbr>,
"<abbr title="These refer to the full body view of the Pokémon often seen in GUI, but most notably the summary UI. Like the previous code block, this section will require some trial and error, and you should come back to edit this later. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale": 1</abbr>,
"<abbr title="These refer to the full body view of the Pokémon often seen in GUI, but most notably the summary UI. Like the previous code block, this section will require some trial and error, and you should come back to edit this later. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileTranslation": [ 0, 0.4, 0 ]</abbr>,
# <li value=19> Change the values for <code>profileScale</code> and <code>profileTranslation</code>
# Save the file
# Go back to Minecraft and press <code>F3+T</code> to refresh all resource packs
# After loading, press M and examine your Pokémon in the party GUI.
#* Generally, you want this GUI to show your Pokémon's entire body.
#* You mainly want your Pokémon's body to stay within the camera borders on the left side of the menu. This will mostly prevent your Pokémon from overlapping on the right side of the menu.
# Repeat steps 16-22 until your Pokémon looks just right!
# Once your Pokémon looks just right in the party menus, go back to the main menu of Minecraft and proceed to the next part of the guide.

At this point in the guide, your Pokémon should be fully functional in game. The last thing it needs is a way for it to spawn naturally in the game!


=== Part 10: Create your Pokémon's Spawn File ===
Once you create the spawn file for your Pokémon, it is considered complete! We will be using an example spawn file as a template to spawn your Pokémon. You can edit it to your liking with different [https://gitlab.com/cable-mc/cobblemon/-/wikis/Spawner/Spawn-Condition spawn conditions.] A list of biome tags you can use can be found [https://docs.google.com/document/d/1iB0EJSc2r6mRJXIo1n3XpHbZ5udwJVnrh2pXdhTyH8c/edit here].

# Create a new text file and name it <code><pokemon>.json</code>
#* Example: <code>bulbasaur.json</code>
#* Make sure this new file name ends in .json and not any other file extension like .txt. You may need to search "how to show file extensions" for whatever operating system you have.
# Open this new JSON in your preferred text editor
# Copy and paste this example data into the JSON:
#* Hover over the underlined text to see more information.
{
"<abbr title="This determines whether this spawn data is enabled">enabled": true</abbr>,
"<abbr title="These are lists that say whether the spawn data requires specific mods to be present. Namely, this is mostly for pokémon that spawn in biomes introduced by other mods.">neededInstalledMods": []</abbr>,
"<abbr title="These are lists that say whether the spawn data requires specific mods to be present. Namely, this is mostly for pokémon that spawn in biomes introduced by other mods.">neededUninstalledMods": []</abbr>,
"<abbr title="Here we are declaring where it will spawn.">spawns</abbr>": [
{
"<abbr title="Spawn locations require unique ID's. Calling them something like yourpokemon-1, yourpokemon-2 and so on is acceptable.">id": "tentaquil-1"</abbr>,
"<abbr title="Which pokémon are we trying to spawn here?">pokemon": "tentaquil</abbr>",
"<abbr title="Presets are a collection of potential block candidates to spawn on, this way you don't need to clarify a ton of blocks every time you make a spawn file.">presets</abbr>": [ "<abbr title="natural is the most common preset. You can pick others like underground, freshwater, redstone or more.">natural</abbr>" ],
"<abbr title="We are spawning a pokémon here, so no need to change this.">type": "pokemon</abbr>",
"<abbr title="What sort of surface is this spawning on? We will keep it on 'grounded' for this example.">context": "grounded</abbr>",
"<abbr title="How rare is this pokémon?">bucket": "uncommon</abbr>",
"<abbr title="This is the minimum and maximum level this pokémon can spawn at.">level": "18-60</abbr>",
"<abbr title="This number determines how likely it is to spawn considering its rarity.">weight": 10.0</abbr>,
"<abbr title="Additional spawn conditions are listed in this section.">condition</abbr>": {
"<abbr title="Whether or not this pokémon should be able to see the sky when it spawns.">canSeeSky</abbr>": true,
"<abbr title="Here we list the biomes we want the pokémon to spawn in.">biomes</abbr>": [ "<abbr title="The Cobblemon tag for forest biomes. Allows Tentaquil to spawn in any biome tagged as a forest.">#cobblemon:is_forest</abbr>" ]
}
}
]
}
# <li value=4> Replace the 2 instances of "tentaquil" with the name of your Pokémon
# Edit any of the other values if desired.
#* With the current template, your Pokémon will be an uncommon spawn in the forest.
# Save the file
# Place this new file in the <code>spawn_pool_world</code> folder of your addon.
#* Ensure that you place it in the addon folder that is in the datapack folder!
# Load your Creative Single Player world from the main menu.
#* You always have to load the world from the main menu to see changes to <code>data</code> files.
# Check if your Pokémon spawns where you assigned it to. You can use <code>/checkspawn <rarity></code> when in the assigned biome.
#* You can run the command <code>/locate biome <assigned biome></code> to get coordinates to the assigned biome. You can then click on the coordinates it gave you and be teleported instantly.
# Ensure that your Pokémon at least appears in the <code>checkspawn</code> list after meeting its conditions.
#* If you made your Pokémon rare or ultra-rare, then it may take hours before you even see it spawn naturally.
# If your Pokémon appears in the checkspawn list, or if you see it spawn naturally, then you can consider this guide completed!

Congratulations! You are now a Cobblemon modder. Hopefully your Pokémon will have no issues if you've been following along. If you have any issues with your addon, help can be found in the Cobblemon Discord server.

== Sharing your Pokémon Addon ==
Before you share your addon with others or upload it to a server, it is best to package your addon into a <code>.zip</code>. This will allow you to share the single <code>.zip</code> file instead of all the files individually.

If you have been following this guide, you may have realized that some files that got updated while testing in game are now separated. We need to combine the <code>data</code> and <code>assets</code> folders again.

# Create a new folder
# Name this new folder. This will be the final product name for your addon.
# Navigate to your addon folder inside the <code>datapacks</code> folder
# Open your addon folder
# Copy the <code>data</code> folder and the <code>pack.mcmeta</code> file
#* If you have a <code>pack.png</code>, copy that file too
# Paste them inside of your new addon folder
# Navigate to your addon folder inside the <code>resourcepacks</code> folder
# Open your addon folder
# Copy the <code>assets</code> folder
# Paste inside of your new addon folder
# Your up to date files should now be reunited in the new addon folder. Its structure and contents should look like the following folder tree:
==== Folder Structure ====
<div class="treeview">
*''(new addon folder name)''
** '''pack.mcmeta'''
** '''pack.png'''
**assets
***cobblemon
****bedrock
*****pokemon
******animations
*******<pokemon name>
********'''<pokemon>.animation.json'''
******models
*******<pokemon name>
********'''<pokemon>.geo.json'''
******posers
*******'''<pokemon>.json'''
******resolvers
*******<pokemon>
********'''0_<pokemon>_base.json'''
****lang
*****'''en_us.json'''
****textures
*****pokemon
******<pokemon>
*******'''<pokemon>.png'''
*******'''<pokemon>_shiny.png'''
**data
***cobblemon
****spawn_pool_world
*****'''<pokemon>.json'''
****species
*****custom
******'''<pokemon>.json'''
</div>
# <li value=12> Ensure you followed steps 1-11 correctly.
#* If you followed along correctly, then you copied the correct and updated files so it should work properly when shared.
# Open your new addon folder
# Select all of the following items together: <code>data</code>, <code>assets</code>, <code>pack.mcmeta</code>, <code>pack.png</code>(optional)
# Compress the files with your preferred zip file software.
#* If you are on Windows, you can compress them with the following method: Right click the selected items > send to > Compressed (zipped) folder
# Ensure that they are in a <code>.zip</code> file
#* Minecraft wont read <code>.rar</code> files
# Ensure that the <code>pack.mcmeta</code> file is one of the first things you see when you open your zipped addon.
#* Minecraft will only read 1 folder deep for the <code>pack.mcmeta</code>

Your addon should now be ready to share! Remember that this new <code>zip</code> file will still need to have a copy placed in both the <code>datapacks</code> and <code>resourcepacks</code> folders of those who will receive it. If you want to share the files on a server, then the server needs a copy in its datapack folder of the world. And every player will need a copy in their resourcepack folder!

{{Addon Creation}}
[[Category:Tutorial]]

Tutorials/Regional Forms

2024-06-06T22:40:37Z

Frank The Farmer: /* Step 4: Create a "species addition" file with "form" data */

{{TOC|right}}
== Preface ==
This tutorial will teach you how to create a regional form for '''''an existing Pokémon.''''' Regional forms are a species variant that can have different looks, types, abilities, moves, and spawn locations! '''Knowledge of [[Tutorials/Creating_A_Custom_Pokemon|creating custom Pokémon]] is ''required.''''' Creating a unique model and textures for your form is highly recommended, but not always necessary.

Due to regional forms usually requiring files for both data and assets, this type of pack will just be called an <code>addon</code> for simplicity. Addons that use data and asset folders will end up needing to have a copy in both the <code>datapacks</code> and <code>resourcepacks</code> game folders. The data and assets can be separated if desired, but are usually bundled together to make sharing easier!

=== Step 1: Arrange the folders for this addon ===
Due to some files sharing the same names later in this guide, you will be creating the folder structure and <code>pack.mcmeta</code> now. This is to prevent confusion going forward.

# Create a new text file and name it <code>pack.mcmeta</code>
#* Ensure that it doesn't end in other file extensions like .txt
# Open the file and insert the following data:
#* Hover over the underlined text to see more information.
{
"<abbr title="This lets Minecraft know that it is a datapack">pack</abbr>": {
"<abbr title="Here you will list the pack format number for a specific version of Minecraft">pack_format</abbr>": <abbr title="As of 1.20.1, the current resourcepack format number is 15. But it will still load if this number isn't correct!">15</abbr>,
"<abbr title="Here you will write a short description of your datapack">description</abbr>": "<abbr title="Your short datapack description">Example description</abbr>"
}
}
# <li value=3> Save the file and put it aside for now.
# Create a series of folders arranged like the following example:
==== Folder Structure ====
<div class="treeview">
*''(addon name)''
** '''pack.mcmeta'''
**assets
***cobblemon
****bedrock
*****pokemon
******animations
*******<target pokemon folder>
******models
*******<target pokemon folder>
******posers
******resolvers
*******<target pokemon folder>
****textures
*****pokemon
******<target pokemon folder>
**data
***cobblemon
****spawn_pool_world
****species_additions
****species_features
</div>
# <li value="5">Place the <code>pack.mcmeta</code> file into the first folder of your addon next to <code>assets</code> and <code>data</code>
After this folder tree for your addon is made, you can simply drop the files into the associated folders as you create them.
Remember that the <code>pack.mcmeta</code> is a file, not a folder to add. It must be one folder deep in order for Minecraft to recognize this pack as a resource pack or data pack when in the appropriate game folders.

=== Step 2: Create the assets for your regional variant ===
How you want your regional variant to look depends entirely on you. You can make it use a new texture over the original model. Most of the time, a new model, texture, and animations are created for this regional form. If for some reason you don't want it to have a visual difference at all, then you can skip anything regarding <code>assets</code>. Make sure your assets have a unique name so they don't overwrite any original form assets.

Assets for existing Pokémon can be obtained from the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/assets/cobblemon/bedrock/pokemon/models Gitlab] or the mod's JAR file. This can be helpful if you wanted to make a texture variant, or use the model as a base for the regional form. Just remember that animation files are made for specific models so they may need updating depending on what you make. These assets can be made in Blockbench or any relevant art apps.

# Create the regional form's <code>model</code>
# Create the regional form's <code>texture</code>
# Create the regional form's <code>animations</code>
# Export these files and place them into the appropriate folders in your addon pack
# Create a <code>[[poser]]</code> file for this regional form if new animations were created for the new model. (optional)

As knowledge of creating custom Pokémon is a requirement for this guide, you are expected to know how to make these files. Help can be found on the Cobblemon discord.

=== Step 3: Create a "species feature" ===
On the data side of things, the creation of a regional form starts with the [[Species_Features|species feature]]. A species feature is what allows a Pokémon to have a different set of stats and visuals applied to their regional forms. You will be creating a short JSON file that will be named after your custom region or idea. '''The feature can be named whatever you want it to be called.'''

# Create a new text file and name it after your region or idea. Include the extension of<code>.json</code>
#* Example: The alolan species feature is named <code>alolan.json</code>
#* Remember to use lowercase and make sure that the file does not end in any other extension like ".txt"
# Insert the following data into this new species feature JSON:
#* '''Remember to change <code>"custom_feature"</code> to match your file name! It must stay in quotes.'''
<syntaxhighlight>
{
"keys": ["custom_feature"],
"type": "flag",
"isAspect": true,
"default": false
}
</syntaxhighlight>
# <li value="3"> Save the file
# Place this new species feature file into the <code>species_feature</code> folder of your addon

<code>"isAspect": true</code> means that this new feature is both a <code>feature</code> and <code>aspect</code>!
Now that the species feature is made, you can apply it to a Pokémon's <code>form</code>

=== Step 4: Create a "species addition" file with "form" data ===
A <code>[[Species_Additions|species_addition]]</code> file is an efficient way of ''adding'' data to existing species files without having to rewrite the main species file. This allows your additions to be more compatible with other addons affecting the same Pokémon. You will be adding your regional <code>form</code> data to a species through this method.

# Create a new text file and name it after your Pokémon. Include the extension of <code>.json</code>
#* Example: <code>bulbasaur.json</code>
# Insert the following data into this new species_addition JSON:
<syntaxhighlight>
{
"target": "cobblemon:example",
"features": ["custom_feature"],
"forms": [
{
example form data
}
]
}
</syntaxhighlight>
# <li value="3"> Change <code>"cobblemon:example"</code> to reference the Pokémon you want to add a form to. It must remain in quotes.
#* Example: <code>"cobblemon:bulbasaur"</code>
# Change <code>"custom_feature"</code> to the feature you made earlier. It must remain in quotes.
# Write all the data for your form inside of the curly brackets
#* The average form data set is too long to list as an example for this guide. It's like writing data for an entirely different Pokémon, which is kind of what a regional variant is like.
#* If you need an example, you can look at the <code>"forms"</code> data for [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/resources/data/cobblemon/species/generation1/vulpix.json Vulpix on the Gitlab.] It starts on line 29 and ends on line 240.
#* Remember to include evolution data if this regional variant can evolve.
# Write your species feature name into the <code>"aspects"</code> section of your <code>"forms"</code> data.
#* Include the line for aspects if it doesn't exist yet. It should look like this:
<syntaxhighlight>
"aspects": ["custom_feature"]
</syntaxhighlight>
# <li value="7"> Save the file.
# Place this new species addition file into the <code>species_additions</code> folder of your addon.

Now your target Pokémon's new form should have the data that allows it to function differently in battles. Next you will create the data that allows it to spawn differently.

=== Step 5: Create the spawns for your regional form ===
The <code>[[Spawn_Pool_World|spawn_pool_world]]</code> folder holds all the spawning files for each Pokémon. You will be creating a new file for your regional variant. It can be as simple or complicated as you make it. It is recommended that you use the normal form's spawn file as a base for your regional form. Those spawn files can be found on the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/data/cobblemon/spawn_pool_world Gitlab.]

To keep things simple, this part of the guide will show you how to recycle a spawn file by changing the Pokémon name and biome conditions.
# Obtain your target Pokémon's <code>spawn_pool_world</code> JSON.
# Rename the file to anything you want. The name must be different than the original.
#* Example: <code>regional_bulbasaur</code>
# Open the file and locate all the strings for <code>"id"</code> and <code>"pokemon"</code>
# Edit the Pokémon's name '''and include''' the name of your species feature after like this example:
#* You must use a space after the Pokémon name for the <code>"pokemon"</code> string.
<syntaxhighlight>
"id": "bulbasaur-alolan-1",
"pokemon": "bulbasaur alolan",
</syntaxhighlight>
# <li value="5">Locate all the strings for <code>"biomes"</code> if they exist
# Change the listed biome(s) to something different!
#* This will allow the regional variant to spawn in biomes the normal variant does not.
#* The list of biome tags can be found [https://docs.google.com/document/d/1iB0EJSc2r6mRJXIo1n3XpHbZ5udwJVnrh2pXdhTyH8c/edit here.]
# Save the file
# Place this new spawn file in the <code>spawn_pool_world</code> folder of your addon

This should be the last of the data folder files. By now, your regional variant can stand on its own data-wise. It should have different stats, and spawns. Now it just needs a different look.

=== Step 6: Create the resolver file for your regional form ===
Back in step 2, you should have already made the files for <code>models</code>, <code>textures</code>, <code>animations</code>, and <code>posers</code>. The last thing you need to do is assign them to your regional variant by creating a new <code>[[resolver]]</code> file.

# Obtain your target Pokémon's <code>resolver</code> JSON.
# Change the name of this resolver to <code>1_<pokemon>_base</code>
#* You change the number from 0 to 1 so it can load after the normal variant's data
#* Sometimes a number greater than 1 is needed, especially if your target Pokémon has gender variants.
# Open the resolver file and locate the string for <code>"order"</code>.
# Change the value of "order" from 0 to 1.
#* Again, sometimes this value needs to be greater than 1.
# Add the name of your species feature to the <code>"aspects"</code> string
#* Example: <code>"aspects": ["alolan"]</code>
#* This allows any Pokémon that spawned with this feature/aspect to use any following model, textures, or poser.
# Assign any <code>poser</code>, <code>model</code>, or <code>textures</code> that you made in Step 2.
# Save the file
# Place this new resolver in the <code>resolvers</code> folder of your addon

=== Step 7: Test your addon in game ===
Load your addon in game to see if your regional form looks different from the normal one. You can have Blockbench open to edit any relevant asset file '''in the resourcepacks folder''' if needed.
# Copy your addon folder and place it in the "resourcepacks" and "datapacks" folder in the Minecraft root directory.
# Start up Minecraft and click on ''Options'', then ''Resource Packs''. Select your pack to load it.
# Load/create a '''Creative''' world save that contains your addon in the "datapack" folder.
# Once in the world, you can run the command <code>/pokespawn <target pokemon> <species feature></code>.
# Ensure your new regional form is working properly.
# Check if your regional form spawns where you assigned it to. You can use <code>/checkspawn <rarity></code> when in the assigned biome.
#* You can run the command <code>/locate biome <assigned biome></code> to get coordinates to the assigned biome. You can then click on the coordinates it gave you and be teleported instantly.
# Make any desired edits to the asset files and save. Refresh resource packs with F3+T to see the changes you make.
# Make any desired edits to the data files and save. '''You need to quit to main menu, and load the world again if you want to see those changes.'''
#* The command for <code>/reload</code> does not work with Cobblemon addons unfortunately.

You should now have a functional regional variant!

{{Addon Creation}}

Tutorials/Regional Forms

2024-06-02T22:34:11Z

Frank The Farmer: /* Step 7: Test your addon in game */

{{TOC|right}}
== Preface ==
This tutorial will teach you how to create a regional form for '''''an existing Pokémon.''''' Regional forms are a species variant that can have different looks, types, abilities, moves, and spawn locations! '''Knowledge of [[Tutorials/Creating_A_Custom_Pokemon|creating custom Pokémon]] is ''required.''''' Creating a unique model and textures for your form is highly recommended, but not always necessary.

Due to regional forms usually requiring files for both data and assets, this type of pack will just be called an <code>addon</code> for simplicity. Addons that use data and asset folders will end up needing to have a copy in both the <code>datapacks</code> and <code>resourcepacks</code> game folders. The data and assets can be separated if desired, but are usually bundled together to make sharing easier!

=== Step 1: Arrange the folders for this addon ===
Due to some files sharing the same names later in this guide, you will be creating the folder structure and <code>pack.mcmeta</code> now. This is to prevent confusion going forward.

# Create a new text file and name it <code>pack.mcmeta</code>
#* Ensure that it doesn't end in other file extensions like .txt
# Open the file and insert the following data:
#* Hover over the underlined text to see more information.
{
"<abbr title="This lets Minecraft know that it is a datapack">pack</abbr>": {
"<abbr title="Here you will list the pack format number for a specific version of Minecraft">pack_format</abbr>": <abbr title="As of 1.20.1, the current resourcepack format number is 15. But it will still load if this number isn't correct!">15</abbr>,
"<abbr title="Here you will write a short description of your datapack">description</abbr>": "<abbr title="Your short datapack description">Example description</abbr>"
}
}
# <li value=3> Save the file and put it aside for now.
# Create a series of folders arranged like the following example:
==== Folder Structure ====
<div class="treeview">
*''(addon name)''
** '''pack.mcmeta'''
**assets
***cobblemon
****bedrock
*****pokemon
******animations
*******<target pokemon folder>
******models
*******<target pokemon folder>
******posers
******resolvers
*******<target pokemon folder>
****textures
*****pokemon
******<target pokemon folder>
**data
***cobblemon
****spawn_pool_world
****species_additions
****species_features
</div>
# <li value="5">Place the <code>pack.mcmeta</code> file into the first folder of your addon next to <code>assets</code> and <code>data</code>
After this folder tree for your addon is made, you can simply drop the files into the associated folders as you create them.
Remember that the <code>pack.mcmeta</code> is a file, not a folder to add. It must be one folder deep in order for Minecraft to recognize this pack as a resource pack or data pack when in the appropriate game folders.

=== Step 2: Create the assets for your regional variant ===
How you want your regional variant to look depends entirely on you. You can make it use a new texture over the original model. Most of the time, a new model, texture, and animations are created for this regional form. If for some reason you don't want it to have a visual difference at all, then you can skip anything regarding <code>assets</code>. Make sure your assets have a unique name so they don't overwrite any original form assets.

Assets for existing Pokémon can be obtained from the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/assets/cobblemon/bedrock/pokemon/models Gitlab] or the mod's JAR file. This can be helpful if you wanted to make a texture variant, or use the model as a base for the regional form. Just remember that animation files are made for specific models so they may need updating depending on what you make. These assets can be made in Blockbench or any relevant art apps.

# Create the regional form's <code>model</code>
# Create the regional form's <code>texture</code>
# Create the regional form's <code>animations</code>
# Export these files and place them into the appropriate folders in your addon pack
# Create a <code>[[poser]]</code> file for this regional form if new animations were created for the new model. (optional)

As knowledge of creating custom Pokémon is a requirement for this guide, you are expected to know how to make these files. Help can be found on the Cobblemon discord.

=== Step 3: Create a "species feature" ===
On the data side of things, the creation of a regional form starts with the [[Species_Features|species feature]]. A species feature is what allows a Pokémon to have a different set of stats and visuals applied to their regional forms. You will be creating a short JSON file that will be named after your custom region or idea. '''The feature can be named whatever you want it to be called.'''

# Create a new text file and name it after your region or idea. Include the extension of<code>.json</code>
#* Example: The alolan species feature is named <code>alolan.json</code>
#* Remember to use lowercase and make sure that the file does not end in any other extension like ".txt"
# Insert the following data into this new species feature JSON:
#* '''Remember to change <code>"custom_feature"</code> to match your file name! It must stay in quotes.'''
<syntaxhighlight>
{
"keys": ["custom_feature"],
"type": "flag",
"isAspect": true,
"default": false
}
</syntaxhighlight>
# <li value="3"> Save the file
# Place this new species feature file into the <code>species_feature</code> folder of your addon

<code>"isAspect": true</code> means that this new feature is both a <code>feature</code> and <code>aspect</code>!
Now that the species feature is made, you can apply it to a Pokémon's <code>form</code>

=== Step 4: Create a "species addition" file with "form" data ===
A <code>[[Species_Additions|species_addition]]</code> file is an efficient way of ''adding'' data to existing species files without having to rewrite the main species file. This allows your additions to be more compatible with other addons affecting the same Pokémon. You will be adding your regional <code>form</code> data to a species through this method.

# Create a new text file and name it after your Pokémon. Include the extension of <code>.json</code>
#* Example: <code>bulbasaur.json</code>
# Insert the following data into this new species_addition JSON:
<syntaxhighlight>
{
"target": "cobblemon:example",
"features": ["custom_feature"],
"forms": [
{
example form data
}
]
}
</syntaxhighlight>
# <li value="3"> Change <code>"cobblemon:example"</code> to reference the Pokémon you want to add a form to. It must remain in quotes.
#* Example: <code>"cobblemon:bulbasaur"</code>
# Change <code>"custom_feature"</code> to the feature you made earlier. It must remain in quotes.
# Write all the data for your form inside of the curly brackets
#* The average form data set is too long to list as an example for this guide. It's like writing data for an entirely different Pokémon, which is kind of what a regional variant is like.
#* If you need an example, you can look at the <code>"forms"</code> data for [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/resources/data/cobblemon/species/generation1/vulpix.json Vulpix on the Gitlab.] It starts on line 29 and ends on line 204.
#* Remember to include evolution data if this regional variant can evolve.
# Write your species feature name into the <code>"aspects"</code> section of your <code>"forms"</code> data.
#* Include the line for aspects if it doesn't exist yet. It should look like this:
<syntaxhighlight>
"aspects": ["custom_feature"]
</syntaxhighlight>
# <li value="7"> Save the file.
# Place this new species addition file into the <code>species_additions</code> folder of your addon.

Now your target Pokémon's new form should have the data that allows it to function differently in battles. Next you will create the data that allows it to spawn differently.

=== Step 5: Create the spawns for your regional form ===
The <code>[[Spawn_Pool_World|spawn_pool_world]]</code> folder holds all the spawning files for each Pokémon. You will be creating a new file for your regional variant. It can be as simple or complicated as you make it. It is recommended that you use the normal form's spawn file as a base for your regional form. Those spawn files can be found on the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/data/cobblemon/spawn_pool_world Gitlab.]

To keep things simple, this part of the guide will show you how to recycle a spawn file by changing the Pokémon name and biome conditions.
# Obtain your target Pokémon's <code>spawn_pool_world</code> JSON.
# Rename the file to anything you want. The name must be different than the original.
#* Example: <code>regional_bulbasaur</code>
# Open the file and locate all the strings for <code>"id"</code> and <code>"pokemon"</code>
# Edit the Pokémon's name '''and include''' the name of your species feature after like this example:
#* You must use a space after the Pokémon name for the <code>"pokemon"</code> string.
<syntaxhighlight>
"id": "bulbasaur-alolan-1",
"pokemon": "bulbasaur alolan",
</syntaxhighlight>
# <li value="5">Locate all the strings for <code>"biomes"</code> if they exist
# Change the listed biome(s) to something different!
#* This will allow the regional variant to spawn in biomes the normal variant does not.
#* The list of biome tags can be found [https://docs.google.com/document/d/1iB0EJSc2r6mRJXIo1n3XpHbZ5udwJVnrh2pXdhTyH8c/edit here.]
# Save the file
# Place this new spawn file in the <code>spawn_pool_world</code> folder of your addon

This should be the last of the data folder files. By now, your regional variant can stand on its own data-wise. It should have different stats, and spawns. Now it just needs a different look.

=== Step 6: Create the resolver file for your regional form ===
Back in step 2, you should have already made the files for <code>models</code>, <code>textures</code>, <code>animations</code>, and <code>posers</code>. The last thing you need to do is assign them to your regional variant by creating a new <code>[[resolver]]</code> file.

# Obtain your target Pokémon's <code>resolver</code> JSON.
# Change the name of this resolver to <code>1_<pokemon>_base</code>
#* You change the number from 0 to 1 so it can load after the normal variant's data
#* Sometimes a number greater than 1 is needed, especially if your target Pokémon has gender variants.
# Open the resolver file and locate the string for <code>"order"</code>.
# Change the value of "order" from 0 to 1.
#* Again, sometimes this value needs to be greater than 1.
# Add the name of your species feature to the <code>"aspects"</code> string
#* Example: <code>"aspects": ["alolan"]</code>
#* This allows any Pokémon that spawned with this feature/aspect to use any following model, textures, or poser.
# Assign any <code>poser</code>, <code>model</code>, or <code>textures</code> that you made in Step 2.
# Save the file
# Place this new resolver in the <code>resolvers</code> folder of your addon

=== Step 7: Test your addon in game ===
Load your addon in game to see if your regional form looks different from the normal one. You can have Blockbench open to edit any relevant asset file '''in the resourcepacks folder''' if needed.
# Copy your addon folder and place it in the "resourcepacks" and "datapacks" folder in the Minecraft root directory.
# Start up Minecraft and click on ''Options'', then ''Resource Packs''. Select your pack to load it.
# Load/create a '''Creative''' world save that contains your addon in the "datapack" folder.
# Once in the world, you can run the command <code>/pokespawn <target pokemon> <species feature></code>.
# Ensure your new regional form is working properly.
# Check if your regional form spawns where you assigned it to. You can use <code>/checkspawn <rarity></code> when in the assigned biome.
#* You can run the command <code>/locate biome <assigned biome></code> to get coordinates to the assigned biome. You can then click on the coordinates it gave you and be teleported instantly.
# Make any desired edits to the asset files and save. Refresh resource packs with F3+T to see the changes you make.
# Make any desired edits to the data files and save. '''You need to quit to main menu, and load the world again if you want to see those changes.'''
#* The command for <code>/reload</code> does not work with Cobblemon addons unfortunately.

You should now have a functional regional variant!

{{Addon Creation}}

Template:Addon Creation

2024-05-19T13:54:11Z

Frank The Farmer: Updated Addon Creation Template to show new and old poser pages

{{NavigationBox
|title=Addon Creation
|rows=
{{NavigationRow|category=Tutorials|content=
[[Tutorials/Creating A Custom Pokemon|Creating A Custom Pokemon]] [[Tutorials/Creating A Model|Creating A Model]] [[Tutorials/Creating Custom Spawns|Creating Custom Spawns]] [[Tutorials/Emissive Textures|Emissive Textures]] [[Tutorials/Animated Textures|Animated Textures]] [[Tutorials/Texture replacement|Texture Replacement]] [[Tutorials/Animation Replacement|Animation Replacement]] [[Tutorials/Regional_Forms| Regional Forms]][[Tutorials/Multiple Visual Variants|Multiple Visual Variants]] [[Tutorials/Adding_Sounds_To_Animations|Adding Sounds To Animations]]
}}
{{NavigationRow|category=Asset Files|content=
[[Resolver]] [[Poser| Old Poser]] [[New_Poser| New Poser]] [[Sounds]]
}}
{{NavigationRow|category=Data Files|content=
[[Species]] [[Species Features]] [[Species Feature Assignments]] [[Species Additions]] [[Spawn Detail Presets]] [[Spawn Pool World]] [[Fossils_File|Fossils]]
}}
{{NavigationRow|category=Properties|content=
[[Pokémon/Behaviour|Behaviour]] [[Spawn Condition]] [[Advancements]]
}}
}}
[[Category:Addon Creation]]

Tutorials/Creating Custom Spawns

2024-05-19T13:52:35Z

Frank The Farmer: Updated conditions links to use wiki page instead

{{TOC|right}}
== Preface ==
This tutorial will show you how to create your own custom Pokémon spawns. The JSONs in the [[Spawn Pool World|spawn pool world]] folder control how a Pokémon will spawn naturally. You can create or edit files for each Pokémon to give them new spawn conditions. Writing some extra data in the <code>pack.mcmeta</code> of a datapack can also nullify the spawns from the base mod. You can use this to have total control over Pokémon spawns.

Some third party tools exist to help with the mass production of spawn files. Help with mass spawn file production can be found on the Cobblemon Discord server.

=== Step 1: Arrange the folders for this addon ===
Depending on the kind of addon you want to make, you may want to make some slight adjustments to your folder structure of your spawn files. Generally, you can arrange your custom spawn files the same way other addons do. Your spawn files can have their own <code>namespace</code> if you don't want them to be affected by other mods.

==== Create a pack.mcmeta to suit your needs ====
Your <code>pack.mcmeta</code> can affect how your addon will work with other addons loaded before yours. A normal pack.mcmeta will have no affect on other addons, but adding some extra lines of data to it can completely nullify files in a specified folder.

Use one of the following <code>pack.mcmeta</code> examples below. Unless you have plans to negate all other spawns, like making your own custom region for something, then just make an addon friendly <code>pack.mcmeta</code> file!

* '''The addon friendly pack.mcmeta''' - This one wont affect other addon files
*# Create a new text file and name it <code>pack.mcmeta</code>
*#* Ensure that it doesn't end in other file extensions like .txt
*# Open the file and insert the following data:
{
"<abbr title="This lets Minecraft know that it is a datapack">pack</abbr>": {
"<abbr title="Here you will list the pack format number for a specific version of minecraft">pack_format</abbr>": <abbr title="As of 1.20.1, the current datapack format number is 15. But it will still load if this number isn't correct!">15</abbr>,
"<abbr title="Here you will write a short description of your datapack">description</abbr>": "<abbr title="Your short datapack description">Example datapack description</abbr>"
}
}
::# <li value=3> Save the file and prepare to place it in your addon folders.

* '''The pack.mcmeta that negates all other spawns''' - Will prevent spawns in the base mod or addons loaded before it from working.
*# Create a new text file and name it <code>pack.mcmeta</code>
*#* Ensure that it doesn't end in other file extensions like .txt
*# Open the file and insert the following data:
{
"<abbr title="This lets Minecraft know that it is a datapack">pack</abbr>": {
"<abbr title="Here you will list the pack format number for a specific version of Minecraft">pack_format</abbr>": <abbr title="As of 1.20.1, the current datapack format number is 15. But it will still load if this number isn't correct!">15</abbr>,
"<abbr title="Here you will write a short description of your datapack">description</abbr>": "<abbr title="Your short datapack description">Example datapack description</abbr>"
},
"<abbr title="This tells Minecraft that you want to filter some previously loaded data">filter</abbr>": {
"<abbr title="This tells Minecraft that you want to block the listed folders and its files">block</abbr>": [
{
"<abbr title="Here you will specify what namespaces you want to filter from. A namespace is the folder inside of the data folder for datapacks">namespace</abbr>": "<abbr title="Here you are specifying that you want to block some folders that are inside the cobblemon namespace">cobblemon</abbr>",
"<abbr title="Here you will list the exact folder path that you want blocked">path</abbr>": "<abbr title="You are specifying that you want to block any files in the spawn pool world folder of the cobblemon namespace. This would often be any other addon's spawn files.">spawn_pool_world</abbr>"
}
]
}
}
::# <li value=3> Save the file and prepare to place it in your addon folders.

Now, you can create the folders to place your files into.

==== Folder Structure ====
Now you can create the folder structure for your addon. Create a series of folders arranged like the following example. Don't forget to place your <code>pack.mcmeta</code> that you just made. You can create your own namespace instead of using the cobblemon namespace if you don't want your spawn files to be affected from folder blocking.

'''Folder Structure'''
<div class="treeview">
*''(addon name)''
** '''pack.mcmeta'''
**data
***<abbr title="This is a namespace. You can create your own if you need to">cobblemon</abbr>
****spawn_pool_world
*****''<sub_folders>'' (optional)
</div>

All of the <code>spawn files</code> will be placed somewhere in the spawn pool world folder!

=== Step 2: Create your spawn files ===
There's a lot of data that can go into a <code>[[Spawn Pool World|spawn file]]</code>. The data in spawn files can be rather self-explanatory. These files can be as simple as "spawn in the forest", or as complicated as "spawn at 2:30AM-3:00AM on top of clay during the new moon in an ocean biome that is south of spawn." The possibilities are limited by your creativity and understanding of [[Spawn_Condition| spawn conditions]]

Keep in mind that the sort of "economy" of local spawns will affect the rarity of the Pokémon you are making spawn files for. For example, if you made spawn conditions for a Kyogre to spawn on the ocean surface in the ultra-rare pool with a really low weight, it will actually spawn more frequently than you intended despite the low weight. This is because there aren't many ultra-rare water surface spawns to begin with. If this example Kyogre is the only ultra-rare spawn in this local ultra-rare pool, then whenever the game decides to spawn an ultra-rare Pokémon, it will be Kyogre 100% of the time. Kyogre would have no other ultra-rare spawn to compete with so it will always be the chosen spawn.

Here is a list of options that some of the spawn properties can use:
* '''"presets"''': You can use any of these presets listed on the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/data/cobblemon/spawn_detail_presets Gitlab] or you can make your own [[Spawn Detail Presets|presets]].
* '''"context"''': You can choose between <code>"grounded"</code> for land spawns, <code>"submerged"</code> for underwater spawns, and <code>"surface"</code> for spawns on the surface of water or lava.
* '''"bucket"''': The rarity pool of the Pokémon. You can choose <code>"common"</code>, <code>"uncommon"</code>, <code>"rare"</code>, or <code>"ultra-rare"</code>
* '''"weight"''': This determines how common the Pokémon will be inside of the assigned rarity pool. Generally, you can treat it like a scale of 0.1 to 10 on how rare it will be in that pool. You can use numbers higher than 10 if you really want that Pokémon to spawn more often.
* '''"condition"''': You can use any of the conditions listed [[Spawn_Condition| here]] to make Pokémon spawn
* '''"anticondition"''': You can use any of the conditions listed [[Spawn_Condition| here]] to '''PREVENT''' a Pokémon from spawning
* '''"biomes"''': A subcategory of conditions and anticonditions. You can use biome ids or any [https://docs.google.com/document/d/1iB0EJSc2r6mRJXIo1n3XpHbZ5udwJVnrh2pXdhTyH8c/edit biome tags]. Should work with modded biome id's too!

To keep things simple, this part of the guide will show you how to create a spawn file from a template.
# Obtain a JSON to use as a template from the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/data/cobblemon/spawn_pool_world Gitlab].
#* Buneary is a great example template. The file is short, but Buneary is very common due to having 3 biome groups it can spawn in.
# Rename the file to anything you want. The name must be different than the original.
#* Example: <code>bunearyspawn2</code>
#* If the file name and folder path are exactly the same as the base mod, then it will replace the base mod's spawn file instead. This is only recommended if you want to tune existing spawn files to your liking.
# Open the file and locate all the strings for <code>"id"</code> and <code>"pokemon"</code>
# Edit the Pokémon's name '''and replace''' it with the Pokémon you want to make custom spawns for.
#* If you stop after this step, then the replacement Pokémon will now spawn in the exact same conditions as the previous Pokémon.
# Replace the list of <code>"[[Spawn Detail Presets|presets]]"</code> if desired
#* A list of available presets can be found on the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/data/cobblemon/spawn_detail_presets Gitlab]
# Replace the value for <code>"context"</code> if desired.
# Replace the value for <code>"bucket"</code> if desired.
# Change the values for <code>"level"</code>. This is the minimum and maximum level it will spawn at.
# Replace the value for <code>"weight"</code> if desired.
#* Treat the number like a scale of 0.1 to 10 for its rarity bucket. This will keep your spawns balanced with other spawn files.
# Change the<code>"condition"</code> values if desired.
#* Most of the time, you'll want to change the list of <code>"biomes"</code>
# Change the<code>"anticondition"</code> values if desired.
#* Sometimes you might even want to delete this section if it exists in the template.
# Save the file.
# Place this new spawn file in the <code>spawn_pool_world</code> folder of your addon
# Repeat the whole process for any other spawn files you want to make!

=== Step 3: Test your addon in game ===
Load your addon in game to see if your custom spawn files are working. You can have your preferred file editor open to edit any relevant JSON files '''in the datapacks folder''' if needed.
# Copy your addon folder and place it in the "datapacks" folder of your world in the Minecraft root directory.
# Start up Minecraft.
# Load/create a '''Creative''' world save that contains your addon in the "datapack" folder.
# Check if your target Pokémon spawns where you assigned it to. You can use <code>/checkspawn <rarity></code> when in the assigned biome.
#* You can run the command <code>/locate biome <assigned biome></code> to get coordinates to the assigned biome. You can then click on the coordinates it gave you and be teleported instantly.
#* You can also use the command <code>/locate structure <assigned structure></code> if you used a structure condition.
# Ensure that your target Pokémon at least appears in the <code>checkspawn</code> list after meeting its conditions.
#* If your Pokémon appears in this checkspawn list, then it will spawn in the area eventually! It's always a matter of time and RNG.
# Make any desired edits to the data files and save. '''You need to quit to main menu, and load the world again if you want to see those changes.'''
#* The command for <code>/reload</code> does not work with Cobblemon addons unfortunately.

You should now have new natural Pokémon spawns!

{{Addon Creation}}
[[Category:Tutorial]]

Poser

2024-05-19T12:27:12Z

Frank The Farmer: /* Placeholder Animations */

Under construction. Dont look or else!

{{TOC|right}}
== Preface ==
The new <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]

== Poser Properties ==
Before breaking down each section of the new Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!

=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon. Animation types would include your faints, cries, and attack animations. Below is a list of currently available Animation types and Poses to choose from. 

==== Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.

==== q.bedrock_stateful ====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


==== q.bedrock_primary ====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


Since Primary animations behave in a similar way to swapping poses, they can use special transition animation types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 primary animation in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"


==== q.curve ====
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",

==== q.bedrock ====
The <code>q.bedrock()</code> function is the familiar animation format from the [[Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},

=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a larger Z value.

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting. 

List of Currently Implemented Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isTouchingWaterOrRain"</code>: The Pokémon must be touching water or rain. Again, not necessarily underwater.
* <code>"isSubmergedInWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},


=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each placeholder features a very simple animation that swings a limb back and forth. For now, you'll have to figure out how to configure these yourself lol

Here is a list of all the Placeholder animations:
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L172 "q.quadruped_walk()"]</code> - A basic walk animation for Pokémon with 4 legs
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L192 "q.biped_walk()"]</code> - A basic walking animation for Pokémon who stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L208 "q.bimanual_swing()"]</code> - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L224 "q.sine_wing_flap()"]</code> - A basic wing flap animation for a pair of wings on a Pokémon.



== Poser File Breakdown ==
Soon™


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that not all Pokémon have a bone called <code>head</code>.

Here is an example of a poser file for a custom <code>riolu</code> that includes all currently implemented poses and their appropriate animations.
* Riolu obviously can't fly. This is just an example as no Pokémon can do everything currently.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 2.3,
"portraitTranslation": [-0.1, 0.58, 0],
"profileScale": 0.75,
"profileTranslation": [0, 0.68, 0],
"animations": {
"faint": "q.bedrock_primary('riolu', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('riolu', 'cry')",
"recoil": "q.bedrock_stateful('riolu', 'recoil')",
"physical": "q.bedrock_primary('riolu', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('riolu', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('riolu', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'battle_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('riolu', 'blink')"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"hover": {
"poseTypes": ["HOVER"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"fly": {
"poseTypes": ["FLY"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_fly')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('riolu', 'sleep')"]
},
"shoulder_left": {
"poseTypes": ["SHOULDER_LEFT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_left')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"shoulder_right": {
"poseTypes": ["SHOULDER_RIGHT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_right')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
}
}
}

{{Addon Creation}}

Poser

2024-05-19T12:24:56Z

Frank The Farmer: AAAAAAAAAAAHHHHH

Under construction. Dont look or else!

{{TOC|right}}
== Preface ==
The new <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]

== Poser Properties ==
Before breaking down each section of the new Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!

=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon. Animation types would include your faints, cries, and attack animations. Below is a list of currently available Animation types and Poses to choose from. 

==== Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.

==== q.bedrock_stateful ====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


==== q.bedrock_primary ====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


Since Primary animations behave in a similar way to swapping poses, they can use special transition animation types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 primary animation in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"


==== q.curve ====
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",

==== q.bedrock ====
The <code>q.bedrock()</code> function is the familiar animation format from the [[Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},

=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a larger Z value.

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting. 

List of Currently Implemented Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isTouchingWaterOrRain"</code>: The Pokémon must be touching water or rain. Again, not necessarily underwater.
* <code>"isSubmergedInWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},


=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each animation features a very simple animation that swings a limb back and forth. For now, you'll have to figure out how to configure these yourself lol

Here is a list of all the Placeholder animations:
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L172 "q.quadruped_walk()"]</code> - A basic walk animation for Pokémon with 4 legs
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L192 "q.biped_walk()"]</code> - A basic walking animation for Pokémon who stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L208 "q.bimanual_swing()"]</code> - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L224 "q.sine_wing_flap()"]</code> - A basic wing flap animation for a pair of wings on a Pokémon.



== Poser File Breakdown ==
Soon™


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that not all Pokémon have a bone called <code>head</code>.

Here is an example of a poser file for a custom <code>riolu</code> that includes all currently implemented poses and their appropriate animations.
* Riolu obviously can't fly. This is just an example as no Pokémon can do everything currently.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 2.3,
"portraitTranslation": [-0.1, 0.58, 0],
"profileScale": 0.75,
"profileTranslation": [0, 0.68, 0],
"animations": {
"faint": "q.bedrock_primary('riolu', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('riolu', 'cry')",
"recoil": "q.bedrock_stateful('riolu', 'recoil')",
"physical": "q.bedrock_primary('riolu', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('riolu', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('riolu', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'battle_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('riolu', 'blink')"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"hover": {
"poseTypes": ["HOVER"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"fly": {
"poseTypes": ["FLY"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'air_fly')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('riolu', 'sleep')"]
},
"shoulder_left": {
"poseTypes": ["SHOULDER_LEFT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_left')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
},
"shoulder_right": {
"poseTypes": ["SHOULDER_RIGHT"],
"animations": [
"q.look('head')",
"q.bedrock('riolu', 'shoulder_right')"
],
"quirks": ["q.bedrock_quirk('riolu', 'blink')"]
}
}
}

{{Addon Creation}}

Poser

2024-05-19T11:56:30Z

Frank The Farmer: Messy Construction

Under construction. Dont look or else!

{{TOC|right}}
== Preface ==
The new <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]

== Poser Properties ==
Before breaking down each section of the new Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function. You will notice that the poser now includes something in the format of <code>q.<function></code>. These are molang functions which allow you to do many new things. The q stands for query and its just part of the standard format for these new functions. Some functions can even go inside of other functions. It's not terribly complicated once you read what each one does. They allow addon creators to do many things they couldn't before!

=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon. Animation types would include your faints, cries, and attack animations. Below is a list of currently available Animation types and Poses to choose from. 

==== Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.

==== q.bedrock_stateful ====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


==== q.bedrock_primary ====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


Since Primary animations behave in a similar way to swapping poses, they can use special transition animation types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 primary animation in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"


==== q.curve ====
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",

==== q.bedrock ====
The <code>q.bedrock()</code> function is the familiar animation format from the [[Poser | old poser]] which got converted into a molang function. It's the same thing as before, just in a new look. You are still just listing your Pokémon and then the animation in the parenthesis. This function is mainly used to assign poses their animations. These animations are meant to be overwritten by Primary or Stateful animations whenever convenient.
Below is an example of the <code>q.bedrock</code> function assigning a walk animation to the <code>"WALK"</code> pose type:
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.bedrock('blastoise', 'ground_walk')"
]
},

=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a larger Z value.

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting. 

List of Currently Implemented Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isTouchingWaterOrRain"</code>: The Pokémon must be touching water or rain. Again, not necessarily underwater.
* <code>"isSubmergedInWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},


=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Look Animation(s) ===
The new Poser allows you to manipulate the look animation in a number of ways. Creators can now list multiple look animations where each one can define its own head bone and edit some of the properties of the look animation. Changing the properties allows you to manipulate the sight cone of the Pokémon if desired. This can help prevent some odd clipping or extend/shorten how far it can look up and down or left and right. Having multiple look animations allows for Pokémon with multiple heads to turn each head individually. You could even assign the torso and head bones to look at the same time while limiting the range for each. This can be helpful for Pokémon with little to no neck and they have to look with their body more than their head. 

The <code>q.look()</code> function is the format of this new look animation. When using this function, all the properties must be listed in a specific order and the name of the bone must be in single quotes. (the apostrophe key) 

* Please refer to the image below to visualize pitch, yaw, and the origin.
* Pressing F3+B in game can show the hitboxes. That blue line shows where the pokemon is looking at and if its looking at nothing, it is centered at 0 pitch and yaw. You can call this the origin.
[[File:Sight_Cones.png|800px|caption|The default sight cone visualized.]]


The properties of <code>q.look</code> must be in the following order:
* With the exception of the bone name, these are also the default values for each property
# Bone name: <code>'head_ai'</code> - The name of the bone on the model which will perform the look animation
# Pitch Multiplier - <code>1</code> - Multiplies the amount of pitch gained by this amount. Can use -1 to invert the pitch!
# Yaw Multiplier - <code>1</code> - Multiplies the amount of yaw gained by this amount. Can use -1 to invert the yaw!
# Max Pitch - <code>70</code> - How many degrees the Pokémon can look down from origin.
# Min Pitch - <code>-45</code> - How many degrees the Pokémon can look up from origin.
# Max Yaw - <code>45</code> - How many degrees the Pokémon can look right from origin.
# Min Yaw - <code>-45</code> - How many degrees the Pokémon can look left from origin.

A look animation using the previously listed values would look something like this inside of the standing pose:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai', 1, 1, 70, -45, 45, -45)",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to use the default values and keep it short, you can also write it like this:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.bedrock('riolu', 'ground_idle')"
],

If you want to list multiple head bones, you can write the q.look function multiple times:
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"animations": [
"q.look('head_ai')",
"q.look('torso')",
"q.bedrock('riolu', 'ground_idle')"
],


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]


=== Placeholder Animations ===
The new poser allows creators to use the placeholder animations which the JSON poser could not access before. These placeholder animations are based on the body type or limb features of the Pokémon. Each animation features a very simple animation that swings a limb back and forth. For now, you'll have to figure out how to configure these yourself lol

Here is a list of all the Placeholder animations:
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L172 "q.quadruped_walk()"]</code> - A basic walk animation for Pokémon with 4 legs
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L192 "q.biped_walk()"]</code> - A basic walking animation for Pokémon who stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L208 "q.bimanual_swing()"]</code> - A basic arm swinging animation for Pokémon with 2 arms that usually stand on 2 legs.
* <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/PoseableEntityModel.kt#L224 "q.sine_wing_flap()"]</code> - A basic wing flap animation for a pair of wings on a Pokémon.



== Poser File Breakdown ==
The <code>poser</code> file requires an <code>animation</code> JSON to assign animations to a <code>model</code>. You're always going to want to be familiar with all the animations that were made for a model. If you assign an animation type that doesn't exist in the animation JSON then the game will crash! Also, if a bone you listed in the poser doesn't exist on the model then the game will crash! Once you figure out what animations were made for your target Pokémon model, you can simply apply the existing animations to appropriate <code>poses</code>.

Here is a breakdown of an example poser file which includes all the different properties that can be assigned. Hover over the underlined text to see more information. '''Every kind of possible poser function is included in this example at least once! So make sure that you review the whole file to see why some things are written the way they are.'''

* This example is not meant to be used as a template.
{
"portraitScale": 1.3,
"portraitTranslation": [-0.7, 2.1, 0],
"profileScale": 0.45,
"profileTranslation": [-0.1, 1.0, 0],
"animations": {
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'battle_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('blastoise', 'sleep')"]
}
}
}


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that some Pokémon don't use a <code>head bone</code>.

Here is an example of a poser file for a custom <code>starly</code> that includes all currently implemented poses and their appropriate animations.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 1.3,
"portraitTranslation": [-0.7, 2.1, 0],
"profileScale": 0.45,
"profileTranslation": [-0.1, 1.0, 0],
"animations": {
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'battle_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('blastoise', 'sleep')"]
}
}
}

{{Addon Creation}}

File:Sight Cones.png

2024-05-19T11:35:38Z

Frank The Farmer: Very Good Diagram

== Summary ==
Very Good Diagram

Poser

2024-05-19T09:49:41Z

Frank The Farmer: /* Quirks */

Under construction. Dont look or else!

{{TOC|right}}
== Preface ==
The new <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]

== Poser Properties ==
Before breaking down each section of the new Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function.
=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon. Animation types would include your faints, cries, and attack animations. Below is a list of currently available Animation types and Poses to choose from. 

==== Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.

==== q.bedrock_stateful ====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


==== q.bedrock_primary ====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


Since Primary animations behave in a similar way to swapping poses, they can use special transition animation types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 primary animation in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"


==== q.curve ====
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",


=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a larger Z value.

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting. 

List of Currently Implemented Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isTouchingWaterOrRain"</code>: The Pokémon must be touching water or rain. Again, not necessarily underwater.
* <code>"isSubmergedInWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},


=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Quirks ===
Quirk animations are stateful animations (for now) that you can have play over the main animation for a pose. The new poser format introduced a shorthand method to writing in your quirk animations in the <code>q.bedrock_quirk()</code> format. The [[Poser#Quirks | old Poser method for quirks]] can be condensed into one line using this function. When using this function, all the properties must be listed in specific order, placed inside of single quotes (the apostrophe key) unless its a number, and separated by commas.

If your poser and animations are made just right, then you can have a single Pokémon running so many quirk animations at once. Remember that you can combine any of the following quirk examples if you have lots of animations like Blastoise.

The properties of <code>q.bedrock_quirk</code> must be in the following order:
# Animation Group: <code>'blastoise'</code> - the name of the Pokémon
# Animation Name(s): <code>'quirk_ground_idle'</code> - the name of the animation. Supports a pool of animations using the <code>q.array</code> function
# Minimum seconds between occurences: <code>20</code> - The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time.
# Maximum seconds between occurences: <code>60</code> - What do you think?
# Loop times: <code>1</code> - The number of times the animation should play for the quirk

The previously listed properties would get written as a quirk like so:
"quirks": [
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]

You don't need to include all the properties if you just want to use the default values of 8-30 seconds between quirks. You can write it like so to use the default values and keep it short:
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')"
]

==== q.array ====
You can replace your animation name with the <code>q.array()</code> function to have the quirk pick from a list of animations to play. This can be helpful if you have a lot of quirks that you want to play under one pose. You simply need to put the list of animations inside of the parenthesis, include each animation name inside of single quotes, and separate them with a comma.
* Example: <code>q.array('quirk_battle_idle', 'quirk_battle_idle2')</code>
** These quirks are for Blastoise adjusting each of its cannons. Writing it this way lets Blastoise adjust only one cannon at a time, but it's a random cannon each time.

So if you were to make that into a quirk, it would look like this:
"quirks": [
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]

=== Placeholder Animations ===
the placeholder animations cobblemon uses if a pokemon is not animated based on the body type of the pokemon. AAAAAAAAAAAAAAAAAAAAAA


== Poser File Breakdown ==
The <code>poser</code> file requires an <code>animation</code> JSON to assign animations to a <code>model</code>. You're always going to want to be familiar with all the animations that were made for a model. If you assign an animation type that doesn't exist in the animation JSON then the game will crash! Also, if a bone you listed in the poser doesn't exist on the model then the game will crash! Once you figure out what animations were made for your target Pokémon model, you can simply apply the existing animations to appropriate <code>poses</code>.

Here is a breakdown of an example poser file which includes all the different properties that can be assigned. Hover over the underlined text to see more information. '''Every kind of possible poser function is included in this example at least once! So make sure that you review the whole file to see why some things are written the way they are.'''

* This example is not meant to be used as a template.
{
"portraitScale": 1.3,
"portraitTranslation": [-0.7, 2.1, 0],
"profileScale": 0.45,
"profileTranslation": [-0.1, 1.0, 0],
"animations": {
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'battle_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('blastoise', 'sleep')"]
}
}
}


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that some Pokémon don't use a <code>head bone</code>.

Here is an example of a poser file for a custom <code>starly</code> that includes all currently implemented poses and their appropriate animations.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 1.3,
"portraitTranslation": [-0.7, 2.1, 0],
"profileScale": 0.45,
"profileTranslation": [-0.1, 1.0, 0],
"animations": {
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'battle_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('blastoise', 'sleep')"]
}
}
}

{{Addon Creation}}

Poser

2024-05-19T07:29:51Z

Frank The Farmer: Lots of Construction has been done

Under construction. Dont look or else!

{{TOC|right}}
== Preface ==
The new <code>poser</code> JSON controls all the animations of a Pokémon just as the old [[Poser]] did. It contains the same information for when the Pokémon will perform certain animations, but has received many requested upgrades. Some of these upgrades include multi-bone look animations, support for move animations, and even selecting from a pool of animations for quirks. Functionality of the new Poser will always be maintained and should let addon creators have the same options as the [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/kotlin/com/cobblemon/mod/common/client/render/models/blockbench/pokemon/gen1/SquirtleModel.kt hard-coded Kotlin Posers.]

== Poser Properties ==
Before breaking down each section of the new Poser file, let's take a look at all its different properties and how to use them. This section includes all of the different functions of the poser, any configurable options for said function, and how to write each function.
=== Poses & Animations ===
There's a handful of Pose types and Animation types that you can make animations for. <code>Poses</code> are the states a Pokémon is in, like idle or moving. Poses are for assigning animations like your ground idles, ground walks, water idles, etc. The <code>animation types</code> are the different events in battles that you can assign animations to for each Pokémon. Animation types would include your faints, cries, and attack animations. Below is a list of currently available Animation types and Poses to choose from. 

==== Animations ====
* '''faint''': <code>animation.<pokemon>.faint</code> - The animation that plays when a Pokémon faints.
* '''cry''': <code>animation.<pokemon>.cry</code> - The animation that plays when a Pokémon is called out or when it starts battle.
* '''recoil''': <code>animation.<pokemon>.recoil</code> - The animation that plays when a Pokémon takes damage in battle.
* '''physical''': <code>animation.<pokemon>.physical</code> - The animation that plays when a Pokémon uses a physical move in battle.
* '''special''': <code>animation.<pokemon>.special</code> - The animation that plays when a Pokémon uses a special move in battle.
* '''status''': <code>animation.<pokemon>.status</code> - The animation that plays when a pokemon uses a status move in battle.

==== Poses ====
* '''"STAND"''': <code>animation.<pokemon>.ground_idle</code> - The animation that plays when a Pokémon is idle on land.
** This pose type is also used for battle-idles: <code>animation.<pokemon>.battle_idle</code>
* '''"PORTRAIT"''': <code>animation.<pokemon>.portrait</code> - The animation that plays in the Party Overlay, or left hand party GUI
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"PROFILE"''': <code>animation.<pokemon>.profile</code> - The animation that plays in the Party Menu, or when you press M.
** This pose often uses the <code>ground_idle</code> instead of a dedicated animation.
* '''"WALK"''': <code>animation.<pokemon>.ground_walk</code> - The animation that plays when a Pokémon is moving on land
* '''"HOVER"''': <code>animation.<pokemon>.air_idle</code> - The animation that plays when a Pokémon is idle in the air.
* '''"FLY"''': <code>animation.<pokemon>.air_fly</code> - The animation that plays when a Pokémon is moving in the air.
* '''"FLOAT"''': <code>animation.<pokemon>.water_idle</code> - The animation that plays when a Pokémon is idle in or on water.
* '''"SWIM"''': <code>animation.<pokemon>.water_swim</code> - The animation that plays when a Pokémon is moving in or on water.
* '''"SLEEP"''': <code>animation.<pokemon>.sleep</code> - The animation that plays when a Pokémon is asleep. Usually on land.
* '''"SHOULDER_LEFT"''': <code>animation.<pokemon>.shoulder_left</code> - The animation that plays when the Pokémon is on the player's left shoulder.
* '''"SHOULDER_RIGHT"''': <code>animation.<pokemon>.shoulder_right</code> - The animation that plays when the Pokémon is on the player's right shoulder.

==== q.bedrock_stateful ====
The function <code>q.bedrock_stateful()</code> allows you to assign a stateful animation to an animation type. <code>Stateful animations</code> are meant to animate just a few bones of the Pokémon and get overlaid on the current pose. An example would be cries only animating the mouth or head of the Pokémon. A stateful animation won't take control of the whole model to play its animation.


Here is an example of the 2 stateful animations, cry and recoil, in the poser:
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",


==== q.bedrock_primary ====
The function <code>q.bedrock_primary()</code> allows you to assign a primary animation to an animation type. <code>Primary animations</code> are meant to take control of the entire model to play its animation and will clear any previous animations it was doing. An example would be a Pokémon's physical attack animation. When a Pokémon uses a physical move, it should clear the battle idle animation and play its physical animation instead. These animations often move the whole body and many of its limbs. When the physical animation is done, it returns control of the model to the battle idle after the physical animation has finished and should play a short transition animation in between.


Since Primary animations behave in a similar way to swapping poses, they can use special transition animation types via the <code>q.curve</code> property written within its sub properties. These provide different types of smoothness to the interpolation and will be explained in the next section.


Below is an example of the 4 primary animation in the poser:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"


==== q.curve ====
The function <code>q.curve()</code> is a sub function for <code>q.bedrock_primary()</code> which allows the animation to interpolate back into the main pose. This allows the transition between animations to behave similarly to linear keyframes and smooth keyframes when animating.


The q.curve function comes with 3 options for now which are:
* <code>one</code>: Does not interpolate at all. Just jumps from one animation to the next. Preferred for faint animations.
* <code>symmetric</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench. Not preferable, but is an option.
* <code>symmetrical_wide</code>: Interpolates in a similar fashion to 2 smooth keyframes in blockbench, but with a wider margin. The preferred choice when transitioning from moves.

Below is an example of the 2 main q.curve types:
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",


=== Portraits and Profiles & Scale and Translation ===
Portrait and Profile are the poses that are used when rendering any Pokémon in a GUI or Menu. Portrait is used for the left hand party screen, or Party Overlay, and Profile is used for the Party Menu. The poser file assigns some <code>Scale</code> and <code>Translation</code> values to these poses which control the camera location for rendering the Pokémon. There is a dev tool that you can enable in the [[Config]] which allows you to use some customizable keys to move the camera around the Pokémon in these menus. This tool will print the Scale and Translation values when the associated hotkey is pressed. 

<code>Translation</code> values control the location of the camera for the Portrait or Profile. Translation is a set of 3 values which represent xyz coordinates. You will mainly be changing the first 2 values, or the x and y axis values. X for left and right, and Y for up and down. The Z value is rarely used, but is important for really big models that are not being fully rendered in the menus. It often needs a larger Z value.

<code>Scale</code> values control the amount of zoom for the Portrait or Profile. A value less than one should make it zoom out and a value greater than one will zoom in. Sometimes with larger models, the camera cannot render the whole Pokémon no matter how far you zoom out. The back side of the Pokémon may not be rendered. This means you need to increase the Translation z value.

Below is a short breakdown of the previously mentioned properties:
"<abbr title="This property controls the size of the Pokémon in the party menu on the left side of the screen. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitScale</abbr>": 1.65,
"<abbr title="This property controls the location of the Pokémon in the party menu on the left side of the screen. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">portraitTranslation</abbr>": [0, -0.6, 0],
"<abbr title="These refer to the full body view of the Pokémon seen in GUI, but most notably the summary UI. (Tip: you can refresh your resource pack with F3 + T for quick edits.)">profileScale</abbr>": 1,
"<abbr title="This property controls the location of the Pokémon seen in GUI, but most notably the summary UI. The first value moves it left or right, which is your x axis. The second value moves it up or down, which is your y axis. The third value seems to do nothing and can generally be ignored. (Tip: you can refresh your resource pack with F3 + T for quick
edits.)">profileTranslation</abbr>": [0, 0.15, 0],


=== Conditions ===
You can expand the amount of animations a Pokémon can have and when they should be played by using <code>conditions</code>. Conditions are what allow for battle animations despite the <code>standing</code> and <code>battle-idle</code> poses both using the <code>"STAND"</code> pose type. Typically, if you want different animations using the same pose types, then you must set one pose's condition to true, and the other pose's matching condition to false. You can mix and match these conditions to make something like an animation that only plays in battle, if it is raining while the sun is setting. 

List of Currently Implemented Conditions:
* <code>"isBattle"</code>: The Pokémon must be in a battle.
* <code>"isTouchingWater"</code>: The Pokémon must be touching water. Not necessarily underwater.
* <code>"isTouchingWaterOrRain"</code>: The Pokémon must be touching water or rain. Again, not necessarily underwater.
* <code>"isSubmergedInWater"</code>: The Pokémon must be underwater. The red line on the hitbox must be below the surface.
* <code>"isStandingOnRedSand"</code>: The Pokémon must be standing on red sand.
* <code>"isStandingOnSand"</code>: The Pokémon must be standing on sand
* <code>"isStandingOnSandOrRedSand"</code>: The Pokémon must be standing on either sand or red sand.
* <code>"isDusk"</code>: It must be "Dusk" time in the world, or roughly at sunset.

Below is an example of 2 poses using the <code>"STAND"</code> pose type and <code>Conditions</code> to separate the battle-idle animation from the ground idle animation:
* In these scenarios, you want one pose to have the condition set to true, and any other pose that shares the same pose type to have the condition set to false.
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.bedrock('blastoise', 'battle_idle')"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.bedrock('blastoise', 'ground_idle')"
]
},


=== Transformed Parts ===
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


=== Quirks ===
Quirk animations are extra animations that you can have play over the main animation list. What makes them different from the previous animation overwrite function is that these quirks can have extra properties applied to them. You can make them loop a certain number of times and include timers for these quirks. The most common example of a quirk animation would be the blink animations. By default, a quirk animation should play once every 8-20 seconds!

Making a quirk in your poser file would largely depend on an animator making these quirky little animations to play in game. You can do more than just blinking animations. You can make a Pokémon roar, sneeze, or dance and have it play as a quirk for its standing pose or any other pose. A timer can then be applied to these quirk animations so you could end up with something like charizard doing a roar every 30-60 seconds when its idle. It's a very flexible sub system for animations that is only limited by your creativity.

Here is a list of properties that can affect quirks:
"loopTimes": Int = 1 // The number of times the animation should play for the quirk
"minSecondsBetweenOccurrences": Float = 8 // The decimal-friendly number of seconds that is the
minimum between the quirk playing once and it playing a second time
"maxSecondsBetweenOccurrences": Float = 30 // What do you think
"animations": List<Animation> = [] // The list of animations to play (together) when this quirk runs
"name": String // The name of the quirk


=== Placeholder Animations ===
the placeholder animations cobblemon uses if a pokemon is not animated based on the body type of the pokemon. AAAAAAAAAAAAAAAAAAAAAA


== Poser File Breakdown ==
The <code>poser</code> file requires an <code>animation</code> JSON to assign animations to a <code>model</code>. You're always going to want to be familiar with all the animations that were made for a model. If you assign an animation type that doesn't exist in the animation JSON then the game will crash! Also, if a bone you listed in the poser doesn't exist on the model then the game will crash! Once you figure out what animations were made for your target Pokémon model, you can simply apply the existing animations to appropriate <code>poses</code>.

Here is a breakdown of an example poser file which includes all the different properties that can be assigned. Hover over the underlined text to see more information. '''Every kind of possible poser function is included in this example at least once! So make sure that you review the whole file to see why some things are written the way they are.'''

* This example is not meant to be used as a template.
{
"portraitScale": 1.3,
"portraitTranslation": [-0.7, 2.1, 0],
"profileScale": 0.45,
"profileTranslation": [-0.1, 1.0, 0],
"animations": {
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'battle_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('blastoise', 'sleep')"]
}
}
}


== Poser File Example ==
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that some Pokémon don't use a <code>head bone</code>.

Here is an example of a poser file for a custom <code>starly</code> that includes all currently implemented poses and their appropriate animations.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 1.3,
"portraitTranslation": [-0.7, 2.1, 0],
"profileScale": 0.45,
"profileTranslation": [-0.1, 1.0, 0],
"animations": {
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'battle_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('blastoise', 'sleep')"]
}
}
}

{{Addon Creation}}

Fossils File

2024-05-10T10:22:51Z

Frank The Farmer: Added folder location and some formatting

Poser

2024-05-03T04:06:55Z

Frank The Farmer: 👷‍♂️🛑 New poser Construction has started 🚜🚧

Under construction. Dont look or else!

{{TOC|right}}
== Preface ==
The <code>poser</code> JSON controls all the animations of a Pokémon. It contains information on when the Pokémon will perform certain animations. You can set your Pokémon to only ever perform one animation if you’d like, or you can give it different animations for just about every action it performs! It can even be used to adjust certain properties of an animation so you don't have to edit the animation itself. How smoothly one animation transitions to another can also be set through the poser.

=== Poser File Breakdown ===
The <code>poser</code> file requires an <code>animation</code> JSON to assign animations to a <code>model</code>. You're always going to want to be familiar with all the animations that were made for a model. If you assign an animation type that doesn't exist in the animation JSON then the game will crash! Also, if a bone you listed in the poser doesn't exist on the model then the game will crash! Once you figure out what animations were made for your target Pokémon model, you can simply apply the existing animations to appropriate <code>poses</code>.

Sometimes there may be animations that don't seem to have a matching pose, such as <code>blink</code> animations. These can be applied using the <code>quirk</code> animation system. This system allows you to layer certain animations over an animation that is already playing in game. Making use of the quirk system can really help your Pokémon feel more alive!

Here is a breakdown of an example poser file which includes all the different properties that can be assigned. Hover over the underlined text to see more information. '''Every kind of possible poser function is included in this example at least once! So make sure that you review the whole file to see why some things are written the way they are.''' This example is not meant to be used as a template.

{
"portraitScale": 1.3,
"portraitTranslation": [-0.7, 2.1, 0],
"profileScale": 0.45,
"profileTranslation": [-0.1, 1.0, 0],
"animations": {
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'battle_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('blastoise', 'sleep')"]
}
}
}


=== Advanced Poser Functions And When to Use Them ===
Posers can do a lot more than just assign one animation to a pose. Certain things can be tweaked in the poser to make your Pokémon livelier in game. If you enjoy making many different animations for Pokémon, then this section will help you implement them in game. Using these advanced feature can help you make custom Pokémon that are on the same level of quality as the official Pokémon!

Remember that you can have an unzipped copy of your addon as a resourcepack in the game for easier editing. Since the poser file is a part of the resources of an addon, it can be refreshed in game by pressing <code>F3 + T</code>. This reloads all your resourcepacks and allows you to see the changes you've made to the poser only if the poser you are editing is in the resourcepack folder. '''It is highly recommended to use unzipped folders to test addon stuff when implementing them into the game!''' You can simply make your file edits, save the file, and then refresh your resourcepack in game to see the changes immediately!

==== Layered Animations ====
Layered animations are two or more animations that are listed together in your <code>animations</code> list. The most common example would be adding the <code>look</code> animation on top of your <code>ground_idle</code> animation for your standing pose. You're able to list more than two animations and your main limit would be running out of bones to animate.

The first animation listed should have priority control over the bones of the model. This is how Pokémon are able to look at you while walking around. The look animation has priority over the head bone, or whatever bone is listed as the head. This head bone will always attempt to look at a player if the player approaches.

Another example of layering animations would be having 2 kinds of animations that are meant to be played together and separate. A great example of this is charizard's walk animation. The walking animation itself only moves the legs for when it's walking. It combines the ground idle and the ground walk animations for its walking pose. The walk animation only controls the bottom half of the body, while the ground idle only controls the top half of the body. If you only listed its walk animation and it started walking, then the top half of charizard would t-pose whenever it walks.
Charizard's walking animation list for its walking pose:
"<abbr title="Here you will list which animations will play during these poses.">animations</abbr>": [
"<abbr title="Allows the Pokémon to move its head around to observe its surroundings. You can delete this if your Pokémon doesn't have a head bone, or you just don't want them looking around.">look</abbr>",
"<abbr title="This points to charizard's ground walk animation. Due to the way charizard's animations were made, this specified animation only animates the bottom half of charizard. If you do not include the matching ground idle after this, the arms of charizard will t-pose while it walks.">bedrock(charizard, ground_walk)</abbr>",
"<abbr title="This points to charizard's ground idle animation. Due to the way charizard's animations were made, this specified animation only animates the top half of charizard. Adding this animation will allow charizard's arms and wings to be animated while it walks.">bedrock(charizard, ground_idle)</abbr>"
]


==== Animation Overwrites ====
This function is mostly used for cases where you want an animation to be played exclusively for certain situations. You simply write <code>, true</code> after your animation type in your animations list. The most common use for this function would be writing it into your faint so the faint animation should always be playing when a Pokémon faints. Sometimes animations don't change properly and this can fix it most of the time.

Below is an example of the faint using this overwrite function. What's going to happen in game is that when charizard faints, it will always play the faint animation over other animations it was already doing. This is fine because the faint animation animates the whole model. The cry animation does not contain this function because we want the cry to play over the idle animation, but not completely overwrite everything! If it did, then charizard would t-pose whenever it tried to do it's cry animation because it only animates the head bone.

"<abbr title="This points to the faint animation for this Pokémon. If you have no faint animation, you can delete this line.">faint</abbr>": "<abbr title="This points to charizard's faint animation">bedrock(charizard, faint</abbr>, <abbr title="Adding 'true' like this will force this faint animation to play over all other animations whenever charizard faints.">true</abbr>)",
"<abbr title="This points to the cry animation for this Pokémon. Cries play whenever the Pokémon is called out of the pokeball. This occurs in and out of battle.">cry</abbr>": "<abbr title="This points to charizard's cry animation. Since it does not contain 'true' written after it, then this cry animation will not completely overwrite other animations when it plays. It should simply animate the bones it's supposed to while the rest of the bones can be controlled by another animation.">bedrock(charizard, cry)</abbr>",


==== Quirks ====
Quirk animations are extra animations that you can have play over the main animation list. What makes them different from the previous animation overwrite function is that these quirks can have extra properties applied to them. You can make them loop a certain number of times and include timers for these quirks. The most common example of a quirk animation would be the blink animations. By default, a quirk animation should play once every 8-20 seconds!

Making a quirk in your poser file would largely depend on an animator making these quirky little animations to play in game. You can do more than just blinking animations. You can make a Pokémon roar, sneeze, or dance and have it play as a quirk for its standing pose or any other pose. A timer can then be applied to these quirk animations so you could end up with something like charizard doing a roar every 30-60 seconds when its idle. It's a very flexible sub system for animations that is only limited by your creativity.

Here is a list of properties that can affect quirks:
"loopTimes": Int = 1 // The number of times the animation should play for the quirk
"minSecondsBetweenOccurrences": Float = 8 // The decimal-friendly number of seconds that is the
minimum between the quirk playing once and it playing a second time
"maxSecondsBetweenOccurrences": Float = 30 // What do you think
"animations": List<Animation> = [] // The list of animations to play (together) when this quirk runs
"name": String // The name of the quirk

Below is an example of a modified quirk animation. What this will do is eventually make charizard play the blink animation 5 times in a row. Then after the animation plays, an 8-20 second timer begins to play this quirk again. The quirk timer starts after the quirk animations end.

"<abbr title="This property allows you to play other animations over the main list of animations for this pose. The most common type of quirk animations are blinks, but you can apply any animation you wish as a quirk.">quirks</abbr>": [
{
"<abbr title="Here we are defining the name of this quirk">name</abbr>": "<abbr title="The name of this quirk will simply be called 'blink'.">blink</abbr>",
"<abbr title="The number of times the animation should play for the quirk. By default, this value is 1.">loopTimes</abbr>": <abbr title="For this example, we will let the blink animation play 5 times. After the blink plays 5 times, it will then start a timer before it can play again.">5</abbr>,
"<abbr title="The decimal-friendly number of seconds that is the minimum between the quirk playing once and it playing a second time. Default value is 8.">minSecondsBetweenOccurrences</abbr>": <abbr title="After 8 seconds, there is a chance that this quirk animation will play.">8</abbr>,
"<abbr title="The decimal-friendly number of seconds that is the maximum between the quirk playing once and it playing a second time. Default value is 30.">maxSecondsBetweenOccurrences</abbr>": <abbr title="It will take 20 seconds at most for the quirk animation to play again.">20</abbr>,
"<abbr title="Here, you are going to list the animation that you want to play as a quirk. Given the data of the previous lines, this animation will play 5 times every 8-20 seconds.">animations</abbr>": ["<abbr title="This points towards charizard's blink animation">bedrock(charizard, blink)</abbr>"]
}


==== Transformed Parts ====
This function allows you to transform parts of the model when the Pokémon is in a certain pose. You can change the location, rotation, and visibility of bones for each pose. This allows you to make some slight adjustments to an in-game animation without having to edit the animation itself. While there aren't many examples of this function, it's most common use is to hide model parts when a Pokémon is not in its battle idle. This is the case with Rillaboom and its drum.

A great use for location and rotation transformation is to adjust shoulder animations. You don't have to account for the model location on the player shoulder when making the animation. If it doesn't line up in the game, you can move the whole model using this function.

The visibility transformation allows you to hide a specific bone in the model when the Pokémon is currently in a pose. This can be used to hide certain bones if needed. This allows you to do things like making Rillaboom use its drum for its battle-idle. It also allows Typhlosion to have its flames ignited only during battle. Something to keep in mind is that if you want a bone to be visible only during battle, then you must set this bone as invisible for all other poses. This is why <code>transformedParts</code> is written under every pose in the poser file breakdown.

Below is an example of all the transformed part properties being used. This is mostly a demonstration of your options when using this function. If this example was applied in game, Charizard's wings would be detached from its body, but only the left wing would be invisible. Realistically, you would never want to do something like that.

"<abbr title="This property will allow you to manipulate the model parts without having to edit things in blockbench! You can select a bone from the model, and edit this bone specifically for this pose.">transformedParts</abbr>": [
{
"<abbr title="Here, we are selecting a bone from the model. In this case, it's charizard's right wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_right</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move 10 units on the x axis. This would be 10 units to the right if you were looking at charizard.">10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's right wing to be visible.">true</abbr>
},
{
"<abbr title="Here, we are selecting a second bone from the model. In this case, it's charizard's left wing.">part</abbr>": "<abbr title="The bone that will be manipulated. The next 3 lines can change this bone specifically for charizard's pose.">wing_left</abbr>",
"<abbr title="This property will change the bone's position. The following set of numbers can change its location on the x, y, and z axis.">position</abbr>": [<abbr title="The xyz axis values that will be applied to the bone. In this case, the bone will move -10 units on the x axis. This would be 10 units to the left if you were looking at charizard.">-10, 0, 0</abbr>],
"<abbr title="This property will change the bone's rotation. The following set of numbers can change its rotation in degrees on the x, y, and z axis. You will likely never have to rotate a bone for a pose, so these values will be left blank. This part of the example is merely to show you your options.">rotation</abbr>rotation</abbr>": [<abbr title="We don't actually want to rotate charizard's wings, so these values will be left at zero. If you don't want to use this rotation property at all, you can simply remove this one line!">0, 0, 0</abbr>],
"<abbr title="This property controls whether or not the selected bone will be visible for this pose. Note that if you want a bone to be visible just for 1 pose, then it must be set as invisible for all other poses.">isVisible</abbr>": <abbr title="Here, we are setting charizard's left wing to be invisible.">false</abbr>
}
]


==== Animation Conditions ====
This function allows you to have more control over when an animation is allowed to play. The current conditions we can use are for battle and for touching water. This can be used to make animations specific to being in battle or in water. You can also mix and match the battle and water conditions if you really want more specific animations. This can result in having a ground idle, ground battle idle, water idle, and water battle idle!

This function is mostly for helping you organize your animations for each pose. Setting a condition to true will only allow the animation to play when this condition is met. Setting it to false will prevent the animation from being played when this condition is met. This allows you to set 2 or more animations per <code>poseType</code>. This basic fundamental is what allows us to have battle animations that can only play in battle!

Transformed parts work really well with this function! Combining these 2 functions is what allows Rillaboom to use its drum only when in battle. You can allow certain model parts to appear visible only when these conditions are met. Keep these functions in mind the next time you make a custom Pokémon model. You can create livelier animations using this system!

Below is an example of these animation conditions being used. In this example, the battle idle will only play when charizard is in battle, but never while charizard is in water.


"<abbr title="Here we are defining a list of our poses.">poses</abbr>": {
"<abbr title="The name of your pose. In this case, its called 'battle-idle'. Here, we will list animations that will play when the Pokémon is in battle.">battle-idle</abbr>": {
"<abbr title="Here we are defining the name of the pose.">poseName</abbr>": "<abbr title="The name of this pose is 'battle-idle'">battle-idle</abbr>",
"<abbr title="This is transition time between animations measured in minecraft ticks. You probably won't need to mess with this.>transformTicks</abbr>": 10,
"<abbr title="Here, we are telling the game when this animation will take place.">poseTypes</abbr>": [<abbr title="One of the pose types that will use the following animation. 'STAND - when stationary on the ground.' In the next line, we will define that the following animation will only work in battle">"STAND"</abbr>],
"<abbr title="This property controls whether the animation will play during battle or not.">isBattle</abbr>": <abbr title="Setting it to true will make the following animation play only while the Pokémon is idle while it's also in battle!">true</abbr>,
"<abbr title="This property controls whether the animation will play while the Pokémon is in water or not.">isTouchingWater</abbr>": <abbr title="Setting it to false will prevent the following animation from playing whenever the Pokémon touches water, but only while it's also in battle! So if this Pokémon starts battle in water, it is not allowed to use this pose and its assigned animation.">false</abbr>,
"<abbr title="Here you will list which animations will play during these poses.">animations</abbr>": ["<abbr title="The animation you are telling it to use when your Pokémon is standing, while in battle, but not touching water.">bedrock(charizard, battle_idle)</abbr>"]
},


=== Poser File Example ===
Instead of making <code>poser</code> files from scratch each time, you can use other custom Pokémon posers as a template. Just be aware of the animations each Pokémon has. Also be aware that some Pokémon don't use a <code>head bone</code>.

Here is an example of a poser file for a custom <code>starly</code> that includes all currently implemented poses and their appropriate animations.
* Blink animations are not applied to the sleep pose. This is because you don't blink when you sleep!
{
"portraitScale": 1.3,
"portraitTranslation": [-0.7, 2.1, 0],
"profileScale": 0.45,
"profileTranslation": [-0.1, 1.0, 0],
"animations": {
"faint": "q.bedrock_primary('blastoise', 'faint', q.curve('one'))",
"cry": "q.bedrock_stateful('blastoise', 'cry')",
"recoil": "q.bedrock_stateful('blastoise', 'recoil')",
"physical": "q.bedrock_primary('blastoise', 'physical', q.curve('symmetrical_wide'))",
"special": "q.bedrock_primary('blastoise', 'special', q.curve('symmetrical_wide'))",
"status": "q.bedrock_primary('blastoise', 'status', q.curve('symmetrical_wide'))"
},
"poses": {
"battle-standing": {
"poseTypes": ["STAND"],
"isBattle": true,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'battle_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', q.array('quirk_battle_idle', 'quirk_battle_idle2'), 30, 60, 1)"
]
},
"standing": {
"poseTypes": ["STAND", "NONE", "PORTRAIT", "PROFILE"],
"isBattle": false,
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_idle')"
],
"quirks": [
"q.bedrock_quirk('blastoise', 'blink')",
"q.bedrock_quirk('blastoise', 'quirk_ground_idle', 20, 60, 1)"
]
},
"walking": {
"poseTypes": ["WALK"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'ground_walk')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"float": {
"poseTypes": ["FLOAT"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_idle')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"swim": {
"poseTypes": ["SWIM"],
"animations": [
"q.look('head_ai')",
"q.bedrock('blastoise', 'water_swim')"
],
"quirks": ["q.bedrock_quirk('blastoise', 'blink')"]
},
"sleep": {
"poseTypes": ["SLEEP"],
"animations": ["q.bedrock('blastoise', 'sleep')"]
}
}
}

{{Addon Creation}}

Template:Addon Creation

2024-04-28T01:15:46Z

Frank The Farmer:

{{NavigationBox
|title=Addon Creation
|rows=
{{NavigationRow|category=Tutorials|content=
[[Tutorials/Creating A Custom Pokemon|Creating A Custom Pokemon]] [[Tutorials/Creating A Model|Creating A Model]] [[Tutorials/Creating Custom Spawns|Creating Custom Spawns]] [[Tutorials/Emissive Textures|Emissive Textures]] [[Tutorials/Animated Textures|Animated Textures]] [[Tutorials/Texture replacement|Texture Replacement]] [[Tutorials/Animation Replacement|Animation Replacement]] [[Tutorials/Regional_Forms| Regional Forms]][[Tutorials/Multiple Visual Variants|Multiple Visual Variants]] [[Tutorials/Adding_Sounds_To_Animations|Adding Sounds To Animations]]
}}
{{NavigationRow|category=Asset Files|content=
[[Resolver]] [[Poser]] [[Sounds]]
}}
{{NavigationRow|category=Data Files|content=
[[Species]] [[Species Features]] [[Species Feature Assignments]] [[Species Additions]] [[Spawn Detail Presets]] [[Spawn Pool World]] [[Fossils_File|Fossils]]
}}
{{NavigationRow|category=Properties|content=
[[Pokémon/Behaviour|Behaviour]] [[Spawn Condition]] [[Advancements]]
}}
}}
[[Category:Addon Creation]]

Tutorials/Regional Forms

2024-04-22T22:50:19Z

Frank The Farmer: Didnt specify something so specifying that now lol

{{TOC|right}}
== Preface ==
This tutorial will teach you how to create a regional form for '''''an existing Pokémon.''''' Regional forms are a species variant that can have different looks, types, abilities, moves, and spawn locations! '''Knowledge of [[Tutorials/Creating_A_Custom_Pokemon|creating custom Pokémon]] is ''required.''''' Creating a unique model and textures for your form is highly recommended, but not always necessary.

Due to regional forms usually requiring files for both data and assets, this type of pack will just be called an <code>addon</code> for simplicity. Addons that use data and asset folders will end up needing to have a copy in both the <code>datapacks</code> and <code>resourcepacks</code> game folders. The data and assets can be separated if desired, but are usually bundled together to make sharing easier!

=== Step 1: Arrange the folders for this addon ===
Due to some files sharing the same names later in this guide, you will be creating the folder structure and <code>pack.mcmeta</code> now. This is to prevent confusion going forward.

# Create a new text file and name it <code>pack.mcmeta</code>
#* Ensure that it doesn't end in other file extensions like .txt
# Open the file and insert the following data:
#* Hover over the underlined text to see more information.
{
"<abbr title="This lets Minecraft know that it is a datapack">pack</abbr>": {
"<abbr title="Here you will list the pack format number for a specific version of Minecraft">pack_format</abbr>": <abbr title="As of 1.20.1, the current resourcepack format number is 15. But it will still load if this number isn't correct!">15</abbr>,
"<abbr title="Here you will write a short description of your datapack">description</abbr>": "<abbr title="Your short datapack description">Example description</abbr>"
}
}
# <li value=3> Save the file and put it aside for now.
# Create a series of folders arranged like the following example:
==== Folder Structure ====
<div class="treeview">
*''(addon name)''
** '''pack.mcmeta'''
**assets
***cobblemon
****bedrock
*****pokemon
******animations
*******<target pokemon folder>
******models
*******<target pokemon folder>
******posers
******resolvers
*******<target pokemon folder>
****textures
*****pokemon
******<target pokemon folder>
**data
***cobblemon
****spawn_pool_world
****species_additions
****species_features
</div>
# <li value="5">Place the <code>pack.mcmeta</code> file into the first folder of your addon next to <code>assets</code> and <code>data</code>
After this folder tree for your addon is made, you can simply drop the files into the associated folders as you create them.
Remember that the <code>pack.mcmeta</code> is a file, not a folder to add. It must be one folder deep in order for Minecraft to recognize this pack as a resource pack or data pack when in the appropriate game folders.

=== Step 2: Create the assets for your regional variant ===
How you want your regional variant to look depends entirely on you. You can make it use a new texture over the original model. Most of the time, a new model, texture, and animations are created for this regional form. If for some reason you don't want it to have a visual difference at all, then you can skip anything regarding <code>assets</code>. Make sure your assets have a unique name so they don't overwrite any original form assets.

Assets for existing Pokémon can be obtained from the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/assets/cobblemon/bedrock/pokemon/models Gitlab] or the mod's JAR file. This can be helpful if you wanted to make a texture variant, or use the model as a base for the regional form. Just remember that animation files are made for specific models so they may need updating depending on what you make. These assets can be made in Blockbench or any relevant art apps.

# Create the regional form's <code>model</code>
# Create the regional form's <code>texture</code>
# Create the regional form's <code>animations</code>
# Export these files and place them into the appropriate folders in your addon pack
# Create a <code>[[poser]]</code> file for this regional form if new animations were created for the new model. (optional)

As knowledge of creating custom Pokémon is a requirement for this guide, you are expected to know how to make these files. Help can be found on the Cobblemon discord.

=== Step 3: Create a "species feature" ===
On the data side of things, the creation of a regional form starts with the [[Species_Features|species feature]]. A species feature is what allows a Pokémon to have a different set of stats and visuals applied to their regional forms. You will be creating a short JSON file that will be named after your custom region or idea. '''The feature can be named whatever you want it to be called.'''

# Create a new text file and name it after your region or idea. Include the extension of<code>.json</code>
#* Example: The alolan species feature is named <code>alolan.json</code>
#* Remember to use lowercase and make sure that the file does not end in any other extension like ".txt"
# Insert the following data into this new species feature JSON:
#* '''Remember to change <code>"custom_feature"</code> to match your file name! It must stay in quotes.'''
<syntaxhighlight>
{
"keys": ["custom_feature"],
"type": "flag",
"isAspect": true,
"default": false
}
</syntaxhighlight>
# <li value="3"> Save the file
# Place this new species feature file into the <code>species_feature</code> folder of your addon

<code>"isAspect": true</code> means that this new feature is both a <code>feature</code> and <code>aspect</code>!
Now that the species feature is made, you can apply it to a Pokémon's <code>form</code>

=== Step 4: Create a "species addition" file with "form" data ===
A <code>[[Species_Additions|species_addition]]</code> file is an efficient way of ''adding'' data to existing species files without having to rewrite the main species file. This allows your additions to be more compatible with other addons affecting the same Pokémon. You will be adding your regional <code>form</code> data to a species through this method.

# Create a new text file and name it after your Pokémon. Include the extension of <code>.json</code>
#* Example: <code>bulbasaur.json</code>
# Insert the following data into this new species_addition JSON:
<syntaxhighlight>
{
"target": "cobblemon:example",
"features": ["custom_feature"],
"forms": [
{
example form data
}
]
}
</syntaxhighlight>
# <li value="3"> Change <code>"cobblemon:example"</code> to reference the Pokémon you want to add a form to. It must remain in quotes.
#* Example: <code>"cobblemon:bulbasaur"</code>
# Change <code>"custom_feature"</code> to the feature you made earlier. It must remain in quotes.
# Write all the data for your form inside of the curly brackets
#* The average form data set is too long to list as an example for this guide. It's like writing data for an entirely different Pokémon, which is kind of what a regional variant is like.
#* If you need an example, you can look at the <code>"forms"</code> data for [https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/resources/data/cobblemon/species/generation1/vulpix.json Vulpix on the Gitlab.] It starts on line 29 and ends on line 204.
#* Remember to include evolution data if this regional variant can evolve.
# Write your species feature name into the <code>"aspects"</code> section of your <code>"forms"</code> data.
#* Include the line for aspects if it doesn't exist yet. It should look like this:
<syntaxhighlight>
"aspects": ["custom_feature"]
</syntaxhighlight>
# <li value="7"> Save the file.
# Place this new species addition file into the <code>species_additions</code> folder of your addon.

Now your target Pokémon's new form should have the data that allows it to function differently in battles. Next you will create the data that allows it to spawn differently.

=== Step 5: Create the spawns for your regional form ===
The <code>[[Spawn_Pool_World|spawn_pool_world]]</code> folder holds all the spawning files for each Pokémon. You will be creating a new file for your regional variant. It can be as simple or complicated as you make it. It is recommended that you use the normal form's spawn file as a base for your regional form. Those spawn files can be found on the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/data/cobblemon/spawn_pool_world Gitlab.]

To keep things simple, this part of the guide will show you how to recycle a spawn file by changing the Pokémon name and biome conditions.
# Obtain your target Pokémon's <code>spawn_pool_world</code> JSON.
# Rename the file to anything you want. The name must be different than the original.
#* Example: <code>regional_bulbasaur</code>
# Open the file and locate all the strings for <code>"id"</code> and <code>"pokemon"</code>
# Edit the Pokémon's name '''and include''' the name of your species feature after like this example:
#* You must use a space after the Pokémon name for the <code>"pokemon"</code> string.
<syntaxhighlight>
"id": "bulbasaur-alolan-1",
"pokemon": "bulbasaur alolan",
</syntaxhighlight>
# <li value="5">Locate all the strings for <code>"biomes"</code> if they exist
# Change the listed biome(s) to something different!
#* This will allow the regional variant to spawn in biomes the normal variant does not.
#* The list of biome tags can be found [https://docs.google.com/document/d/1iB0EJSc2r6mRJXIo1n3XpHbZ5udwJVnrh2pXdhTyH8c/edit here.]
# Save the file
# Place this new spawn file in the <code>spawn_pool_world</code> folder of your addon

This should be the last of the data folder files. By now, your regional variant can stand on its own data-wise. It should have different stats, and spawns. Now it just needs a different look.

=== Step 6: Create the resolver file for your regional form ===
Back in step 2, you should have already made the files for <code>models</code>, <code>textures</code>, <code>animations</code>, and <code>posers</code>. The last thing you need to do is assign them to your regional variant by creating a new <code>[[resolver]]</code> file.

# Obtain your target Pokémon's <code>resolver</code> JSON.
# Change the name of this resolver to <code>1_<pokemon>_base</code>
#* You change the number from 0 to 1 so it can load after the normal variant's data
#* Sometimes a number greater than 1 is needed, especially if your target Pokémon has gender variants.
# Open the resolver file and locate the string for <code>"order"</code>.
# Change the value of "order" from 0 to 1.
#* Again, sometimes this value needs to be greater than 1.
# Add the name of your species feature to the <code>"aspects"</code> string
#* Example: <code>"aspects": ["alolan"]</code>
#* This allows any Pokémon that spawned with this feature/aspect to use any following model, textures, or poser.
# Assign any <code>poser</code>, <code>model</code>, or <code>textures</code> that you made in Step 2.
# Save the file
# Place this new resolver in the <code>resolvers</code> folder of your addon

=== Step 7: Test your addon in game ===
Load your addon in game to see if your regional form looks different from the normal one. You can have Blockbench open to edit any relevant asset file '''in the resourcepacks folder''' if needed.
# Copy your addon folder and place it in the "resourcepacks" and "datapacks" folder in the Minecraft root directory.
# Start up Minecraft and click on ''Options'', then ''Resource Packs''. Select your pack to load it.
# Load/create a '''Creative''' world save that contains your addon in the "datapack" folder.
# Once in the world, you can run the command <code>/pokespawn <target pokemon> <species feature></code>.
# Ensure your new regional form is working properly.
# Check if your regional form spawns where you assigned it to. You can use <code>/checkspawn <rarity></code> when in the assigned biome.
#* You can run the command <code>/locate biome <assigned biome></code> to get coordinates to the assigned biome. You can then click on the coordinates it gave you and be teleported instantly.
# Make any desired edits to the asset files and save. Refresh resource packs with F3+T to see the changes you make.
# Make any desired edits to the data files and save. '''You need to quit to main menu, and load the world again if you want to see those changes.'''
#* The command for <code>/reload</code> does not work with Cobblemon addons unfortunately.

You should now have a functional regional variant!

[[Category:Tutorial]]

Template:Addon Creation

2024-04-12T02:50:17Z

Frank The Farmer: Regonals

{{NavigationBox
|title=Addon Creation
|rows=
{{NavigationRow|category=Tutorials|content=
[[Tutorials/Creating A Custom Pokemon|Creating A Custom Pokemon]] [[Tutorials/Creating A Model|Creating A Model]] [[Tutorials/Creating Custom Spawns|Creating Custom Spawns]] [[Tutorials/Emissive Textures|Emissive Textures]] [[Tutorials/Animated Textures|Animated Textures]] [[Tutorials/Texture replacement|Texture Replacement]] [[Tutorials/Animation Replacement|Animation Replacement]] [[Tutorials/Regional_Forms| Regional Forms]][[Tutorials/Multiple Visual Variants|Multiple Visual Variants]] [[Tutorials/Adding_Sounds_To_Animations|Adding Sounds To Animations]]
}}
{{NavigationRow|category=Asset Files|content=
[[Resolver]] [[Poser]] [[Sounds]]
}}
{{NavigationRow|category=Data Files|content=
[[Species]] [[Species Features]] [[Species Feature Assignments]] [[Species Additions]] [[Spawn Detail Presets]] [[Spawn Pool World]] [[Fossils_File|Fossils]]
}}
{{NavigationRow|category=Properties|content=
[[Pokémon/Behaviour|Behaviour]] [[Spawn Condition]]
}}
}}
[[Category:Addon Creation]]

Pokémon/Behaviour

2024-03-21T00:46:07Z

Frank The Farmer: Nobody noticed 😏

A Pokémon's AI behaviour is configurable from their species JSON. This is used control whether it can walk, swim, or fly as well as the speed it moves while doing each of those, whether or not it can fall asleep, and various other things.

'''If you don't include any of the following behavior properties in your species JSON, the Pokémon will use default AI behavior. The default is a land-moving AI that moves at a brisk pace, cannot breathe underwater, and does not sleep.'''

===PokemonBehaviour===
{| class="wikitable"
|-
! Option
! style="text-align:left;" | Details
|-
| style="vertical-align:top;" | moving
| A set of properties relating to the movement of a Pokémon.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| style="vertical-align:top;" | walk
| A set of properties that control the land walking of a Pokémon.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| canWalk
| A <code>true/false</code> value. If <code>false</code>, the Pokémon cannot move over land.
|-
| avoidsLand
| A <code>true/false</code> value. If <code>true</code>, the Pokémon should avoid land.
|-
| walkSpeed
| The base speed of the Pokémon when moving over land, defaulting to <code>0.35</code>.
|}
|-
| style="vertical-align:top;" | swim
| A set of properties that control the swimming (through water or lava) of a Pokémon.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| avoidsWater
| A <code>true/false</code> value. If <code>true</code>, the Pokémon should avoid water.
|-
| canSwimInWater
| A <code>true/false</code> value. If <code>true</code>, the Pokémon can swim in water.
|-
| canBreatheUnderwater
| A <code>true/false</code> value. If <code>false</code>, the Pokémon will drown if it stays submerged in water for too long.
|-
| canWalkOnWater
| A <code>true/false</code> value. If <code>true</code>, the Pokémon will move across the top of water as if it's walking on it.
|-
| canSwimInLava
| A <code>true/false</code> value. If <code>true</code>, the Pokémon can swim in lava.
|-
| canBreatheUnderlava
| A <code>true/false</code> value. If <code>false</code>, the Pokémon will drown if it stays submerged in lava for too long.
|-
| canWalkOnLava
| A <code>true/false</code> value. If <code>true</code>, the Pokémon will move across the top of lava as if it's walking on it.
|-
| hurtByLava
| A <code>true/false</code> value. If <code>false</code>, the Pokémon will not take damage in lava.
|-
| swimSpeed
| The base speed of the Pokémon when moving through fluids, defaulting to <code>0.3</code>.
|}
|-
| style="vertical-align:top;" | fly
| A set of properties that control the flight through the air of a Pokémon.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| canFly
| A <code>true/false</code> value. If <code>true</code>, the Pokémon is capable of flying through the air.
|-
| flySpeedHorizontal
| The horizontal speed of the Pokémon when flying, defaulting to <code>0.3</code>.
|}
|-
| canLook
| A <code>true/false</code> value. If <code>false</code>, the Pokémon will not even turn to look at nearby entities.
|-
| looksAtEntities
| A <code>true/false</code> value. If <code>false</code>, the Pokémon will not even turn to look at nearby entities despite <code>canLook</code> being set to true. The default value is <code>true</code>.
|-
| stepHeight
| The height, measured in blocks, a Pokémon can step over before they consider jumping instead. The default value is <code>0.6</code>. This default height allows them to step over beds. Due to unfinished pathfinding ai, Pokémon cant properly use this property.
|-
| wanderChance
| The number of ticks it takes before the Pokémon has a chance at wandering. The default value is <code>120</code>.
|-
| wanderSpeed
| Multiplies the Pokémon's speed by this value when the Pokémon is using the wander behavior. The default value is <code>1</code>. This property also seems to change the pathfinding behavior if the Pokémon is moving very fast.
|}
|-
| style="vertical-align:top;" | resting
| A set of properties relating to how and when the Pokémon sleeps, if it sleeps at all.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| canSleep
| A <code>true/false</code> value. If it's <code>true</code>, then it can fall asleep if it is a wild Pokémon. Many other options exist as filters for when a Pokémon can fall asleep in nature and all require this option to be set to true.
|-
| times
| A time range for when it can sleep, which can be abbreviations or tick ranges and can be combined with commas. Examples: <code>"day"</code>, <code>"night"</code>, <code>"dawn,dusk"</code>, <code>"1200-2400,morning"</code>. This is the same format as the time range controls in Spawner Conditions. The default value is set to <code>"night"</code> if no other value is specified.
|-
| sleepChance
| The chance (per tick) of a Pokémon falling asleep. By default it is <code>0.0017</code> which roughly equates to it taking an average of 30 seconds to fall asleep.
|-
| blocks
| A list of block conditions, one of which must be met for the Pokémon to be able to sleep on the block. Block conditions can be either the name of the block or a tag that the block must be in.
|-
| biomes
| A list of biome conditions, one of which must be met for the Pokémon to be able to sleep in the biome. Biome conditions can be either the name of the biome or a tag that the biome must be in.
|-
| light
| A light level or level range, between <code>0</code> and <code>15</code>, which represents the light levels in which the Pokémon is able to sleep. If you set this option to <code>"15"</code>, then the Pokémon can only fall asleep in maximum light. If you set this option to <code>"0-7"</code>, then it can only fall asleep when it's fairly dark. [[minecraftwiki:Light#Light_level|These light levels can be found on the Minecraft Wiki]].
|-
| depth
| The depth of the sleep. This is a classification on what things can interrupt the sleep and make the Pokémon wake up. If you set it to <code>"normal"</code> then it will wake up when a non-sneaking player is within 16 blocks of the Pokémon. Another option is <code>"comatose"</code>, and this causes the Pokémon to sleep through pretty much anything. You can add new sleep depths using the SleepDepth API.
|-
| willSleepOnBed
| A <code>true/false</code> value. If <code>true</code>, the Pokémon will try to sleep on top of the player's bed when they hop into it, much like cats.
|}
|}

==Examples==
Examples from existing species JSONs:

'''Charmander''' - A classic land walker using many default behavior values which don't need to be specified in code.
"behaviour": {
"resting": {
"canSleep": true,
"willSleepOnBed": true,
"depth": "normal",
"light": "0-2"
}
},

'''Charizard''' - A land walker that can also fly
"behaviour": {
"resting": {
"canSleep": true,
"depth": "normal",
"light": "0-4"
},
"moving": {
"fly": {
"canFly": true,
"flySpeedHorizontal": 0.6
}
}
},

'''Bidoof''' - A semi-aquatic egg laying land dweller. Chooses to 'walk' on water in combination with animations to appear like it prefers to float on the surface of water and walk on land.
"behaviour": {
"moving": {
"walk": {
"walkSpeed": 0.28
},
"swim": {
"swimSpeed": 0.17,
"canSwimInWater": true,
"canBreatheUnderwater": true,
"canWalkOnWater": true
}
},
"resting": {
"canSleep": true,
"willSleepOnBed": true,
"depth": "normal",
"light": "0-4"
}
},

'''Magikarp''' - A basic fish-like aquatic pokemon
"behaviour": {
"moving": {
"canLook": false,
"walk": {
"avoidsLand": true
},
"swim": {
"swimSpeed": 0.1,
"canSwimInWater": true,
"canBreatheUnderwater": true
}
}
},

'''Shellder'''- An aquatic Pokémon prefers to walk on surfaces. Can walk on both land or underwater
"behaviour": {
"moving": {
"swim": {
"swimSpeed": 0.1,
"canSwimInWater": false,
"canBreatheUnderwater": true
}
}
},

{{Addon Creation}}

Pokémon/Behaviour

2024-03-19T09:53:20Z

Frank The Farmer: Added some missing behavior properties

A Pokémon's AI behaviour is configurable from their species JSON. This is used control whether it can walk, swim, or fly as well as the speed it moves while doing each of those, whether or not it can fall asleep, and various other things.

'''If you don't include any of the following behavior properties in your species JSON, the Pokémon will use default AI behavior. The default is a land-moving AI that moves at a brisk pace, cannot breathe underwater, and does not sleep.'''

===PokemonBehaviour===
{| class="wikitable"
|-
! Option
! style="text-align:left;" | Details
|-
| style="vertical-align:top;" | moving
| A set of properties relating to the movement of a Pokémon.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| style="vertical-align:top;" | walk
| A set of properties that control the land walking of a Pokémon.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| canWalk
| A <code>true/false</code> value. If <code>false</code>, the Pokémon cannot move over land.
|-
| avoidsLand
| A <code>true/false</code> value. If <code>true</code>, the Pokémon should avoid land.
|-
| walkSpeed
| The base speed of the Pokémon when moving over land, defaulting to <code>0.35</code>.
|}
|-
| style="vertical-align:top;" | swim
| A set of properties that control the swimming (through water or lava) of a Pokémon.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| avoidsWater
| A <code>true/false</code> value. If <code>true</code>, the Pokémon should avoid water.
|-
| canSwimInWater
| A <code>true/false</code> value. If <code>true</code>, the Pokémon can swim in water.
|-
| canBreatheUnderwater
| A <code>true/false</code> value. If <code>false</code>, the Pokémon will drown if it stays submerged in water for too long.
|-
| canWalkOnWater
| A <code>true/false</code> value. If <code>true</code>, the Pokémon will move across the top of water as if it's walking on it.
|-
| canSwimInLava
| A <code>true/false</code> value. If <code>true</code>, the Pokémon can swim in lava.
|-
| canBreatheUnderlava
| A <code>true/false</code> value. If <code>false</code>, the Pokémon will drown if it stays submerged in lava for too long.
|-
| canWalkOnLava
| A <code>true/false</code> value. If <code>true</code>, the Pokémon will move across the top of lava as if it's walking on it.
|-
| hurtByLava
| A <code>true/false</code> value. If <code>false</code>, the Pokémon will not take damage in lava.
|-
| swimSpeed
| The base speed of the Pokémon when moving through fluids, defaulting to <code>0.3</code>.
|}
|-
| style="vertical-align:top;" | fly
| A set of properties that control the flight through the air of a Pokémon.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| canFly
| A <code>true/false</code> value. If <code>true</code>, the Pokémon is capable of flying through the air.
|-
| flySpeedHorizontal
| The horizontal speed of the Pokémon when flying, defaulting to <code>0.3</code>.
|}
|-
| canLook
| A <code>true/false</code> value. If <code>false</code>, the Pokémon will not even turn to look at nearby entities.
|-
| looksAtEntities
| I sure hope nobody reads this while I figure it out. The default value is <code>true</code>
|-
| stepHeight
| I sure hope nobody reads this while I figure it out. The default value is <code>0.6</code>
|-
| wanderChance
| The number of ticks it takes before the Pokémon has a chance at wandering. The default value is <code>120</code>
|-
| wanderSpeed
| I sure hope nobody reads this while I figure it out. The default value is <code>1</code>
|}
|-
| style="vertical-align:top;" | resting
| A set of properties relating to how and when the Pokémon sleeps, if it sleeps at all.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| canSleep
| A <code>true/false</code> value. If it's <code>true</code>, then it can fall asleep if it is a wild Pokémon. Many other options exist as filters for when a Pokémon can fall asleep in nature and all require this option to be set to true.
|-
| times
| A time range for when it can sleep, which can be abbreviations or tick ranges and can be combined with commas. Examples: <code>"day"</code>, <code>"night"</code>, <code>"dawn,dusk"</code>, <code>"1200-2400,morning"</code>. This is the same format as the time range controls in Spawner Conditions. The default value is set to <code>"night"</code> if no other value is specified.
|-
| sleepChance
| The chance (per tick) of a Pokémon falling asleep. By default it is <code>0.0017</code> which roughly equates to it taking an average of 30 seconds to fall asleep.
|-
| blocks
| A list of block conditions, one of which must be met for the Pokémon to be able to sleep on the block. Block conditions can be either the name of the block or a tag that the block must be in.
|-
| biomes
| A list of biome conditions, one of which must be met for the Pokémon to be able to sleep in the biome. Biome conditions can be either the name of the biome or a tag that the biome must be in.
|-
| light
| A light level or level range, between <code>0</code> and <code>15</code>, which represents the light levels in which the Pokémon is able to sleep. If you set this option to <code>"15"</code>, then the Pokémon can only fall asleep in maximum light. If you set this option to <code>"0-7"</code>, then it can only fall asleep when it's fairly dark. [[minecraftwiki:Light#Light_level|These light levels can be found on the Minecraft Wiki]].
|-
| depth
| The depth of the sleep. This is a classification on what things can interrupt the sleep and make the Pokémon wake up. If you set it to <code>"normal"</code> then it will wake up when a non-sneaking player is within 16 blocks of the Pokémon. Another option is <code>"comatose"</code>, and this causes the Pokémon to sleep through pretty much anything. You can add new sleep depths using the SleepDepth API.
|-
| willSleepOnBed
| A <code>true/false</code> value. If <code>true</code>, the Pokémon will try to sleep on top of the player's bed when they hop into it, much like cats.
|}
|}

==Examples==
Examples from existing species JSONs:

'''Charmander'''
"behaviour": {
"resting": {
"canSleep": true,
"willSleepOnBed": true,
"depth": "normal",
"light": "0-2"
}
},

'''Charizard'''
"behaviour": {
"moving": {
"fly": {
"canFly": true,
"flySpeedHorizontal": 0.6
}
}
},

'''Lapras'''
"behaviour": {
"moving": {
"swim": {
"canWalkOnWater": true,
"canSwim": true,
"canBreatheUnderwater": true
}
}
},

{{Addon Creation}}

Main Page

2024-03-16T05:07:06Z

Frank The Farmer: Adding on a button i just creationed

<div style="text-align:center">
[[file:cobblemon_wiki.png|800px]]

=The Official Cobblemon Wiki=
{{Tile|[[Pokémon]]}}
{{Tile|[[Commands]]}}
{{Tile|[[:Category:Item|Items]]}}
{{Tile|[[:Category:Block|Blocks]]}}
{{Tile|[[:Category:Addon_Creation|Addon Creation]]}}
</div>

Category:Addon Creation

2024-03-16T01:36:42Z

Frank The Farmer: we ball

Template:Addon Creation

2024-03-08T07:04:25Z

Frank The Farmer: Sounds like there's a new tutorial added to the table

{{NavigationBox
|title=Addon Creation
|rows=
{{NavigationRow|category=Tutorials|content=
[[Tutorials/Creating A Custom Pokemon|Creating A Custom Pokemon]] [[Tutorials/Creating A Model|Creating A Model]] [[Tutorials/Creating Custom Spawns|Creating Custom Spawns]] [[Tutorials/Emissive Textures|Emissive Textures]] [[Tutorials/Animated Textures|Animated Textures]] [[Tutorials/Texture replacement|Texture Replacement]] [[Tutorials/Animation Replacement|Animation Replacement]] [[Tutorials/Multiple Visual Variants|Multiple Visual Variants]] [[Tutorials/Adding_Sounds_To_Animations|Adding Sounds To Animations]]
}}
{{NavigationRow|category=Asset Files|content=
[[Resolver]] [[Poser]] [[Sounds]]
}}
{{NavigationRow|category=Data Files|content=
[[Species]] [[Species Features]] [[Species Feature Assignments]] [[Species Additions]] [[Spawn Detail Presets]] [[Spawn Pool World]] [[Fossils_File|Fossils]]
}}
{{NavigationRow|category=Properties|content=
[[Pokémon/Behaviour|Behaviour]] [[Spawn Condition]]
}}
}}
[[Category:Addon Creation]]

Tutorials/Adding Sounds To Animations

2024-03-08T07:00:44Z

Frank The Farmer: Sounds like there's a new animation tutorial

{{TOC|right}}
== Preface ==
This is an advanced tutorial that will show you how to add sounds to your custom Pokémon's animations. It is required that you are familiar with the process of [[Tutorials/Creating_A_Custom_Pokemon|creating a custom Pokémon]]. You will need a finished model, an animation to apply the sounds to, and a sound file to apply to the animation. While the steps in this guide can be used to add any sound to any animation, it will primarily focus on adding a cry to your Pokémon.

'''Acquiring a valid <code>ogg</code> sound file to use is entirely on you. You will either have to make or find one.'''

== Recommended Tools ==
This section will list some free tools and resources that can help you format your files and folders.
* '''A Text Editor''' - If you are not using one already, they can be helpful for editing multiple files at once
** Recommendations:
*** Visual Studio Code - You can open your entire addon folder and access all content within. Can also play sound files. Helps you visualize the folder structure of your addon.
* '''Audio Editing Software''' - Minecraft only plays <code>ogg</code> sound files. You'll need something to convert audio files into this format.
** Recommendations:
*** Audacity - Free software with many video tutorials on YouTube. Allows you to edit the sound file and export it to <code>ogg</code> format.
* '''Blockbench''' - You will need it to load, edit, and export your animations.
* '''[https://minecraft.wiki/w/Sounds.json The sounds.json Wiki Page]''' - Lists some helpful properties you can use when creating the sounds JSON.

== Step 1: Arrange The Folders Of Your Addon ==
Adding sounds would require you to add a <code>[[Sounds|sounds.json]]</code> and one new branch of sound folders to your existing addon. For the sake of clarity, a complete addon with sounds would be arranged like so:
=== Folder Structure ===
<div class="treeview">
*''(addon name)''
** '''pack.mcmeta'''
**assets
***cobblemon
****bedrock
*****pokemon
******animations
*******<folder named after your pokemon>
********'''<pokemon>.animation.json'''
******models
*******<folder named after your pokemon>
********'''<pokemon>.geo.json'''
******posers
*******'''<pokemon>.json'''
******resolvers
*******<folder named after your pokemon>
********'''0_<pokemon>_base.json'''
****lang
*****'''en_us.json'''
****'''sounds.json'''
****sounds
*****pokemon
******<folder named after your pokemon>
*******'''<sound>.ogg'''
****textures
*****pokemon
******<folder named after your pokemon>
*******'''<pokemon>.png'''
*******'''<pokemon>_shiny.png'''
**data
***cobblemon
****spawn_pool_world
*****'''<pokemon>.json'''
****species
*****custom
******'''<pokemon>.json'''
</div>

Arrange your asset folder similarly to the tree above so you can simply insert any new files with ease.

== Step 2: Adding The Sound Keyframe ==
To get started, you will need one or more valid <code>ogg</code> sound files to use for your animations. Create one if you haven't already. You will be loading and editing your asset files in Blockbench for this step.

# Prepare your sound file(s)
# Open up Blockbench and load your model, texture, and animation files.
# Navigate to the animate tab and select the animation you want to add sounds to
#* If you don't have one, you can make one now. Making a simple cry animation where the Pokémon opens its mouth or some similar motion is recommended.
# Once your animation is selected, navigate to the <code>TIMELINE</code> window and click on the <code>Animate Effects</code> button.
# Click on the <code>+</code> button for <code>sound</code> to generate a new sound keyframe
#* The <code>KEYFRAME</code> window should have opened up once the keyframe was made
# Navigate to the <code>KEYFRAME</code> window and create an effect name for this keyframe
#* This would create a <code>sound event</code> which Minecraft can use to play a sound when this animation is played.
#* In the case of making cries, this effect should be named <code>pokemon.<pokemon>.cry</code>
#** Example: <code>pokemon.charizard.cry</code>
[[File:BlockbenchStuff.png|thumb|center|1037px|caption|You should end up with something similar to Charizard's cry animation.]]
# <li value="7"> Click on the <code>Select Keyframe File</code> located to the right of your <code>effect</code> name.
# Select and upload one of your prepared sound files
#* This will let the sound play in Blockbench whenever the sound keyframe is played in the animation.
# Adjust and edit the animation to your liking.
#* Now you can hear and see your animation. Should be easier to make adjustments.
# Once satisfied with your animation, save and export your animations to your addon.
#* Be sure to replace the old animation json in the folder. This new export has the data required to play the sound.
#* If you made any changes to the model or texture, be sure to export those again too.
#* If you just made a cry animation now, remember to add that animation to your Pokémon's <code>[[poser]]</code> file.
#* At most, you should have exported your animations, model, and texture. Don't worry about the sound file yet. Those will be arranged next.

== Step 3: Arrange Your Sounds ==
Your sound files should be kept in the same format as Cobblemon's sound files. This should make it easier to mimic the <code>sounds.json</code> in the next step.

# Insert your <code>ogg</code> sound file into the folder named after your pokemon located deeper in the sounds folder.
# Rename this file to match the cry sound format of <code><pokemon>_cry.ogg</code>
#* Example: <code>charizard_cry.ogg</code>
#* Can actually be named whatever you want. Just make sure you reference it correctly in Step 4.

If done correctly, your sound file should have a file address similar to this:
<code><your addon name> > assets > cobblemon > sounds > pokemon > <your pokemon></code>

You should end up with one or more <code><pokemon>_cry.ogg</code> files in your Pokémon's sound folder. Depends on what you're making.

== Step 4: Create The sounds.json ==
The next step is to create a sounds JSON to play your sounds in Minecraft. The <code>[[Sounds|sounds.json]]</code> is responsible for assigning sound files to any sound events. This file is not exclusive to Cobblemon. You can learn more about it from the [https://minecraft.wiki/w/Sounds.json Minecraft Wiki].

'''The name of your <code>sound event</code> just needs to match the name of the <code>effect</code> you made in the previous section. It does not need to be a cry.'''

# Create a new text file and name it <code>sounds.json</code>
#* Make sure this new file name ends in .json and not any other file extension like .txt.
# Open this new JSON in your preferred text editor
# Copy and paste this entire code block example into the JSON
#* If you have more than one cry file, you can list more file addresses. They would have equal chances to be played by default.
{
"pokemon.charizard.cry": {
"sounds": ["cobblemon:pokemon/charizard/charizard_cry"]
}
}
# <li value=4> Change all instances of "charizard" to be your Pokémon's name instead.
# If desired, add any special properties you want like subtitles.
# Save the file
# Insert this finished <code>sounds.json</code> into the <code>cobblemon</code> folder of your addon.
#* It must be in this folder and nowhere else. Otherwise, it wont be read.
#* Should be seated next to your sounds folder.
== Step 5: Test Your Addon In Game ==
The final step is to make sure the sounds work.

# Copy your addon folder and place it in the "resourcepacks" and appropriate "datapacks" folder in the Minecraft root directory.
# Start up Minecraft and click on ''Options'', then ''Resource Packs''. Select your pack to load it.
#* Make sure you are using a version of your addon that includes all the new files and re-exports you just made.
# Load/create a '''Creative''' world save that contains your addon in the "datapacks" folder.
# Once in the world, you can run the command <code>/pokegive <target pokemon></code>.
#* Since cries are only played when a Pokémon is brought out of the pokeball or sent into battle, you need to have the Pokémon in your party.
# Send out your Pokémon.
# If you assigned the sound properly to a cry animation, it should play the sound now.
#* If you assigned it to another animation, have your Pokémon perform that animation instead and listen for the sound.

If the sound is not being played, then something is not assigned properly. Make sure you followed the steps of this guide correctly and that your folder and file names are valid. Any capital letters or spaces in a file or folder name makes it unreadable. Additional help can be found in the Cobblemon Discord server.

{{Addon Creation}}

File:BlockbenchStuff.png

2024-03-08T05:17:26Z

Frank The Farmer: screenshot for clarity

== Summary ==
screenshot for clarity

Template:Addon Creation

2024-03-07T12:04:22Z

Frank The Farmer: Sounds like there's a new asset file

{{NavigationBox
|title=Addon Creation
|rows=
{{NavigationRow|category=Tutorials|content=
[[Tutorials/Creating A Custom Pokemon|Creating A Custom Pokemon]] [[Tutorials/Creating A Model|Creating A Model]] [[Tutorials/Creating Custom Spawns|Creating Custom Spawns]] [[Tutorials/Emissive Textures|Emissive Textures]] [[Tutorials/Animated Textures|Animated Textures]] [[Tutorials/Texture replacement|Texture Replacement]] [[Tutorials/Animation Replacement|Animation Replacement]] [[Tutorials/Multiple Visual Variants|Multiple Visual Variants]]
}}
{{NavigationRow|category=Asset Files|content=
[[Resolver]] [[Poser]] [[Sounds]]
}}
{{NavigationRow|category=Data Files|content=
[[Species]] [[Species Features]] [[Species Feature Assignments]] [[Species Additions]] [[Spawn Detail Presets]] [[Spawn Pool World]] [[Fossils_File|Fossils]]
}}
{{NavigationRow|category=Properties|content=
[[Pokémon/Behaviour|Behaviour]] [[Spawn Condition]]
}}
}}
[[Category:Addon Creation]]

Sounds

2024-03-07T12:03:23Z

Frank The Farmer: Sounds like there's a new wiki page

{{TOC|right}}
== Preface ==
The <code>sounds</code> JSON is responsible for assigning sound files to any sound events. This file is not exclusive to Cobblemon. You can learn more about it from the [https://minecraft.wiki/w/Sounds.json Minecraft Wiki]. This purpose of this page is to show you how to use it with Cobblemon.

== File And Folder Format ==
The sounds JSON simply adds more sound events and files for Minecraft to play. It does not overwrite other sounds JSONs in other resourcepacks. Replacements for sound event data would need to be specified inside of the file. You can reference Cobblemon's <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/resources/assets/cobblemon/sounds.json?ref_type=heads sounds.json]</code> to see what sound events and sounds you can manipulate.

There may be times where writing a sounds JSON would be irrelevant. One example would be if you want to replace a sound, but not add any to the sound event. You can simply have your resourcepack formatted to replace the <code>ogg</code> file like you would with [[Tutorials/Texture_replacement| texture replacements]]. You can find the file address for specific sound files by searching in the <code>.jar</code> or by referencing the [https://gitlab.com/cable-mc/cobblemon/-/tree/main/common/src/main/resources/assets/cobblemon/sounds?ref_type=heads Gitlab folder for sounds.]

Below is an example of how you would arrange a <code>sounds.json</code> and any custom sound files into a resourcepack:
* Minecraft only supports <code>ogg</code> sound files.
* Organization is recommended, but the correct file address is mandatory.
==== Folder Structure ====
<div class="treeview">
*''(addon name)''
** '''pack.mcmeta'''
**assets
***cobblemon
****'''sounds.json'''
****sounds
*****<primary folder>
******'''<sound>.ogg'''
******<secondary folder> (optional for organization)
*******'''<sound>.ogg''' (optional)
</div>

== Sounds JSON Breakdown ==
Remember that you can learn more about the <code>sounds.json</code> and its properties from the [https://minecraft.wiki/w/Sounds.json Minecraft Wiki]. Since you can only have one sounds JSON per resourcepack, you either have to group all your sound data together, or make separate resourcepacks if necessary.

Below is a breakdown of a <code>sounds.json</code> performing some relevant functions. Hover over the underlined text to see more information.
{
"<abbr title="This is a specified sound event. In this case, this is the sound event for wild Pokémon escaping the pokéball. ">poke_ball.open</abbr>": {
"<abbr title="Here you will specify if the following data will replace all previously loaded data for this specific sound event. False by default if this line is not written.">replace</abbr>": <abbr title="In this case, the following data will replace previous sound event data.">true</abbr>,
"<abbr title="Here you can write the subtitle for this sound event">subtitle</abbr>": "<abbr title="This text will be displayed in the subtitles whenever a Pokémon escapes. How cruel.">Hahaha</abbr>",
"<abbr title="Here you will list the sound files that this sound event can play.">sounds</abbr>": [
"<abbr title="The file address for the 'open.ogg' sound file">cobblemon:pokeball/open</abbr>",
"<abbr title="The file address for the 'open2.ogg' sound file">cobblemon:pokeball/open2</abbr>",
{
"<abbr title="Because we want to apply the volume property to this sound specifically, it is formatted differently from the previous two. This is where we specify what file will use the following volume property.">name</abbr>": "<abbr title="The file address for the 'open3.ogg' sound file.">cobblemon:pokeball/open3</abbr>",
"<abbr title="One of the few sound json properties. Here we are setting the volume value for the previously specified 'open3.ogg' sound file. Uses a range of 0.0 to 1.">volume</abbr>": <abbr title="A value of 0.5 should let the 'open3.ogg' file play at half of its original volume.">0.5</abbr>
}
]
},
"<abbr title="This is another specified sound event. In this case, this is the sound that gets played during Charizard's cry animation. It's played whenever Charizard is summoned or at the start of a battle.">pokemon.charizard.cry</abbr>": {
"<abbr title="Here you are listing sound files this event can use. Since the mod already has a sound for this event, the listed sounds will be added to Charizard's cry sounds.">sounds</abbr>": [ "<abbr title="The file address for the 'funny.ogg' sound file.">cobblemon:pokemon/charizard/funny</abbr>" ]
}
}
If this file were loaded, it would do the following:
* Replace the data for the <code>poke_ball.open</code> sound event with the data it has here
** Add a subtitle whenever this event plays
*** If subtitles are on, "Hahaha" is what would appear during this sound event.
** Play one of the three listed sound files whenever a Pokémon escapes the pokéball.
*** All three have an equal chance to be played since a <code>weight</code> property was not applied.
*** Only <code>open3.ogg</code> would play at half volume.
* Add a new sound file to play for Charizard's cry animation
** It does not replace the original sound because the <code>replace</code> property is not written for this sound event.
** There would be a 50% chance of playing this <code>funny</code> sound whenever sending out a Charizard.

== Sounds JSON Examples ==
This section contains a couple examples of a <code>sounds.json</code> for Cobblemon addons.

Below is an example of a sounds JSON that would add a sound for a custom Pokémon cry. This sound event would need to be tied to a cry animation through a sound keyframe in this specific animation. The sounds JSON creates the sound event and the animation plays the sound event. This example is not exclusive to cries. The same process would work for any sound in any animation.
{
"pokemon.tentaquil.cry": {
"sounds": ["cobblemon:pokemon/tentaquil/tentaquil_cry"]
}
}

Below is an example of a sounds JSON that would replace some sound event data. Remember that you would only want to do this if you plan to add more sounds to this sound event. Otherwise, just replace the <code>ogg</code>. You can reference Cobblemon's <code>[https://gitlab.com/cable-mc/cobblemon/-/blob/main/common/src/main/resources/assets/cobblemon/sounds.json?ref_type=heads sounds.json]</code> to see what sound events and sounds you can manipulate.
{
"poke_ball.open": {
"replace": true,
"sounds": [
"cobblemon:pokeball/open",
"cobblemon:pokeball/open2",
"cobblemon:pokeball/open3"
]
}
}

{{Addon_Creation}}

Template:Addon Creation

2024-03-06T05:32:53Z

Frank The Farmer: Fossilized new page to the table

{{NavigationBox
|title=Addon Creation
|rows=
{{NavigationRow|category=Tutorials|content=
[[Tutorials/Creating A Custom Pokemon|Creating A Custom Pokemon]] [[Tutorials/Creating A Model|Creating A Model]] [[Tutorials/Creating Custom Spawns|Creating Custom Spawns]] [[Tutorials/Emissive Textures|Emissive Textures]] [[Tutorials/Animated Textures|Animated Textures]] [[Tutorials/Texture replacement|Texture Replacement]] [[Tutorials/Animation Replacement|Animation Replacement]] [[Tutorials/Multiple Visual Variants|Multiple Visual Variants]]
}}
{{NavigationRow|category=Asset Files|content=
[[Resolver]] [[Poser]]
}}
{{NavigationRow|category=Data Files|content=
[[Species]] [[Species Features]] [[Species Feature Assignments]] [[Species Additions]] [[Spawn Detail Presets]] [[Spawn Pool World]] [[Fossils_File|Fossils]]
}}
{{NavigationRow|category=Properties|content=
[[Pokémon/Behaviour|Behaviour]] [[Spawn Condition]]
}}
}}
[[Category:Addon Creation]]

Fossils File

2024-03-06T05:30:28Z

Frank The Farmer: Your scientists were so preoccupied with whether or not they could, that they didn't stop to think if they should.

{{TOC|right}}
== Preface ==
The JSONs in the <code>fossils</code> folder control the resulting Pokémon from the <code>fossil machine</code>. These files specify what items are considered a fossil and what Pokémon should be created if these fossils are placed into the machine. They are short files where you simply select any Pokémon and any item in the game.

=== Fossil Breakdown ===
The fossil files are able to select any loaded Pokémon [[species]] to come out of the fossil machine. The <code>"result"</code> line functions like the <code>/pokegive</code> or <code>/pokespawn</code> commands, so you can include other data like level or regional forms. You can select up to 3 items you wish to serve as the "fossils."

Here is a breakdown of the <code>arctozolt</code> fossil file:
{
"<abbr title="Here you will specify what Pokémon will be generated from the machine and any extra data to apply to that Pokémon.">result</abbr>": "<abbr title="In this case, Arctozolt will be created if all the following items are placed into the machine. Because there is no other data specified, it will be a normal level 1 Arctozolt.">arctozolt</abbr>",
"<abbr title="Here you will list items to be used as fossils for the machine.">fossils</abbr>": [
"<abbr title="The item ID for the fossilized dino">cobblemon:fossilized_dino</abbr>",
"<abbr title="The item ID for the fossilized bird">cobblemon:fossilized_bird</abbr>"
]
}

 Here is some extra info about fossil files:
* If your <code>result</code> pokemon doesn't exist or includes a typo, then the species will be chose at random from '''all loaded species'''.
* Since the <code>result</code> functions like the commands that generate Pokémon, you can generate them as shiny or with special abilities.
* The <code>fossils</code> don't need to come out of the suspicious sand or gravel blocks. You can use any item from the game.
* The <code>fossils</code> list doesn't support NBT data.

=== Fossil Examples ===
Here are some fossil files you can use as a template to generate your own Pokémon.

* Cranidos' fossil file:
{
"result": "cranidos",
"fossils": [
"cobblemon:skull_fossil"
]
}

* A custom Porygon file that will generate as a level 10 shiny:
{
"result": "porygon shiny=yes level=10",
"fossils": [
"cobblemon:upgrade",
"cobblemon:dubious_disc",
"cobblemon:rare_candy"
]

{{Addon Creation}}

Pokémon/Behaviour

2024-03-05T07:01:40Z

Frank The Farmer: Addon Creation creation

A Pokémon's AI behaviour is configurable from their species JSON. This is used control whether it can walk, swim, or fly as well as the speed it moves while doing each of those, whether or not it can fall asleep, and various other things.

The default is a land-moving AI that moves at a brisk pace, cannot breathe underwater, and does not sleep.

===PokemonBehaviour===
{| class="wikitable"
|-
! Option
! style="text-align:left;" | Details
|-
| style="vertical-align:top;" | moving
| A set of properties relating to the movement of a Pokémon.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| style="vertical-align:top;" | walk
| A set of properties that control the land walking of a Pokémon.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| canWalk
| A <code>true/false</code> value. If <code>false</code>, the Pokémon cannot move over land.
|-
| walkSpeed
| The base speed of the Pokémon when moving over land, defaulting to <code>0.35</code>.
|}
|-
| style="vertical-align:top;" | swim
| A set of properties that control the swimming (through water or lava) of a Pokémon.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| canSwimInWater
| A <code>true/false</code> value. If <code>true</code>, the Pokémon can swim in water.
|-
| canBreatheUnderwater
| A <code>true/false</code> value. If <code>false</code>, the Pokémon will drown if it stays submerged in water for too long.
|-
| canWalkOnWater
| A <code>true/false</code> value. If <code>true</code>, the Pokémon will move across the top of water as if it's walking on it.
|-
| canSwimInLava
| A <code>true/false</code> value. If <code>true</code>, the Pokémon can swim in lava.
|-
| canBreatheUnderlava
| A <code>true/false</code> value. If <code>false</code>, the Pokémon will drown if it stays submerged in lava for too long.
|-
| canWalkOnLava
| A <code>true/false</code> value. If <code>true</code>, the Pokémon will move across the top of lava as if it's walking on it.
|-
| hurtByLava
| A <code>true/false</code> value. If <code>false</code>, the Pokémon will not take damage in lava.
|-
| swimSpeed
| The base speed of the Pokémon when moving through fluids, defaulting to <code>0.3</code>.
|}
|-
| style="vertical-align:top;" | fly
| A set of properties that control the flight through the air of a Pokémon.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| canFly
| A <code>true/false</code> value. If <code>true</code>, the Pokémon is capable of flying through the air.
|-
| flySpeedHorizontal
| The horizontal speed of the Pokémon when flying, defaulting to <code>0.3</code>.
|}
|-
| canLook
| A <code>true/false</code> value. If <code>false</code>, the Pokémon will not even turn to look at nearby entities.
|}
|-
| style="vertical-align:top;" | resting
| A set of properties relating to how and when the Pokémon sleeps, if it sleeps at all.
 
{| class="wikitable" style="margin:auto"
|-
! Option
! style="text-align:left;" | Details
|-
| canSleep
| A <code>true/false</code> value. If it's <code>true</code>, then it can fall asleep if it is a wild Pokémon. Many other options exist as filters for when a Pokémon can fall asleep in nature and all require this option to be set to true.
|-
| times
| A time range for when it can sleep, which can be abbreviations or tick ranges and can be combined with commas. Examples: <code>"day"</code>, <code>"night"</code>, <code>"dawn,dusk"</code>, <code>"1200-2400,morning"</code>. This is the same format as the time range controls in Spawner Conditions. The default value is set to <code>"night"</code> if no other value is specified.
|-
| sleepChance
| The chance (per tick) of a Pokémon falling asleep. By default it is <code>0.0017</code> which roughly equates to it taking an average of 30 seconds to fall asleep.
|-
| blocks
| A list of block conditions, one of which must be met for the Pokémon to be able to sleep on the block. Block conditions can be either the name of the block or a tag that the block must be in.
|-
| biomes
| A list of biome conditions, one of which must be met for the Pokémon to be able to sleep in the biome. Biome conditions can be either the name of the biome or a tag that the biome must be in.
|-
| light
| A light level or level range, between <code>0</code> and <code>15</code>, which represents the light levels in which the Pokémon is able to sleep. If you set this option to <code>"15"</code>, then the Pokémon can only fall asleep in maximum light. If you set this option to <code>"0-7"</code>, then it can only fall asleep when it's fairly dark. [[minecraftwiki:Light#Light_level|These light levels can be found on the Minecraft Wiki]].
|-
| depth
| The depth of the sleep. This is a classification on what things can interrupt the sleep and make the Pokémon wake up. If you set it to <code>"normal"</code> then it will wake up when a non-sneaking player is within 16 blocks of the Pokémon. Another option is <code>"comatose"</code>, and this causes the Pokémon to sleep through pretty much anything. You can add new sleep depths using the SleepDepth API.
|-
| willSleepOnBed
| A <code>true/false</code> value. If <code>true</code>, the Pokémon will try to sleep on top of the player's bed when they hop into it, much like cats.
|}
|}

==Examples==
Examples from existing species JSONs:

'''Charmander'''
"behaviour": {
"resting": {
"canSleep": true,
"willSleepOnBed": true,
"depth": "normal",
"light": "0-2"
}
},

'''Charizard'''
"behaviour": {
"moving": {
"fly": {
"canFly": true,
"flySpeedHorizontal": 0.6
}
}
},

'''Lapras'''
"behaviour": {
"moving": {
"swim": {
"canWalkOnWater": true,
"canSwim": true,
"canBreatheUnderwater": true
}
}
},

{{Addon Creation}}

Spawn Condition

2024-03-05T07:00:38Z

Frank The Farmer: Added on Addon Creation Template

A '''spawn condition''' is used during spawn selection to decide whether a specific SpawnDetail is compatible with the given SpawningContext.

A [[Spawn_Pool_World|spawn condition JSON]] has many common properties that apply to all contexts, and then there are sub-types that apply to specific contexts. For example, a submerged context has information about depth, and so a SubmergedSpawningCondition is required to make a condition that checks that depth value for a spawn. For all values that are left blank or empty, that value is not checked by the condition. For example, an empty biome list means the biome won't affect the spawning and an unset moonPhase means the moon won't affect the spawning.

{| class="wikitable"
|-
! Property Name
! style="text-align:left;" | Description
|-
| style="vertical-align:top;" | dimensions
| A list of dimension IDs, such as <code>minecraft:overworld</code> or <code>minecraft:the_nether</code>. This is technically called a dimension effect.
|-
| style="vertical-align:top;" | biomes
| A list of biome based conditions. These conditions are all written as text. If the condition starts with a <code>#</code> such as <code>#pokemoncobbled:is_arid</code>, it is understood as a biome tag condition, otherwise checked as a biome ID such as <code>minecraft:forest</code>.
|-
| style="vertical-align:top;" | structures
| A list of structure IDs, such as <code>minecraft:stronghold</code> or <code>minecraft:desert_pyramid</code>. Allows Pokémon to spawn in the chunks of the listed structures.
|-
| style="vertical-align:top;" | moonPhase
| The phase of the moon required for the spawn. This is an integer between 0 and 7 according to the [https://minecraft.fandom.com/wiki/Moon Minecraft Wiki].
|-
| style="vertical-align:top;" | canSeeSky
| Whether or not the spawning context must have a direct route to the sky above it, as a <code>true/false</code>. Fluids do not count as a sky obstruction.
|-
| style="vertical-align:top;" | minX
| The minimum X coordinate that the spawning context may have.
|-
| style="vertical-align:top;" | minY
| The minimum Y coordinate that the spawning context may have.
|-
| style="vertical-align:top;" | minZ
| The minimum Z coordinate that the spawning context may have.
|-
| style="vertical-align:top;" | maxX
| The maximum X coordinate that the spawning context may have.
|-
| style="vertical-align:top;" | maxY
| The maximum Y coordinate that the spawning context may have.
|-
| style="vertical-align:top;" | maxZ
| The maximum Z coordinate that the spawning context may have.
|-
| style="vertical-align:top;" | minLight
| The lowest acceptable light level at the spawning context's location. This is an integer between <code>0</code> and <code>15</code> inclusive.
|-
| style="vertical-align:top;" | maxLight
| The highest acceptable light level at the spawning context's location. This is an integer between <code>0</code> and <code>15</code> inclusive.
|-
| style="vertical-align:top;" | timeRange
| The time range that is acceptable. This can either be text for registered time ranges like <code>'day'</code>, <code>'night'</code>, <code>'morning'</code>, or it can be a comma separated list of tick ranges such as <code>'0-1200,2000-3000'</code>. It can also be a combination of both.
|-
| style="vertical-align:top;" | isRaining
| Whether it must be raining or not raining, as a <code>true/false</code>.
|-
| style="vertical-align:top;" | isThundering
| Whether it must be thundering or not thundering, as a <code>true/false</code>. Note that if it's raining regularly, it will not count as thundering. If it is thundering, it will count as both thundering and raining.
|-
| style="vertical-align:top;" | labels
| The required labels on the spawn for it to be acceptable. This can be either a condition that requires all of the specified labels to be met, or just one of them. This is dictated by the '''labelMode''' value.
|-
| style="vertical-align:top;" | labelMode
| What kind of check will be applied for the labels. This is either <code>ANY</code>, meaning that any matching label from the condition's label list will suffice, or <code>ALL</code>, which requires every label mentioned in the condition to exist in the spawn.
|}

Area spawning conditions are a sub-type of spawning condition and adds more properties that will apply to all area based spawning contexts (which is all world spawning).

{| class="wikitable"
|-
! Property Name
! style="text-align:left;" | Description
|-
| style="vertical-align:top;" | minWidth
| The smallest acceptable horizontal space around an area spawning context. Should be used to protect spawns from occurring where they will immediately suffocate and die.
|-
| style="vertical-align:top;" | maxWidth
| The largest acceptable horizontal space around an area spawning context.
|-
| style="vertical-align:top;" | minHeight
| The smallest acceptable amount of vertical space above an area spawning context. Should be used to protect spawns from occurring where they will immediately suffocate and die.
|-
| style="vertical-align:top;" | maxHeight
| The largest acceptable amount of vertical space above an area spawning context.
|-
| style="vertical-align:top;" | neededNearbyBlocks
| A list of block identifiers such as <code>minecraft:cobblestone</code>, at least one of which must be nearby. What counts as nearby is dependent on the config option that dictates how far out it should look.
|}

Grounded spawning conditions are a sub-type of area spawning condition and adds more properties that will apply to the grounded context.

{| class="wikitable"
|-
! Property Name
! style="text-align:left;" | Description
|-
| style="vertical-align:top;" | neededBaseBlocks
| A list of block identifiers such as <code>minecraft:cobblestone</code>, at least one of which must be the base block that the spawn is occurring on.
|}

Submerged spawning conditions are a sub-type of area spawning condition and adds more properties that will apply to the submerged contexts, those being underlava and underwater.

{| class="wikitable"
|-
! Property Name
! style="text-align:left;" | Description
|-
| style="vertical-align:top;" | minDepth
| The minimum number of blocks that may be beneath the submerged spawning context.
|-
| style="vertical-align:top;" | maxDepth
| The maximum number of blocks that may be beneath the submerged spawning context.
|-
| style="vertical-align:top;" | fluidIsSource
| Whether or not the fluid block the spawn is occurring in must be a source for the fluid.
|-
| style="vertical-align:top;" | fluidBlock
| The type of fluid it must be spawning in. This is as a translated name, such as water.
|}

{{Addon Creation}}