Blob: navbox

2023-10-14T11:37:56Z

navbox

← Older revision		Revision as of 11:37, 14 October 2023
Line 191:		Line 191:

	Depending on what you wrote, the listed Pokémon should now have the listed features		Depending on what you wrote, the listed Pokémon should now have the listed features

			{{Addon Creation}}

Frank The Farmer: Created page with "{{TOC|right}} == Preface == Creating Pokémon variants starts at the creation of the `species_features` file. This file creates one or many `aspects` that can each be assigned its own assets in the `resolver` files. Pokémon that are assigned with a feature can also assign each aspect with its own set of stats in the `species` files using `forms`. This article will give some examples of species features and break do..."

2023-07-24T11:28:53Z

Created page with "{{TOC|right}} == Preface == Creating Pokémon variants starts at the creation of the <code>species_features</code> file. This file creates one or many <code>aspects</code> that can each be assigned its own assets in the <code>resolver</code> files. Pokémon that are assigned with a feature can also assign each aspect with its own set of stats in the <code>species</code> files using <code>forms</code>. This article will give some examples of species features and break do..."

New page

{{TOC|right}}
== Preface ==
Creating Pokémon variants starts at the creation of the <code>species_features</code> file. This file creates one or many <code>aspects</code> that can each be assigned its own assets in the <code>resolver</code> files. Pokémon that are assigned with a feature can also assign each aspect with its own set of stats in the <code>species</code> files using <code>forms</code>.

This article will give some examples of species features and break down its different properties.

=== Species Feature Breakdown ===
There are two types of species features. The <code>flag</code> type feature creates a single aspect and is often used in the creation of regional forms. The <code>choice</code> type feature creates a pool of aspects and is often used in the creation of Pokémon that require multiple textures like Basculin or Alcremie.

==== Flag Type ====
Here is a breakdown of the <code>alolan</code> species feature. Hover over the underlined text to see more information.
{
"<abbr title="Keys are what your aspects will be called in other data files and in game">keys</abbr>": <abbr title="The name of your aspect. You usually want just one, but you can name more than one.">["alolan"]</abbr>,
"<abbr title="Type will determine whether there are multiple aspects or not">type</abbr>": "<abbr title="flag is used when you only want one aspect from your species feature">flag</abbr>",
"<abbr title="Whether or not this feature is also an aspect">isAspect</abbr>": <abbr title="Usually you set this to true. Can be set to false if you don't want your variant to have visual differences. Example: event Pokémon">true</abbr>,
"<abbr title="Usually always set to false">default": false</abbr>
}

==== Choice Type ====
Here is a breakdown of the <code>pumpkin_size</code> species feature. Hover over the underlined text to see more information.
{
"<abbr title="Type will determine whether there are multiple aspects or not">type</abbr>": "<abbr title="Choice means that there are multiple aspects to choose from">choice</abbr>",
"<abbr title="Keys are what your aspects will be called in other data files and in game">keys</abbr>": <abbr title="The name of your aspect. You usually want just one, but you can name more than one.">["pumpkin_size"]</abbr>,
"<abbr title="Determines which choice below will be the default aspect">default</abbr>": "<abbr title="The default aspect name. Can be set to one of the following choices, random, true, or false. You usually want it set to random">random</abbr>",
"<abbr title="Where you list your pool of choices">choices</abbr>": [
"<abbr title="Choice #1 in your aspect pool">small"</abbr>,
"<abbr title="Choice #2 in your aspect pool">average"</abbr>,
"<abbr title="Choice #3 in your aspect pool">large"</abbr>,
"<abbr title="Choice #4 in your aspect pool">super</abbr>"
],
"<abbr title="Whether or not this feature is also an aspect">isAspect</abbr>": <abbr title="You always want this set to true">true</abbr>,
"<abbr title="The written format of this aspect and its subvariants">aspectFormat</abbr>": "<abbr title="How your aspect will be written in other data files and in game. Example: pumpkin-size-small">pumpkin-size-<nowiki>{{choice}}</nowiki></abbr>"
}
* You can list as many choices as you like and name them whatever you like

=== Species Feature Examples ===
This section will list a couple of examples you may use a template for your own <code>species_features</code>. The formats generally stay the same, but the values can be changed if desired.

==== Regional Variants ====
You can borrow one of the following examples if you'd like to create a feature for custom regional Pokémon. Most regional features use the <code>flag</code> type format. The one exception is Tauros' Paldean breed feature.
* Galarian
{
"keys": ["galarian"],
"type": "flag",
"isAspect": true,
"default": false
}
</br>

* Hisuian
{
"keys": ["hisuian"],
"type": "flag",
"isAspect": true,
"default": false
}

==== Variants With Multiple Textures ====
You can borrow one of the following examples if you'd like to create a Pokemon that will have more than one model or texture. These types of Pokémon always use the <code>choice</code> type format. You can assign multiple choice type features to a single Pokémon like with Alcremie and Spinda. Combining the different sub-aspects of 2 or more aspect pools exponentially increases the number of unique variants as a result.

* Arbok's Snake Patterns
{
"type": "choice",
"keys": ["snake_pattern"],
"default": "random",
"choices": [
"classic",
"legacy",
"attack",
"dark",
"elusive",
"heart",
"speed",
"sound"
],
"isAspect": true,
"aspectFormat": "snake-pattern-<nowiki>{{choice}}</nowiki>"
}
</br>

* Alcremie's Cream And Decoration Features
** Cream
{
"type": "choice",
"keys": ["cream"],
"default": "random",
"choices": [
"vanilla",
"ruby",
"matcha",
"mint",
"lemon",
"salted",
"ruby_swirl",
"caramel_swirl",
"rainbow_swirl"
],
"isAspect": true,
"aspectFormat": "cream-<nowiki>{{choice}}</nowiki>"
}
**<li value=3> Decoration
{
"type": "choice",
"keys": ["decoration"],
"default": "random",
"choices": [
"strawberry",
"berry",
"love",
"star",
"clover",
"flower",
"ribbon"
],
"isAspect": true,
"aspectFormat": "decoration-<nowiki>{{choice}}</nowiki>"
}
</br>

=== Assigning a Species Feature ===
A Pokémon can't use the <code>aspects</code> from a <code>species feature</code> if it is never assigned to its <code>species</code> file. There are 3 different ways you can assign a feature to a species file. Although each method achieves the same purpose, '''one method will always be the most efficient depending on the addon you want to make. '''

==== Writing the feature directly into the species file ====
This method is most efficient when you are the creator of both the custom Pokémon <code>species</code> and the custom <code>species feature</code>. Assuming you created both, you can just insert the feature into the species file instead of creating a new file for one of the other options. Do not forget to assign the aspect to any special forms if you made any.

# Open your target Pokémon's <code>species</code> file
# Insert the following line of data somewhere in the species file
#* Do not insert this line in another property's brackets
#* Remember to include commas when necessary
<code>"features": ["<your_feature>"]</code>
# <li value=3>Save the file

The target Pokémon should now be assigned a new species feature!

==== Creating a "species addition" file ====
This method is most efficient when you want to create a regional variant or similar feature for a Pokémon you didn't make. The <code>species addition</code> file is a helpful way of ''adding'' a feature and form data to a Pokémon without having to edit the main <code>species</code> file. This method should also allow your addon to stay compatible with other addons that want to add data to the same Pokémon!

# 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 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.
#* Create this folder if needed

Your target Pokémon should now be assigned a new feature and some new stats for its special form.

==== Creating a "species feature assignment" file ====
This method is most efficient when you want to assign one or more Pokémon with one or more features. This can be helpful if you want to assign a feature to an entire evolutionary line that you or somebody else made. It can also be helpful if you want to apply a list of features to a single Pokémon.

# Create a new text file and name it after your idea. Include the extension of <code>.json</code>
#* Example: <code>spinda_spots.json</code>
# Insert the following data into this new species_addition JSON:
#* You can list as many Pokémon or features as you need
<syntaxhighlight>
{
"pokemon": ["<target_pokemon_1>", "<target_pokemon_2>"],
"features": ["<feature_1>", "<feature_2>"]
}
</syntaxhighlight>
# <li value="3"> Change <code>"<target_pokemon_#>"</code> to reference the Pokémon you want to add the features to. It must remain in quotes.
#* Example: <code>["bulbasaur", "ivysaur", "venusaur"]</code>
# Change <code>"<feature_#>"</code> to the feature(s) you made earlier. It must remain in quotes.
# <li value="5"> Save the file.
# Place this new file into the <code>species_feature_assignments</code> folder of your addon.
#* Create this folder if needed

Depending on what you wrote, the listed Pokémon should now have the listed features

Species Features - Revision history

Blob: navbox