GUI Category Modding Guide/0.5 - Revision history

CptTwinkie at 20:18, 18 July 2022

2022-07-18T20:18:05Z

← Older revision		Revision as of 20:18, 18 July 2022
Line 26:		Line 26:
	# Save the file in our mod's Data folder as ExampleMod_GUICategory.sbc. The extension is mandatory, but the name is not. Prepending the name of the mod on the file name can also help avoid confusion with vanilla files.		# Save the file in our mod's Data folder as ExampleMod_GUICategory.sbc. The extension is mandatory, but the name is not. Prepending the name of the mod on the file name can also help avoid confusion with vanilla files.

	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false" line>
	<?xml version="1.0" encoding="utf-8"?>		<?xml version="1.0" encoding="utf-8"?>
	<Definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">		<Definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
Line 47:		Line 47:
	</CategoryClasses>		</CategoryClasses>
	</Definitions>		</Definitions>
	</~~source~~>		</syntaxhighlight>


Line 57:		Line 57:
	== Explanation ==		== Explanation ==
	* The XML prolog. Don't mess with it.		* The XML prolog. Don't mess with it.
	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false">
	<?xml version="1.0" encoding="utf-8"?>		<?xml version="1.0" encoding="utf-8"?>
	</~~source~~>		</syntaxhighlight>
	<br>		<br>
	* Opens (<>) and closes (</>) our definitions. A file can have multiple ''GuiBlockCategoryDefinitions'' in it, but all of them must be inside these tags.		* Opens (<>) and closes (</>) our definitions. A file can have multiple ''GuiBlockCategoryDefinitions'' in it, but all of them must be inside these tags.
	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false">
	<Definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">		<Definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<CategoryClasses>		<CategoryClasses>
	</CategoryClasses>		</CategoryClasses>
	</Definitions>		</Definitions>
	</~~source~~>		</syntaxhighlight>
	<br>		<br>
	* Tells the game we want to create a GUI Category, hence type ''GuiBlockCategoryDefinition''.		* Tells the game we want to create a GUI Category, hence type ''GuiBlockCategoryDefinition''.
	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false">
	<Category xsi:type="MyObjectBuilder_GuiBlockCategoryDefinition">		<Category xsi:type="MyObjectBuilder_GuiBlockCategoryDefinition">
	</Category>		</Category>
	</~~source~~>		</syntaxhighlight>
	<br>		<br>
	* This is a standard definition ID. Judging by the way it's used here, it doesn't serve any purpose except to maintain compatibility with the game's definition manager. Changing anything here will break the definition. NOTE: This format is obsolete in 0.5 and will be incompatible in 0.6.		* This is a standard definition ID. Judging by the way it's used here, it doesn't serve any purpose except to maintain compatibility with the game's definition manager. Changing anything here will break the definition. NOTE: This format is obsolete in 0.5 and will be incompatible in 0.6.
	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false">
	<Id>		<Id>
	<TypeId>GuiBlockCategoryDefinition</TypeId>		<TypeId>GuiBlockCategoryDefinition</TypeId>
	<SubtypeId/>		<SubtypeId/>
	</Id>		</Id>
	</~~source~~>		</syntaxhighlight>
	<br>		<br>
	* This is the name of the category that gets displayed in the toolbar configuration screen.		* This is the name of the category that gets displayed in the toolbar configuration screen.
	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false">
	<DisplayName>Stockpiles</DisplayName>		<DisplayName>Stockpiles</DisplayName>
	</~~source~~>		</syntaxhighlight>
	<br>		<br>
	* This must be a unique name. It can be used programmatically to identify the category.		* This must be a unique name. It can be used programmatically to identify the category.
	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false">
	<Name>Stockpiles</Name>		<Name>Stockpiles</Name>
	</~~source~~>		</syntaxhighlight>
	<br>		<br>
	* This is the icon that will appear next to the category's name in the G-Sceen. The path is relative to you mod's root folder. If the file does not exist there, it will fallback to the ''Content'' folder in the game's files. This means you can use files from the game without copying them to your mod's folder.		* This is the icon that will appear next to the category's name in the G-Sceen. The path is relative to you mod's root folder. If the file does not exist there, it will fallback to the ''Content'' folder in the game's files. This means you can use files from the game without copying them to your mod's folder.
	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false">
	<Icon>Textures\GUI\Icons\Props\StockpileLogSmall.dds</Icon>		<Icon>Textures\GUI\Icons\Props\StockpileLogSmall.dds</Icon>
	</~~source~~>		</syntaxhighlight>
	<br>		<br>
	* Whether this category should show up in Survival mode.		* Whether this category should show up in Survival mode.
	* There is a similar tag for Creative mode. It's <ShowInCreative>. Defaults to true.		* There is a similar tag for Creative mode. It's <ShowInCreative>. Defaults to true.
	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false">
	<AvailableInSurvival>false</AvailableInSurvival>		<AvailableInSurvival>false</AvailableInSurvival>
	</~~source~~>		</syntaxhighlight>
	<br>		<br>
	* These are the items that will appear under this category.		* These are the items that will appear under this category.
	* The strings format is '''TypeId'''/'''SubtypeId''' (Note the "/" between them)		* The strings format is '''TypeId'''/'''SubtypeId''' (Note the "/" between them)
	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false">
	<ItemIds>		<ItemIds>
	<string>CubeBlock/StockpileTimber</string>		<string>CubeBlock/StockpileTimber</string>
Line 112:		Line 112:
	<string>CubeBlock/StockpileStone</string>		<string>CubeBlock/StockpileStone</string>
	</ItemIds>		</ItemIds>
	</~~source~~>		</syntaxhighlight>

CptTwinkie at 15:14, 4 June 2018

2018-06-04T15:14:47Z

← Older revision		Revision as of 15:14, 4 June 2018
Line 1:		Line 1:
			{{SEO\|description=This guide shows you how to add custom GUI categories into Medieval Engineers. These are the categories that appear to the left of the blocks' list in the G-Screen and are especially useful to organize all of a mod's items in one place. We'll be making an example mod in which the large stockpile blocks will be located under the Stockpile category.}}
	This guide shows you how to add custom GUI categories into Medieval Engineers. These are the categories that appear to the left of the blocks' list in the G-Screen and are especially useful to organize all of a mod's items in one place. We'll be making an example mod in which the large stockpile blocks will be located under the Stockpile category.		This guide shows you how to add custom GUI categories into Medieval Engineers. These are the categories that appear to the left of the blocks' list in the G-Screen and are especially useful to organize all of a mod's items in one place. We'll be making an example mod in which the large stockpile blocks will be located under the Stockpile category.
	{{Version <!-- Do not change the version until the entire page is up-to-date -->		{{Version <!-- Do not change the version until the entire page is up-to-date -->

CptTwinkie at 07:52, 25 January 2018

2018-01-25T07:52:42Z

← Older revision		Revision as of 07:52, 25 January 2018
Line 121:		Line 121:

	# Add the small stockpile blocks to our Stockpile category.		# Add the small stockpile blocks to our Stockpile category.


	~~[[Category:Community_Guides]]~~

CptTwinkie at 20:55, 16 January 2018

2018-01-16T20:55:08Z

← Older revision		Revision as of 20:55, 16 January 2018
Line 1:		Line 1:
	~~<small> < [[GUI Category Modding Guide]]</small>~~

	This guide shows you how to add custom GUI categories into Medieval Engineers. These are the categories that appear to the left of the blocks' list in the G-Screen and are especially useful to organize all of a mod's items in one place. We'll be making an example mod in which the large stockpile blocks will be located under the Stockpile category.		This guide shows you how to add custom GUI categories into Medieval Engineers. These are the categories that appear to the left of the blocks' list in the G-Screen and are especially useful to organize all of a mod's items in one place. We'll be making an example mod in which the large stockpile blocks will be located under the Stockpile category.
	{{Version <!-- Do not change the version until the entire page is up-to-date -->		{{Version <!-- Do not change the version until the entire page is up-to-date -->

CptTwinkie at 20:51, 16 January 2018

2018-01-16T20:51:51Z

← Older revision		Revision as of 20:51, 16 January 2018
Line 1:		Line 1:
			<small> < [[GUI Category Modding Guide]]</small>

	This guide shows you how to add custom GUI categories into Medieval Engineers. These are the categories that appear to the left of the blocks' list in the G-Screen and are especially useful to organize all of a mod's items in one place. We'll be making an example mod in which the large stockpile blocks will be located under the Stockpile category.		This guide shows you how to add custom GUI categories into Medieval Engineers. These are the categories that appear to the left of the blocks' list in the G-Screen and are especially useful to organize all of a mod's items in one place. We'll be making an example mod in which the large stockpile blocks will be located under the Stockpile category.
	{{Version <!-- Do not change the version until the entire page is up-to-date -->		{{Version <!-- Do not change the version until the entire page is up-to-date -->

CptTwinkie: CptTwinkie moved page GUI Category Modding Guide to GUI Category Modding Guide/0.5 without leaving a redirect

2018-01-03T18:39:40Z

CptTwinkie moved page GUI Category Modding Guide to GUI Category Modding Guide/0.5 without leaving a redirect

← Older revision		Revision as of 18:39, 3 January 2018
(No difference)

CptTwinkie at 18:39, 3 January 2018

2018-01-03T18:39:30Z

← Older revision		Revision as of 18:39, 3 January 2018
Line 1:		Line 1:
	~~{{TextBoxRed\|This guide is obsolete as of version 0.6 due to categories being removed from the game.}}~~
	This guide shows you how to add custom GUI categories into Medieval Engineers. These are the categories that appear to the left of the blocks' list in the G-Screen and are especially useful to organize all of a mod's items in one place. We'll be making an example mod in which the large stockpile blocks will be located under the Stockpile category.		This guide shows you how to add custom GUI categories into Medieval Engineers. These are the categories that appear to the left of the blocks' list in the G-Screen and are especially useful to organize all of a mod's items in one place. We'll be making an example mod in which the large stockpile blocks will be located under the Stockpile category.
	{{Version <!-- Do not change the version until the entire page is up-to-date -->		{{Version <!-- Do not change the version until the entire page is up-to-date -->

CptTwinkie at 17:08, 30 December 2017

2017-12-30T17:08:01Z

← Older revision		Revision as of 17:08, 30 December 2017
Line 124:		Line 124:


	[[Category:~~Community_Modding_Guides~~]]		[[Category:Community_Guides]]

CptTwinkie at 17:53, 27 December 2017

2017-12-27T17:53:25Z

← Older revision		Revision as of 17:53, 27 December 2017
Line 2:		Line 2:
	This guide shows you how to add custom GUI categories into Medieval Engineers. These are the categories that appear to the left of the blocks' list in the G-Screen and are especially useful to organize all of a mod's items in one place. We'll be making an example mod in which the large stockpile blocks will be located under the Stockpile category.		This guide shows you how to add custom GUI categories into Medieval Engineers. These are the categories that appear to the left of the blocks' list in the G-Screen and are especially useful to organize all of a mod's items in one place. We'll be making an example mod in which the large stockpile blocks will be located under the Stockpile category.
	{{Version <!-- Do not change the version until the entire page is up-to-date -->		{{Version <!-- Do not change the version until the entire page is up-to-date -->
	\|release=0		\|release=0\|major=5\|minor=X\|suppress=true}}
	\|major=5
	}}

	== Tools Used ==		== Tools Used ==

CptTwinkie at 17:40, 27 December 2017

2017-12-27T17:40:57Z

← Older revision		Revision as of 17:40, 27 December 2017
Line 1:		Line 1:
			{{TextBoxRed\|This guide is obsolete as of version 0.6 due to categories being removed from the game.}}
	This guide shows you how to add custom GUI categories into Medieval Engineers. These are the categories that appear to the left of the blocks' list in the G-Screen and are especially useful to organize all of a mod's items in one place. We'll be making an example mod in which the large stockpile blocks will be located under the Stockpile category.		This guide shows you how to add custom GUI categories into Medieval Engineers. These are the categories that appear to the left of the blocks' list in the G-Screen and are especially useful to organize all of a mod's items in one place. We'll be making an example mod in which the large stockpile blocks will be located under the Stockpile category.
	{{Version <!-- Do not change the version until the entire page is up-to-date -->		{{Version <!-- Do not change the version until the entire page is up-to-date -->