Tutorials/Creating Custom Spawns - Revision history

Frank The Farmer: Updated conditions links to use wiki page instead

2024-05-19T13:52:35Z

Updated conditions links to use wiki page instead

← Older revision		Revision as of 13:52, 19 May 2024
Line 64:		Line 64:

	=== Step 2: Create your spawn files ===		=== 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 [~~https://gitlab.com/cable-mc/cobblemon/-/wikis/Spawner/Spawn-Condition~~ spawn conditions.]		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.		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.
Line 73:		Line 73:
	* '''"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>		* '''"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.		* '''"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 [~~https://gitlab.com/cable-mc/cobblemon/-/wikis/Spawner/Spawn-Condition~~ here] to make Pokémon spawn		* '''"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 [~~https://gitlab.com/cable-mc/cobblemon/-/wikis/Spawner/Spawn-Condition~~ here] to '''PREVENT''' a Pokémon from spawning		* '''"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!		* '''"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!

Frank The Farmer: /* Step 2: Create your spawn files */

2024-02-23T05:28:01Z

Step 2: Create your spawn files

← Older revision		Revision as of 05:28, 23 February 2024
Line 65:		Line 65:
	=== Step 2: Create your spawn files ===		=== 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 [https://gitlab.com/cable-mc/cobblemon/-/wikis/Spawner/Spawn-Condition spawn conditions.]		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 [https://gitlab.com/cable-mc/cobblemon/-/wikis/Spawner/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:		Here is a list of options that some of the spawn properties can use:

Frank The Farmer: /* Step 3: Test your addon in game */

2024-02-23T05:16:48Z

Step 3: Test your addon in game

← Older revision		Revision as of 05:16, 23 February 2024
Line 107:		Line 107:
	# Check if your target Pokémon spawns where you assigned it to. You can use <code>/checkspawn <rarity></code> when in the assigned biome.		# 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 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.		# 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.'''		# 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.		#* The command for <code>/reload</code> does not work with Cobblemon addons unfortunately.

Frank The Farmer: /* Step 2: Create your spawn files */

2024-02-23T05:11:05Z

Step 2: Create your spawn files

← Older revision		Revision as of 05:11, 23 February 2024
Line 81:		Line 81:
	# Rename the file to anything you want. The name must be different than the original.		# Rename the file to anything you want. The name must be different than the original.
	#* Example: <code>bunearyspawn2</code>		#* 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>		# 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.		# Edit the Pokémon's name '''and replace''' it with the Pokémon you want to make custom spawns for.

Timinc: pack_format

2024-02-21T00:41:31Z

pack_format

← Older revision		Revision as of 00:41, 21 February 2024
Line 19:		Line 19:
	{		{
	"<abbr title="This lets Minecraft know that it is a datapack">pack</abbr>": {		"<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.19.2, the current datapack format number is 10. But it will still load if this number isn't correct!">10</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="Here you will write a short description of your datapack">description</abbr>": "<abbr title="Your short datapack description">Example datapack description</abbr>"
	}		}
Line 32:		Line 32:
	{		{
	"<abbr title="This lets Minecraft know that it is a datapack">pack</abbr>": {		"<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.19.2, the current datapack format number is 10. But it will still load if this number isn't correct!">10</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="Here you will write a short description of your datapack">description</abbr>": "<abbr title="Your short datapack description">Example datapack description</abbr>"
	},		},

Blob: added back Category:Tutorial

2023-10-14T11:41:20Z

added back Category:Tutorial

← Older revision		Revision as of 11:41, 14 October 2023
Line 113:		Line 113:

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

Blob: navbox

2023-10-14T11:35:35Z

navbox

← Older revision		Revision as of 11:35, 14 October 2023
Line 112:		Line 112:
	You should now have new natural Pokémon spawns!		You should now have new natural Pokémon spawns!

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

Blob: added Category:Tutorial

2023-08-07T08:35:15Z

added Category:Tutorial

← Older revision		Revision as of 08:35, 7 August 2023
Line 64:		Line 64:

	=== Step 2: Create your spawn files ===		=== 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 [https://gitlab.com/cable-mc/cobblemon/-/wikis/Spawner/Spawn-Condition spawn conditions.]		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 [https://gitlab.com/cable-mc/cobblemon/-/wikis/Spawner/Spawn-Condition spawn conditions.]

	Here is a list of options that some of the spawn properties can use:		Here is a list of options that some of the spawn properties can use:
Line 111:		Line 111:

	You should now have new natural Pokémon spawns!		You should now have new natural Pokémon spawns!

			[[Category:Tutorial]]

Frank The Farmer at 23:12, 5 August 2023

2023-08-05T23:12:40Z

← Older revision		Revision as of 23:12, 5 August 2023
Line 23:		Line 23:
	}		}
	}		}
	*# <li value=3> Save the file and prepare to place it in your addon folders.		::# <li value=3> Save the file and prepare to place it in your addon folders.


Line 44:		Line 44:
	}		}
	}		}
	*# <li value=3> Save the file and prepare to place it in your addon folders.		::# <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		Now, you can create the folders to place your files into.

	==== Folder Structure ====		==== Folder Structure ====

Blob at 16:12, 31 July 2023

2023-07-31T16:12:17Z

← Older revision		Revision as of 16:12, 31 July 2023
Line 1:		Line 1:
	{{TOC\|right}}		{{TOC\|right}}
	== Preface ==		== 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.		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~~.		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 ===		=== Step 1: Arrange the folders for this addon ===
Line 18:		Line 18:
	*# Open the file and insert the following data:		*# Open the file and insert the following data:
	{		{
	"<abbr title="This lets ~~minecraft~~ know that it is a datapack">pack</abbr>": {		"<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.19.2, the current datapack format number is 10. But it will still load if this number isn't correct!">10</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.19.2, the current datapack format number is 10. But it will still load if this number isn't correct!">10</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="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 ~~put~~ it in your addon folders		*# <li value=3> Save the file and prepare to place it in your addon folders.


Line 31:		Line 31:
	*# Open the file and insert the following data:		*# Open the file and insert the following data:
	{		{
	"<abbr title="This lets ~~minecraft~~ know that it is a datapack">pack</abbr>": {		"<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.19.2, the current datapack format number is 10. But it will still load if this number isn't correct!">10</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.19.2, the current datapack format number is 10. But it will still load if this number isn't correct!">10</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="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 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="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 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>",
Line 44:		Line 44:
	}		}
	}		}
	*# <li value=3> Save the file and prepare to ~~put~~ it in your addon folders		*# <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		Now, you can create the folders to place your files into

	==== Folder Structure ====		==== 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 ~~name space~~ if you don't want your spawn files to be affected from folder blocking.		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'''		'''Folder Structure'''
Line 56:		Line 56:
	** '''pack.mcmeta'''		** '''pack.mcmeta'''
	**data		**data
	***<abbr title="This is a ~~name space~~. You can create your own if you need to">cobblemon</abbr>		***<abbr title="This is a namespace. You can create your own if you need to">cobblemon</abbr>
	****spawn_pool_world		****spawn_pool_world
	*****''<sub_folders>'' (optional)		*****''<sub_folders>'' (optional)
Line 67:		Line 67:

	Here is a list of options that some of the spawn properties can use:		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]].		* '''"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.		* '''"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>		* '''"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>
Line 73:		Line 73:
	* '''"condition"''': You can use any of the conditions listed [https://gitlab.com/cable-mc/cobblemon/-/wikis/Spawner/Spawn-Condition here] to make Pokémon spawn		* '''"condition"''': You can use any of the conditions listed [https://gitlab.com/cable-mc/cobblemon/-/wikis/Spawner/Spawn-Condition here] to make Pokémon spawn
	* '''"anticondition"''': You can use any of the conditions listed [https://gitlab.com/cable-mc/cobblemon/-/wikis/Spawner/Spawn-Condition here] to '''PREVENT''' a Pokémon from spawning		* '''"anticondition"''': You can use any of the conditions listed [https://gitlab.com/cable-mc/cobblemon/-/wikis/Spawner/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!		* '''"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!


Line 84:		Line 84:
	# Edit the Pokémon's name '''and replace''' it with the Pokémon you want to make custom spawns for.		# 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.		#* 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		# 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]		#* 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>"context"</code> if desired.
Line 95:		Line 95:
	# Change the<code>"anticondition"</code> values if desired.		# Change the<code>"anticondition"</code> values if desired.
	#* Sometimes you might even want to delete this section if it exists in the template.		#* Sometimes you might even want to delete this section if it exists in the template.
	# Save the file		# Save the file.
	# Place this new spawn file in the <code>spawn_pool_world</code> folder of your addon		# 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!		# Repeat the whole process for any other spawn files you want to make!
Line 102:		Line 102:
	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.		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.		# Copy your addon folder and place it in the "datapacks" folder of your world in the Minecraft root directory.
	# Start up Minecraft		# Start up Minecraft.
	# Load/create a '''Creative''' world save that contains your addon in the "datapack" folder.		# 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.		# Check if your target Pokémon spawns where you assigned it to. You can use <code>/checkspawn <rarity></code> when in the assigned biome.