Keen:Planet Modding/Compass - Revision history

CptTwinkie at 20:23, 18 July 2022

2022-07-18T20:23:51Z

← Older revision		Revision as of 20:23, 18 July 2022
Line 14:		Line 14:
	Example texture coordinates for top part of the compass:		Example texture coordinates for top part of the compass:
	[[File:CompassTextureCoordinates.png\|1024px\|center]]		[[File:CompassTextureCoordinates.png\|1024px\|center]]
	<~~source~~ lang="xml"><TopCrop X="0" Y="0" Width="512" Height="32"/></~~source~~>		<syntaxhighlight lang="xml"><TopCrop X="0" Y="0" Width="512" Height="32"/></syntaxhighlight>


	===Explanation of compass definition line by line===		===Explanation of compass definition line by line===
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Texture>Textures/GUI/Compass/compass.png</Texture><!-- Path to a texture atlas. -->		<Texture>Textures/GUI/Compass/compass.png</Texture><!-- Path to a texture atlas. -->
	<KingdomIcon>Textures/GUI/Compass/Icon-Kingdom.png</KingdomIcon><!-- Path to icon symbolizing a kingdom. -->		<KingdomIcon>Textures/GUI/Compass/Icon-Kingdom.png</KingdomIcon><!-- Path to icon symbolizing a kingdom. -->
Line 39:		Line 39:
	<TagStyle Tag="Kingdom" Style="Bellow"/>		<TagStyle Tag="Kingdom" Style="Bellow"/>
	</TagStyles>		</TagStyles>
	</~~source~~>		</syntaxhighlight>


	===Explanation of Waypoint/Tag definition===		===Explanation of Waypoint/Tag definition===
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_WaypointDefinition">		<Definition xsi:type="MyObjectBuilder_WaypointDefinition">
	<Id Type="MyObjectBuilder_WaypointDefinition" Subtype="Kingdom"/>		<Id Type="MyObjectBuilder_WaypointDefinition" Subtype="Kingdom"/>
Line 49:		Line 49:
	<Color R="255" G="255" B="255" A="255"/>		<Color R="255" G="255" B="255" A="255"/>
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>
	IconPath contains path to the texture of kingdom icon. Color defines color of the text that is shown with the icon. (Example: Fareon, [[File:Kingdom Icon.png\|frameless]])		IconPath contains path to the texture of kingdom icon. Color defines color of the text that is shown with the icon. (Example: Fareon, [[File:Kingdom Icon.png\|frameless]])

CptTwinkie at 10:53, 29 June 2018

2018-06-29T10:53:20Z

← Older revision		Revision as of 10:53, 29 June 2018
Line 1:		Line 1:
	<noinclude>{{SEO\|image_url=http://www.medievalengineerswiki.com/images/f/f8/In-gameCompassZones.png\|description=Just like with map sprites, we save main compass elements on a single texture, then define parts of it using pixel coordinates.}}		<noinclude>{{SEO\|image_url=http://www.medievalengineerswiki.com/images/f/f8/In-gameCompassZones.png\|description=Just like with map sprites, we save main compass elements on a single texture, then define parts of it using pixel coordinates.}}
	{{:~~Official Content/~~OCH}}		{{Keen:OCH}}

CptTwinkie: CptTwinkie moved page Official Content/Planet Modding/Compass to Keen:Planet Modding/Compass

2018-06-29T10:35:09Z

CptTwinkie moved page Official Content/Planet Modding/Compass to Keen:Planet Modding/Compass

← Older revision		Revision as of 10:35, 29 June 2018
(No difference)

CptTwinkie at 10:33, 29 June 2018

2018-06-29T10:33:02Z

← Older revision		Revision as of 10:33, 29 June 2018
Line 6:		Line 6:
	\|release=0\|major=4\|minor=X\|suppress=true}}		\|release=0\|major=4\|minor=X\|suppress=true}}
	[[Category:Keen Modding Guides]]</noinclude>		[[Category:Keen Modding Guides]]</noinclude>
	==[[~~Official Content/~~Planet Modding/Compass\|Compass modding]]==		==[[Keen:Planet Modding/Compass\|Compass modding]]==
	It is possible to mod visual look of an in-game compass. All definitions of compass are stored in Content\Data\GUI\CompassDefinition.sbc. Our textures for compass are in Content\Textures\GUI\Compass folder if you want to check out how they look or use them in your mod.		It is possible to mod visual look of an in-game compass. All definitions of compass are stored in Content\Data\GUI\CompassDefinition.sbc. Our textures for compass are in Content\Textures\GUI\Compass folder if you want to check out how they look or use them in your mod.

Line 65:		Line 65:


	<noinclude>View the full [[~~Official Content/~~Planet Modding - Full Guide\|Planet Modding Guide]]</noinclude>		<noinclude>View the full [[Keen:Planet Modding - Full Guide\|Planet Modding Guide]]</noinclude>

CptTwinkie at 21:38, 1 June 2018

2018-06-01T21:38:57Z

← Older revision		Revision as of 21:38, 1 June 2018
Line 1:		Line 1:
	<noinclude>{{:Official Content/OCH}}		<noinclude>{{SEO\|image_url=http://www.medievalengineerswiki.com/images/f/f8/In-gameCompassZones.png\|description=Just like with map sprites, we save main compass elements on a single texture, then define parts of it using pixel coordinates.}}
			{{:Official Content/OCH}}

CptTwinkie at 15:00, 30 May 2018

2018-05-30T15:00:07Z

← Older revision		Revision as of 15:00, 30 May 2018
Line 1:		Line 1:
	<noinclude>{{Version <!-- Do not change the version until the entire page is up-to-date -->		<noinclude>{{:Official Content/OCH}}


			{{Version <!-- Do not change the version until the entire page is up-to-date -->
	\|release=0\|major=4\|minor=X\|suppress=true}}		\|release=0\|major=4\|minor=X\|suppress=true}}
	[[Category:Keen Modding Guides]]</noinclude>		[[Category:Keen Modding Guides]]</noinclude>

CptTwinkie at 20:12, 12 April 2018

2018-04-12T20:12:27Z

← Older revision		Revision as of 20:12, 12 April 2018
Line 59:		Line 59:

	<center><NoWiki>*</NoWiki>note that background crop and bottom crop are not used in vanilla (empty opaque texture)</center>		<center><NoWiki>*</NoWiki>note that background crop and bottom crop are not used in vanilla (empty opaque texture)</center>


			<noinclude>View the full [[Official Content/Planet Modding - Full Guide\|Planet Modding Guide]]</noinclude>

CptTwinkie at 20:08, 12 April 2018

2018-04-12T20:08:49Z

← Older revision		Revision as of 20:08, 12 April 2018
Line 2:		Line 2:
	\|release=0\|major=4\|minor=X\|suppress=true}}		\|release=0\|major=4\|minor=X\|suppress=true}}
	[[Category:Keen Modding Guides]]</noinclude>		[[Category:Keen Modding Guides]]</noinclude>
	==Compass modding==		==[[Official Content/Planet Modding/Compass\|Compass modding]]==
	It is possible to mod visual look of an in-game compass. All definitions of compass are stored in Content\Data\GUI\CompassDefinition.sbc. Our textures for compass are in Content\Textures\GUI\Compass folder if you want to check out how they look or use them in your mod.		It is possible to mod visual look of an in-game compass. All definitions of compass are stored in Content\Data\GUI\CompassDefinition.sbc. Our textures for compass are in Content\Textures\GUI\Compass folder if you want to check out how they look or use them in your mod.

CptTwinkie: Protected "Official Content/Planet Modding/Compass" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2018-04-12T20:06:43Z

Protected "Official Content/Planet Modding/Compass" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 20:06, 12 April 2018
(No difference)

CptTwinkie at 19:44, 12 April 2018

2018-04-12T19:44:48Z

← Older revision		Revision as of 19:44, 12 April 2018
Line 1:		Line 1:
	{{Version <!-- Do not change the version until the entire page is up-to-date -->		<noinclude>{{Version <!-- Do not change the version until the entire page is up-to-date -->
	\|release=0\|major=5\|minor=X\|suppress=true}}		\|release=0\|major=4\|minor=X\|suppress=true}}
	==Compass modding ~~introduction~~==		[[Category:Keen Modding Guides]]</noinclude>
			==Compass modding==
	It is possible to mod visual look of an in-game compass. All definitions of compass are stored in Content\Data\GUI\CompassDefinition.sbc. Our textures for compass are in Content\Textures\GUI\Compass folder if you want to check out how they look or use them in your mod.		It is possible to mod visual look of an in-game compass. All definitions of compass are stored in Content\Data\GUI\CompassDefinition.sbc. Our textures for compass are in Content\Textures\GUI\Compass folder if you want to check out how they look or use them in your mod.


	===Creating compass texture atlas and setting coordinates for its elements===		===Creating compass texture atlas and setting coordinates for its elements===
	Just like with map sprites, we save main compass elements on a single texture, then define parts of it using pixel coordinates. First setup origin point, then add width and height of the rectangle		Just like with map sprites, we save main compass elements on a single texture, then define parts of it using pixel coordinates. First setup origin point, then add width and height of the rectangle
	Example texture coordinates for top part of the compass:~~<br/>~~		Example texture coordinates for top part of the compass:
	[[File:CompassTextureCoordinates.png\|1024px\|center]]		[[File:CompassTextureCoordinates.png\|1024px\|center]]
	<~~pre~~><TopCrop X="0" Y="0" Width="512" Height="32"/></~~pre~~>		<source lang="xml"><TopCrop X="0" Y="0" Width="512" Height="32"/></source>


	==Explanation of compass ~~definitions~~ line by line==		===Explanation of compass definition line by line===
	<~~pre style~~="~~margin-bottom:0;~~"><Texture>Textures/GUI/Compass/compass.png</Texture> <~~/pre>~~		<source lang="xml">
	Path to a texture atlas.		<Texture>Textures/GUI/Compass/compass.png</Texture><!-- Path to a texture atlas. -->
	~~<pre style="margin~~-~~bottom:0;margin~~-~~top:28px;"~~><KingdomIcon>Textures/GUI/Compass/Icon-Kingdom.png</KingdomIcon> <~~/pre>~~		<KingdomIcon>Textures/GUI/Compass/Icon-Kingdom.png</KingdomIcon><!-- Path to icon symbolizing a kingdom. -->
	Path to icon symbolizing a kingdom.		<Padding>7</Padding><!-- Padding is added vertically between the top and bottom textures and the edges of the contents of the compass. -->
	~~<pre style="margin~~-~~bottom:0;margin~~-~~top:28px;"~~><Padding>7</Padding><~~/pre>~~		<TopCrop X="0" Y="0" Width="512" Height="32"/><!-- Rectangle in the texture that contains the top part. -->
	Padding is added vertically between the top and bottom textures and the edges of the contents of the compass.		<BottomCrop X="0" Y="0" Width="0" Height="0"/><!-- Rectangle in the texture that contains the bottom part. -->
	~~<pre style="margin~~-~~bottom:0;margin~~-~~top:28px;"~~><TopCrop X="0" Y="0" Width="512" Height="32"/><~~/pre>~~		<BackgroundCrop X="0" Y="64" Width="512" Height="64"/><!-- Rectangle in the texture that contains the background. -->
	Rectangle in the texture that contains the top part.		<ArrowCrop X="0" Y="128" Width="32" Height="32"/><!-- Rectangle in the texture that contains the little marker used for elements that are drawn and have no icon. -->
	~~<pre style="margin~~-~~bottom:0;margin~~-~~top:28px;"~~><BottomCrop X="0" Y="0" Width="0" Height="0"/><~~/pre>~~		<MarkerCrop X="32" Y="128" Width="32" Height="32"/><!-- Rectangle in the texture that contains the interval bars drawn every few degrees. -->
	Rectangle in the texture that contains the bottom part.		<ShadowCrop X="64" Y="128" Width="80" Height="32" Left="8" Right="8"/>
	~~<pre style="margin~~-~~bottom:0;margin~~-~~top:28px;"~~><BackgroundCrop X="0" Y="64" Width="512" Height="64"/><~~/pre>~~		<ShadowPadding Left="12" Top="8" Right="12" Bottom="8"/><!-- Rectangle in the texture that contains the text shadows. Shadow is 3-Sliced, meaning the texture is split in three parts: [left\|middle\|right]
	Rectangle in the texture that contains the background.		The sizes of left and right define the cropping lines that split the texture into three. The Sides are then always kep proportional as the texture is scaled. -->
	~~<pre style="margin~~-~~bottom:0;margin~~-~~top:28px;"~~><ArrowCrop X="0" Y="128" Width="32" Height="32"/><~~/pre>~~		<VisibleRange>200</VisibleRange><!-- Visible range in degrees. -->
	Rectangle in the texture that contains the little marker used for elements that are drawn and have no icon.		<Width>700</Width><!-- Width in reference resolution pixels. -->
	~~<pre style="margin~~-~~bottom:0;margin~~-~~top:28px;"~~><MarkerCrop X="32" Y="128" Width="32" Height="32"/><~~/pre>~~		<FontSize>1.1</FontSize><!-- Scale of the font based on default. -->
	Rectangle in the texture that contains the interval bars drawn every few degrees.		<VerticalOffset>0.065</VerticalOffset><!-- Vertical offset from the top of the screen. 0 = top of the screen, 1 is the bottom. Compass is centered around this position. -->
	~~<pre style="margin~~-~~bottom:0;margin~~-~~top:28px;"~~><ShadowCrop X="64" Y="128" Width="80" Height="32" Left="8" Right="8"/~~></pre~~>		<TagStyles><!-- This section adds tags that are visible on compass and in which style. Currently we have 3 types of tags. Claim area - shows your claimed area on the compass, Kingdom tag shows kingdoms and Cardinal tag shows cardinal points (North, South,...). Each tag’s visual appearance is defined in tag/waypoint definition. Styles defines where should the text appear. Available styles: Center, IconOnly, NotShown, Bellow, Above. -->
	~~<pre style="margin-bottom:0;margin-top:28px;">~~<ShadowPadding Left="12" Top="8" Right="12" Bottom="8"/><~~/pre>~~
	Rectangle in the texture that contains the text shadows. Shadow is 3-Sliced, meaning the texture is split in three parts: [left\|middle\|right]
	The sizes of left and right define the cropping lines that split the texture into three. The Sides are then always kep proportional as the texture is scaled.
	~~<pre style="margin~~-~~bottom:0;margin~~-~~top:28px;"~~><VisibleRange>200</VisibleRange><~~/pre>~~
	Visible range in degrees.
	~~<pre style="margin~~-~~bottom:0;margin~~-~~top:28px;"~~><Width>700</Width><~~/pre>~~
	Width in reference resolution pixels.
	~~<pre style="margin~~-~~bottom:0;margin~~-~~top:28px;"~~><FontSize>1.1</FontSize><~~/pre>~~
	Scale of the font based on default.
	~~<pre style="margin~~-~~bottom:0;margin~~-~~top:28px;"~~><VerticalOffset>0.065</VerticalOffset><~~/pre>~~
	Vertical offset from the top of the screen. 0 = top of the screen, 1 is the bottom. Compass is centered around this position.
	<~~pre~~ style~~="margin~~-~~bottom~~:~~0;margin~~-~~top:28px;">~~
	~~<TagStyles~~>
	<TagStyle Tag="ClaimArea" Style="Bellow" MaxCharacters="15" Ellipsis="true"/>		<TagStyle Tag="ClaimArea" Style="Bellow" MaxCharacters="15" Ellipsis="true"/>
	<TagStyle Tag="Cardinal" Style="Above" MaxCharacters="1"/>		<TagStyle Tag="Cardinal" Style="Above" MaxCharacters="1"/>
	<TagStyle Tag="Kingdom" Style="Bellow"/>		<TagStyle Tag="Kingdom" Style="Bellow"/>
	</TagStyles>		</TagStyles>
	</~~pre~~>		</source>
	This section adds tags that are visible on compass and in which style. Currently we have 3 types of tags. Claim area - shows your claimed area on the compass, Kingdom tag shows kingdoms and Cardinal tag shows cardinal points (North, South,...). Each tag’s visual appearance is defined in tag/waypoint definition. Styles defines where should the text appear. Available styles: Center, IconOnly, NotShown, Bellow, Above.

	==Explanation of Waypoint/Tag definition==		===Explanation of Waypoint/Tag definition===
	<~~pre~~>		<source lang="xml">
	<Definition xsi:type="MyObjectBuilder_WaypointDefinition">		<Definition xsi:type="MyObjectBuilder_WaypointDefinition">
	<Id Type="MyObjectBuilder_WaypointDefinition" Subtype="Kingdom"/>		<Id Type="MyObjectBuilder_WaypointDefinition" Subtype="Kingdom"/>
Line 54:		Line 45:
	<Color R="255" G="255" B="255" A="255"/>		<Color R="255" G="255" B="255" A="255"/>
	</Definition>		</Definition>
	</~~pre~~>		</source>
	IconPath contains path to the texture of kingdom icon. Color defines color of the text that is shown with the icon. (Example: Fareon, [[File:Kingdom Icon.png\|frameless]])		IconPath contains path to the texture of kingdom icon. Color defines color of the text that is shown with the icon. (Example: Fareon, [[File:Kingdom Icon.png\|frameless]])


	===Compass texture vs in-game look comparison===		===Compass texture vs in-game look comparison===
	Texture:		<center>Texture:</center>

	[[File:Compas Texture with Zones.png\|1024px]]		[[File:Compas Texture with Zones.png\|1024px\|center]]

	In-game look:		<center>In-game look:</center>

	[[File:In-gameCompassZones.png\|1024px]]~~<br/>~~		[[File:In-gameCompassZones.png\|1024px\|center]]
	~~''<NoWiki>*</NoWiki>note that background crop and bottom crop are not used in vanilla (empty opaque texture)''~~

	~~[[Category:Keen_Modding_Guides]]~~		<center><NoWiki>*</NoWiki>note that background crop and bottom crop are not used in vanilla (empty opaque texture)</center>