Creating Items - Revision history

Jaskrendix at 17:45, 20 January 2024

2024-01-20T17:45:35Z

← Older revision		Revision as of 17:45, 20 January 2024
Line 43:		Line 43:
	\| usable_in		\| usable_in
	\| Possibilities are: "MainCombatMenuState" (during battle), "WorldState" (in the world) or "" (never)		\| Possibilities are: "MainCombatMenuState" (during battle), "WorldState" (in the world) or "" (never)
	\|-
	~~\| visible~~
	~~\| Boolean (True/False) whether the item is visible or not inside the bag.~~
	\|-		\|-
	\| use_failure		\| use_failure
Line 55:		Line 52:
	\| use_success		\| use_success
	\| Corresponding msgid (translation PO file) will appear if the item is used successfully (depending on effects).		\| Corresponding msgid (translation PO file) will appear if the item is used successfully (depending on effects).
			\|-
			\| visible (optional)
			\| Boolean (True/False) whether the item is visible or not inside the bag.
			\|-
			\| menu (optional)
			\| it allows to show a button in the world menu: <code>["0","menu_tuxepedia","JournalChoice"]</code> where '''0''' is the position (0 = up), '''menu_tuxepedia''' is a msgid (translation PO file) and '''JournalChoice''' is the class that will appear if someone click on it.
	\|}		\|}

2024-01-20T17:41:13Z

← Older revision		Revision as of 17:41, 20 January 2024
Line 43:		Line 43:
	\| usable_in		\| usable_in
	\| Possibilities are: "MainCombatMenuState" (during battle), "WorldState" (in the world) or "" (never)		\| Possibilities are: "MainCombatMenuState" (during battle), "WorldState" (in the world) or "" (never)
			\|-
			\| visible
			\| Boolean (True/False) whether the item is visible or not inside the bag.
	\|-		\|-
	\| use_failure		\| use_failure

2023-12-28T06:23:09Z

Item Design

← Older revision		Revision as of 06:23, 28 December 2023
Line 39:		Line 39:
	\|-		\|-
	\| type		\| type
	\| It can be '''KeyItem''' or '''Consumable'''. If used, then '''Consumable''' is going to remove 1 quantity.		\| It can be '''KeyItem''' or '''Consumable''', or neither. KeyItems should generally not be able to be sold. If used, then '''Consumable''' is going to remove 1 quantity.
	\|-		\|-
	\| usable_in		\| usable_in

2023-12-26T17:54:59Z

← Older revision		Revision as of 17:54, 26 December 2023
Line 7:		Line 7:
	[[File:BANANA_2.png]] [[File:Bug_gym_badge.png]]		[[File:BANANA_2.png]] [[File:Bug_gym_badge.png]]

	After creating your item sprite, put your graphic under <code>~~resources~~/gfx/items</code>.		After creating your item sprite, put your graphic under <code>mods/tuxemon/gfx/items</code>.

	== Using your item in Tuxemon ==		== Using your item in Tuxemon ==
Line 56:		Line 56:
	Here is an example of what an item file might look like:		Here is an example of what an item file might look like:

	`~~resources~~/db/item/potion.json`		`mods/tuxemon/db/item/potion.json`

	json		json

2023-12-26T17:48:10Z

← Older revision		Revision as of 17:48, 26 December 2023
Line 13:		Line 13:

	== Item Design ==		== Item Design ==
	Items in Tuxemon can be created by adding a JSON file to the <code>~~resources~~/db/item</code> directory. With each new item, the following data must be specified:		Items in Tuxemon can be created by adding a JSON file to the <code>mods/tuxemon/db/item</code> directory. With each new item, the following data must be specified:

	{\| class="wikitable"		{\| class="wikitable"

2023-12-26T11:18:35Z

← Older revision		Revision as of 11:18, 26 December 2023
Line 36:		Line 36:
	\|-		\|-
	\| category		\| category
	\| It can be "none", "badge", "elements", "fossil", "morph", "revive", "potion", "technique", "phone", "fish", "destroy", "capture" or "stats".		\| It can be "none", "badge", "booster", "elements", "fossil", "morph", "revive", "potion", "technique", "phone", "fish", "destroy", "capture" or "stats".
	\|-		\|-
	\| type		\| type

2023-12-26T11:07:29Z

← Older revision		Revision as of 11:07, 26 December 2023
Line 36:		Line 36:
	\|-		\|-
	\| category		\| category
	\| It can be "none", "badge~~", "booster~~", "elements", "fossil", "morph", "revive", "potion", "technique", "phone", "fish", "destroy", "capture" or "stats".		\| It can be "none", "badge", "elements", "fossil", "morph", "revive", "potion", "technique", "phone", "fish", "destroy", "capture" or "stats".
	\|-		\|-
	\| type		\| type

2023-12-26T11:02:46Z

← Older revision		Revision as of 11:02, 26 December 2023
Line 21:		Line 21:
	\|-		\|-
	\| conditions		\| conditions
	\| Conditions are the prerequisites on which an item can be used or not. By using the example below: "is current_hp <,1.0", and "is current_hp >,0" ~~mean~~ that the item can be used on a monster with more than 0 HP (not fainted) and less that the total (not healthy).		\| Conditions are the prerequisites on which an item can be used or not. By using the example below: "is current_hp <,1.0", and "is current_hp >,0" means that the item can be used on a monster with more than 0 HP (not fainted) and less that the total (not healthy).
	\|-		\|-
	\| effects		\| effects

2023-12-26T10:23:54Z

← Older revision		Revision as of 10:23, 26 December 2023
Line 27:		Line 27:
	\|-		\|-
	\| slug		\| slug
	\| The slug identifier of the item. It defines the name of the item and there is a translation in the PO file (msgid "~~sting~~" - msgstr "~~Sting~~") as well as the description (msgid "~~sting_description~~" - msgstr "~~Describing the item~~").		\| The slug identifier of the item. It defines the name of the item and there is a translation in the PO file (msgid "potion" - msgstr "Potion") as well as the description (msgid "potion_description" - msgstr "Heals a monster by 20 HP.").
	\|-		\|-
	\| sort		\| sort

2023-12-26T10:22:58Z

← Older revision		Revision as of 10:22, 26 December 2023
Line 27:		Line 27:
	\|-		\|-
	\| slug		\| slug
	\| The slug identifier of the ~~technique~~. It defines the name of the ~~technique~~ and there is a translation in the PO file (msgid "sting" - msgstr "Sting") as well as the description (msgid "sting_description" - msgstr "Describing the ~~technique~~").		\| The slug identifier of the item. It defines the name of the item and there is a translation in the PO file (msgid "sting" - msgstr "Sting") as well as the description (msgid "sting_description" - msgstr "Describing the item").
	\|-		\|-
	\| sort		\| sort