Modding add equipment - Revision history

Green riding hood: updating 'Add the new item. Copy and modify a file from data\items\items\'

2022-02-03T14:46:03Z

updating 'Add the new item. Copy and modify a file from data\items\items\'

← Older revision		Revision as of 14:46, 3 February 2022
Line 31:		Line 31:
	</code>		</code>

	<li>Add the new item. Copy and modify a file from data\items\ and name it "daveaShield1.json". You can search in the original files for ideas. For this project, delete all the text and paste the following lines. This adds a shield which uses an existing image from the game, but gives the new shield effects created above.		<li>Add the new item. Copy and modify a file from data\items\items\ and name it "daveaShield1.json". You can search in the original files for ideas. For this project, delete all the text and paste the following lines. This adds a shield which uses an existing image from the game, but gives the new shield effects created above.
	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
	{		{

Ruarch: updating item format to remove outer [] since data format has changed.

2022-02-02T21:36:29Z

updating item format to remove outer [] since data format has changed.

← Older revision		Revision as of 21:36, 2 February 2022
Line 31:		Line 31:
	</code>		</code>

	<li>Add the new item. Copy and modify file data\items\~~offHand~~.json. You can search in the original ~~file~~ for ideas. For this project, delete all the text and paste the following lines. This adds a shield which uses an existing image from the game, but gives the new shield effects created above.		<li>Add the new item. Copy and modify a file from data\items\ and name it "daveaShield1.json". You can search in the original files for ideas. For this project, delete all the text and paste the following lines. This adds a shield which uses an existing image from the game, but gives the new shield effects created above.
	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
	[		{
	{		"id": "daveaShield1",
	"id": "daveaShield1",		"tier": 1,
	"tier": 1,		"category": "offHand",
	"category": "offHand",		"slots": ["OFF_HAND"],
	"slots": ["OFF_HAND"],		"ownerAspects": [
	"ownerAspects": [		"daveaShield1",
	"daveaShield1",		"daveaShieldArmorBonus",
	"daveaShieldArmorBonus",		"daveaShieldBlockBonus"
	"daveaShieldBlockBonus"		],
	],		"cost": ["1 ingot", "2 heartwood"],
	"cost": ["1 ingot", "2 heartwood"],		"layers": [
	"layers": [		{"name": "augment_shieldCaveA_tint1", "depth": 6100, "tint": "primary", "tintAmount": 1.0},
	{"name": "augment_shieldCaveA_tint1", "depth": 6100, "tint": "primary", "tintAmount": 1.0},		{"name": "augment_shieldCaveB_untinted", "depth": 6101}
	{"name": "augment_shieldCaveB_untinted", "depth": 6101}		]
	]		}
	}
	]
	</syntaxhighlight>		</syntaxhighlight>
	<li>Add the name and blurb for the item. Copy and modify file text\dynamic\dynamic.properties. Delete all the text and add these lines:		<li>Add the name and blurb for the item. Copy and modify file text\dynamic\dynamic.properties. Delete all the text and add these lines:

Croald at 05:09, 5 December 2019

2019-12-05T05:09:09Z

← Older revision		Revision as of 05:09, 5 December 2019
Line 106:		Line 106:

	[[Category:Modding]]		[[Category:Modding]]
	[[Category:Modding ~~Guide~~]]		[[Category:Modding Guides]]

Croald at 05:06, 5 December 2019

2019-12-05T05:06:50Z

← Older revision		Revision as of 05:06, 5 December 2019
Line 104:		Line 104:
	</ol>		</ol>
	[[File:ModdingItemYellowSword.PNG]]		[[File:ModdingItemYellowSword.PNG]]

			[[Category:Modding]]
			[[Category:Modding Guide]]

Davea at 22:18, 30 November 2019

2019-11-30T22:18:19Z

← Older revision		Revision as of 22:18, 30 November 2019
Line 1:		Line 1:
	This page ~~is a work in progress. It will walk~~ through the process of adding a new item, a shield. The focus is on getting something simple which you can see in the game, and adding more details later. The description and screenshots are current as of November 2019, early access version 0.10+98 Ryvio Wartmarch.		This page walks through the process of adding a new item, a shield. The focus is on getting something simple which you can see in the game, and adding more details later. The description and screenshots are current as of November 2019, early access version 0.10+98 Ryvio Wartmarch.

	==Getting started==		==Getting started==

Davea at 21:30, 30 November 2019

2019-11-30T21:30:27Z

← Older revision		Revision as of 21:30, 30 November 2019
Line 70:		Line 70:
	<ol>		<ol>
	<li>Now let's add a sword with a custom image. Copy and modify file figures\images\human\items\item_sword_night.png using your favorite photo editor. For example, I made a yellow version and named it item_sword_davea1.png.		<li>Now let's add a sword with a custom image. Copy and modify file figures\images\human\items\item_sword_night.png using your favorite photo editor. For example, I made a yellow version and named it item_sword_davea1.png.
	<li>Add the following to your existing offHand.json. This is a copy of the definition of the nightshard sword with my image replaced. I don't know what the ~~grasp~~, etc fields mean but I suppose they relate the geometry of the sword to the geometry of the character's hand. The filename offHand.json doesn't matter, the game reads all the json files in your directory. It could be called "davea.json".		<li>Add the following to your existing offHand.json. This is a copy of the definition of the nightshard sword with my image replaced. I don't know what the grip, etc fields mean but I suppose they relate the geometry of the sword to the geometry of the character's hand. The filename offHand.json doesn't matter, the game reads all the json files in your directory. It could be called "davea.json".
	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
	{		{

Davea at 21:29, 30 November 2019

2019-11-30T21:29:40Z

← Older revision		Revision as of 21:29, 30 November 2019
Line 97:		Line 97:
	<li>Proper json syntax is important. If you have put this into the same file as the previous definition of the shield, you will need a comma in between the definitions, but no comma after the last definition. This is easier if you are using a text editor with language highlighting. I have not yet experimented with files having incorrect syntax, but it will probably result in the mod failing to load, possibly preventing the game from even starting.		<li>Proper json syntax is important. If you have put this into the same file as the previous definition of the shield, you will need a comma in between the definitions, but no comma after the last definition. This is easier if you are using a text editor with language highlighting. I have not yet experimented with files having incorrect syntax, but it will probably result in the mod failing to load, possibly preventing the game from even starting.
	<li>Add the name text into your existing file text\dynamic\dynamic.properties:		<li>Add the name text into your existing file text\dynamic\dynamic.properties:
	<code>		<br><code>
	~~<br>~~item.daveaSword1=Davea's sword name		item.daveaSword1=Davea's sword name
	<br>itemSummary.daveaSword1=Davea's sword summary		<br>itemSummary.daveaSword1=Davea's sword summary
	</code>		</code>
	<li>Test in-game as shown above.		<li>Test in-game as shown above.
			</ol>
	[[File:ModdingItemYellowSword.PNG]]		[[File:ModdingItemYellowSword.PNG]]

Davea at 21:28, 30 November 2019

2019-11-30T21:28:36Z

← Older revision		Revision as of 21:28, 30 November 2019
Line 99:		Line 99:
	<code>		<code>
	<br>item.daveaSword1=Davea's sword name		<br>item.daveaSword1=Davea's sword name
	>br>itemSummary.daveaSword1=Davea's sword summary		<br>itemSummary.daveaSword1=Davea's sword summary
	</code>		</code>
	<li>Test in-game as shown above.		<li>Test in-game as shown above.
	[[File:ModdingItemYellowSword.PNG]]		[[File:ModdingItemYellowSword.PNG]]

Davea at 21:27, 30 November 2019

2019-11-30T21:27:51Z

← Older revision		Revision as of 21:27, 30 November 2019
Line 98:		Line 98:
	<li>Add the name text into your existing file text\dynamic\dynamic.properties:		<li>Add the name text into your existing file text\dynamic\dynamic.properties:
	<code>		<code>
	item.daveaSword1=Davea's sword name		<br>item.daveaSword1=Davea's sword name
	itemSummary.daveaSword1=Davea's sword summary		>br>itemSummary.daveaSword1=Davea's sword summary
	</code>		</code>
	<li>Test in-game as shown above.		<li>Test in-game as shown above.
	[[File:ModdingItemYellowSword.PNG]]		[[File:ModdingItemYellowSword.PNG]]

Davea at 21:20, 30 November 2019

2019-11-30T21:20:44Z

← Older revision		Revision as of 21:20, 30 November 2019
Line 66:		Line 66:
	# Pick one of your characters, open the detail view, and click the gear tab. You will see a cheat menu that allows you to select any kind of item and add it. Select offhand, select your new item in the popup, and clock add item to add it. You will see the name at the top and the summary at the right. Try it out in combat!		# Pick one of your characters, open the detail view, and click the gear tab. You will see a cheat menu that allows you to select any kind of item and add it. Select offhand, select your new item in the popup, and clock add item to add it. You will see the name at the top and the summary at the right. Try it out in combat!
	[[File:ModdingItemPickMe.PNG]]		[[File:ModdingItemPickMe.PNG]]

			==Adding a user created image==
			<ol>
			<li>Now let's add a sword with a custom image. Copy and modify file figures\images\human\items\item_sword_night.png using your favorite photo editor. For example, I made a yellow version and named it item_sword_davea1.png.
			<li>Add the following to your existing offHand.json. This is a copy of the definition of the nightshard sword with my image replaced. I don't know what the grasp, etc fields mean but I suppose they relate the geometry of the sword to the geometry of the character's hand. The filename offHand.json doesn't matter, the game reads all the json files in your directory. It could be called "davea.json".
			<syntaxhighlight lang="json">
			{
			"id": "daveaSword1",
			"tier": 1,
			"category": "sword",
			"tracks": ["medium"],
			"slots": ["MAIN_HAND"],
			"aspects": ["weapon", "melee", "weaponDamage:7", "weaponWield:3", "weaponMaxRange:1.6", "swordAccuracyBonus\|5"],
			"ownerAspects": ["attackRange\|0\|1.6\|melee", "weaponAttack_basicMelee", "voiceSword", "swordBlockBonus\|10"],
			"layers": [
			{
			"name": "item_sword_davea1",
			"grip": "mainHand",
			"inactiveGrip": "highBack",
			"rigUsage": "rigGeneral",
			"gripOffset": {"x": 57, "y": 147},
			"scaleX": 0.5, "scaleY": 0.5
			}
			],
			"canBeCrafted": false,
			"generateName": false,
			"onlySpawnById": true
			}
			</syntaxhighlight>
			<li>Proper json syntax is important. If you have put this into the same file as the previous definition of the shield, you will need a comma in between the definitions, but no comma after the last definition. This is easier if you are using a text editor with language highlighting. I have not yet experimented with files having incorrect syntax, but it will probably result in the mod failing to load, possibly preventing the game from even starting.
			<li>Add the name text into your existing file text\dynamic\dynamic.properties:
			<code>
			item.daveaSword1=Davea's sword name
			itemSummary.daveaSword1=Davea's sword summary
			</code>
			<li>Test in-game as shown above.
			[[File:ModdingItemYellowSword.PNG]]