Patches - Revision history

MarkGrant at 04:40, 17 December 2020

2020-12-17T04:40:47Z

MarkGrant: /* Creating a Patch */

2020-11-03T20:08:13Z

‎Creating a Patch

MarkGrant: patchIfFilesDontExist

2020-11-03T20:06:09Z

patchIfFilesDontExist

MarkGrant: /* Creating a Patch */

2020-11-03T19:21:48Z

‎Creating a Patch

MarkGrant: /* "fileCheck" */

2020-11-03T19:19:44Z

‎"fileCheck"

Toketsupuurin: /* Caveats, Warnings and Troubleshooting */

2020-08-27T22:39:49Z

‎Caveats, Warnings and Troubleshooting

Toketsupuurin: /* Creating a Patch */

2020-08-27T22:36:21Z

‎Creating a Patch

MarkGrant: /* "patch" */

2020-08-27T19:32:08Z

‎"patch"

MarkGrant: /* "patch" */

2020-08-27T18:59:30Z

‎"patch"

MarkGrant at 18:58, 27 August 2020

2020-08-27T18:58:51Z

← Older revision		Revision as of 04:40, 17 December 2020
Line 40:		Line 40:

	= Caveats, Warnings and Troubleshooting=		= Caveats, Warnings and Troubleshooting=
−
−	~~You CAN NOT patch a file if there is a space in the file name. So "mods/Basic Staples/plant.item" can't be patched but "mods/Basic-Staples/plant.item" can be. DON'T USE SPACES IN YOUR FILE NAMES.~~

	Not every file can be patched.		Not every file can be patched.

@@ Line 37: / Line 37: @@
 </pre>
-This is a fairly straight forward patch. It is used to change the pricing component of Ice Cream. Feel free to edit these values however you want.
+This is a fairly straight forward patch. It is used to change the pricing component and categories of a Broom. Feel free to edit these values however you want.
-−
-−
-The first property, "file", is the string that contains the file path to the file you want to patch.
-−
-The second property, "priority", is used to determine the priority of multiple patches of the same file.
-−
-The next property, "mergeList", is self explanatory. It determines whether you wish to merge your patch with existing lists or to completely override the list.
-−
-The final property, "patch", is the important section. This is where you place the [[Modding_Key_Terms#Blob|Blobs]] you want to patch.
 = Caveats, Warnings and Troubleshooting=

← Older revision		Revision as of 20:06, 3 November 2020
Line 79:		Line 79:

	This is the order in which to apply the patch. The patch with higher priority will display over the top of the patch with lower priority.		This is the order in which to apply the patch. The patch with higher priority will display over the top of the patch with lower priority.
		+
		+
		+	== "patchIfFilesExists" ==
		+	'''Valid options ([[Modding_Key_Terms#List\|List]] of [[Modding_Key_Terms#String\|String]]): <code>A list of valid strings.</code>'''
		+
		+	'''Default Value:''' If not specified, will not have any list entries and will be ignored.
		+
		+
		+	This is a list of strings containing a path to files. If all the strings lead to valid files than the patch will succeed. Otherwise it will be ignored.
		+
		+
		+	== "patchIfFilesDontExist" ==
		+	'''Valid options ([[Modding_Key_Terms#List\|List]] of [[Modding_Key_Terms#String\|String]]): <code>A list of valid strings.</code>'''
		+
		+	'''Default Value:''' If not specified, will not have any list entries and will be ignored.
		+
		+
		+	This is a list of strings containing a path to files. If any the strings lead to valid files than the patch will be ignored. Otherwise it will succeed.
		+

	== "mergeLists" ==		== "mergeLists" ==

@@ Line 9: / Line 9: @@
 <pre>
+{
- "file": "staxel/item/complete/IceCream.item",
+    "file": "staxel/item/Broom.item", //Case sensitive
- "priority": 2,
+    "patchIfFilesExists": [
- "mergeLists": false,
+        "staxel/item/ore/Ore1.item",
- "patch" : {
+        "staxel/item/ore/Ore2.item",
- "pricing": {
+        "staxel/item/ore/Ore23.item" //This should fail and avoid the patch being made as there is no Ore23
-   "catalogueUnlockedFromStart": false,
+    ],
-   "buyable": true,
+    "patchIfFilesDontExist": [ //This should succeed as there is no Ore 23 or Ore 33
-   "sellPrice": 1008,
+        "staxel/item/ore/Ore23.item",
-   "value": 1680
+        "staxel/item/ore/Ore33.item"
+    ],
+    "priority": 5, //Higher priority leads to this patch being applied later than others.
+}
 </pre>

@@ Line 78: / Line 78: @@
 '''Default Value:''' If not specified, will default to True.
-This value specifies whether or not to check if the <code>"file"</code> exists. Currently this doesn't seem to work and can be omitted.
+This value specifies whether or not to check if the <code>"file"</code> exists. ''Currently this doesn't seem to work and can be omitted.''
-−
 == "patch" ==

← Older revision		Revision as of 22:39, 27 August 2020
Line 47:		Line 47:

	Two patches set to the same level WILL conflict so try to give your patch priority numbers some buffer room that other modders can work around.		Two patches set to the same level WILL conflict so try to give your patch priority numbers some buffer room that other modders can work around.
		+
		+	If your patch doesn't seem to be working make sure you set the file path correctly, use content builder (not mod manager) to build your content for more detailed information about the build process, and check your staxel log files in Staxel/bin/crashlogs/ one of the files might tell you something about why a patch is tossing up problems.

	= Config Options =		= Config Options =

← Older revision		Revision as of 22:36, 27 August 2020
Line 34:		Line 34:
	The final property, "patch", is the important section. This is where you place the [[Modding_Key_Terms#Blob\|Blobs]] you want to patch.		The final property, "patch", is the important section. This is where you place the [[Modding_Key_Terms#Blob\|Blobs]] you want to patch.

		+	= Caveats, Warnings and Troubleshooting=
		+
		+	You CAN NOT patch a file if there is a space in the file name. So "mods/Basic Staples/plant.item" can't be patched but "mods/Basic-Staples/plant.item" can be. DON'T USE SPACES IN YOUR FILE NAMES.
		+
		+	Not every file can be patched.
		+
		+	Some files can only be partially patched (Meaning that certain keys can't be edited by patching while others can. Changing the .QB file for a TileObject for instance can't be done, but you can change that object's sell value. You can't change the "code" entry at all.)
		+
		+	Some keys can't be merged and you'll simply have to replace the entire contents of that key (Auto Tiles aren't partially patchable.)
		+
		+	Generally you should avoid using the patch system to try to remove something entirely. You can't remove a key that has already been set, and removing something from a list will require re-writing the list entirely while merging is off. If you ARE trying to remove something please give your patch a low priority so other people's patches can be set higher to override it if they need to.
		+
		+	Two patches set to the same level WILL conflict so try to give your patch priority numbers some buffer room that other modders can work around.

	= Config Options =		= Config Options =

← Older revision		Revision as of 19:32, 27 August 2020
Line 71:		Line 71:
	'''Default Value:''' No default value is specified. Always need to provide your own.		'''Default Value:''' No default value is specified. Always need to provide your own.

−	This is the main part of the <code>".patch"</code> file. This blob contains all the components, lists and properties you wish to patch.	+	This is the main part of the <code>.patch</code> file. This blob contains all the components, lists and properties you wish to patch.

← Older revision		Revision as of 18:59, 27 August 2020
Line 71:		Line 71:
	'''Default Value:''' No default value is specified. Always need to provide your own.		'''Default Value:''' No default value is specified. Always need to provide your own.

−	This is the main ~~component~~ of the <code>".patch"</code> file. This blob contains all the components, lists and properties you wish to patch.	+	This is the main part of the <code>".patch"</code> file. This blob contains all the components, lists and properties you wish to patch.

@@ Line 5: / Line 5: @@
 = Creating a Patch =
-'''While not as necessary for patches, make sure to follow [[Modding#Getting Started with Staxel Modding]] first. Once this is done, create a file with an ending of '''<tt>.patch</tt>''', and place the following into it.
+'''While not as necessary for patches, make sure to follow [[Modding#Getting Started with Staxel Modding]] first. Once this is done, create a file with an ending of <tt>.patch</tt>, and place the following into it.'''
 <pre>
@@ Line 32: / Line 32: @@
 The next property, "mergeList", is self explanatory. It determines whether you wish to merge your patch with existing lists or to completely override the list.
-The final property, "patch", is the important section. This is where you place the ([[Modding_Key_Terms#Blob|Blobs]]) you want to patch.
+The final property, "patch", is the important section. This is where you place the [[Modding_Key_Terms#Blob|Blobs]] you want to patch.