Arma Reforger:Game Master: Image Generation Tutorial - Revision history

Lou Montana: Some wiki formatting

2025-07-21T13:49:22Z

Some wiki formatting

← Older revision		Revision as of 15:49, 21 July 2025
Line 1:		Line 1:
	{{TOC\|side}}		{{TOC\|side}}

	~~= Introduction =~~

	Preview Images are special types of automatically generated images used in for instance '''Game Master Asset Browser'''.		Preview Images are special types of automatically generated images used in for instance '''Game Master Asset Browser'''.

Line 21:		Line 18:
	Select '''SCR_EditorImageGeneratorEntity''' in default layer. Doing so will show current and target resolution in top left corner. Readjust the viewport to make values match.		Select '''SCR_EditorImageGeneratorEntity''' in default layer. Doing so will show current and target resolution in top left corner. Readjust the viewport to make values match.

	[[File:armareforger-gm-image-generation-adjust-viewport.mp4\|\|thumb \|200px \|alt=A spacesuited astronaut slowly climbs down a ladder on a complicated metal structure, and then hops the last step onto a bright terrain. \|Television clip of Buzz descending the ladder and stepping onto the Moon. ]]		[[File:armareforger-gm-image-generation-adjust-viewport.mp4\|\|thumb \|200px \|alt=A spacesuited astronaut slowly climbs down a ladder on a complicated metal structure, and then hops the last step onto a bright terrain.\|Television clip of Buzz descending the ladder and stepping onto the Moon.]]

	{{Feature\|informative\|If the viewport cannot be made narrow enough, force it to 4:3 resolution in ''Camera > View Aspect Ratio > 4:3'' }}		{{Feature\|informative\|If the viewport cannot be made narrow enough, force it to 4:3 resolution in ''Camera > View Aspect Ratio > 4:3''}}

	{{Feature\|warning\|The default value of 400x300 should be maintained, as otherwise image stretching or resolution issues might appear in the .edds file }}		{{Feature\|warning\|
			* The default value of 400x300 should be maintained, as otherwise image stretching or resolution issues might appear in the .edds file
			* If you have problems with generating pictures even though '''Current resolution''' matches '''Target resolution''' then make sure you are using '''100% display scale''' in Windows display settings.
			}}

	{{Feature\|warning\|If you have problems with generating pictures even though '''Current resolution''' matches '''Target resultion''' then make sure you are using '''100% display scale''' in Windows display settings. }}

	== Select Prefabs ==		== Select Prefabs ==
Line 52:		Line 51:
	{{Feature\|informative\|In case of troubles, [enfusion://WorldEditor/~worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent ''worlds\Editor\Slots\AssetImages\Eden_AssetImages.ent''] can be used as an example how prepare world for '''Preview Images''' generation.}}		{{Feature\|informative\|In case of troubles, [enfusion://WorldEditor/~worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent ''worlds\Editor\Slots\AssetImages\Eden_AssetImages.ent''] can be used as an example how prepare world for '''Preview Images''' generation.}}

	== Create ~~manager~~ ==
			== Create Manager ==

	Insert '''SCR_EditorImageGeneratorEntity''' in the world.		Insert '''SCR_EditorImageGeneratorEntity''' in the world.


	== Create a ~~position~~ ==		== Create a Position ==

	Insert '''SCR_EditorImagePositionEntity''' in the world.		Insert '''SCR_EditorImagePositionEntity''' in the world.
Line 73:		Line 73:


	== Create a ~~camera~~ ==		== Create a Camera ==

	Insert '''SCR_CameraBase''' as a child of the position entity and add '''Hierarchy''' component to it.		Insert '''SCR_CameraBase''' as a child of the position entity and add '''Hierarchy''' component to it.
Line 82:		Line 82:


	== Test the ~~position~~ ==		== Test the Position ==

	Play the world with desired position entity selected. This will activate only this position, while ignoring all the others.		Play the world with desired position entity selected. This will activate only this position, while ignoring all the others.

Lou Montana: Text replacement - "\{\{GameCategory\|armaR\|Modding\|(Guidelines|Tutorials)\|([^=↵]*)\}\}" to "{{GameCategory|armaR|Modding|$2|$1}}"

2025-02-26T12:31:55Z

Text replacement - "\{\{GameCategory\|armaR\|Modding\|(Guidelines|Tutorials)\|([^=↵]*)\}\}" to "{{GameCategory|armaR|Modding|$2|$1}}"

← Older revision		Revision as of 14:31, 26 February 2025
Line 94:		Line 94:


	{{GameCategory\|armaR\|Modding~~\|Tutorials~~\|Game Master}}		{{GameCategory\|armaR\|Modding\|Game Master\|Tutorials}}

Reyhard at 08:15, 27 September 2024

2024-09-27T08:15:46Z

← Older revision		Revision as of 10:15, 27 September 2024
Line 8:		Line 8:


	{{Feature\|important\|Therefore, it is '''required to run [[Arma_Reforger:Game_Master:_Editable_Entities_Configuration]]''' or manually add that component to the asset if it is missing (f.e. when doing some character or vehicle prefab which doesn't inherit from existing base prefabs) before trying to generate the images. '''Create/Update Selected Editable Prefabs''' plugin will take care of creating appropriate Editable Component, creating editable variant (when it is necessary) and will generate placeholder preview images which can be later replaced via this script. }}		{{Feature\|important\|Therefore, it is '''required to run [[Arma_Reforger:Game_Master:_Editable_Entities_Configuration \| Create/Update Selected Editable Prefabs plugin]]''' or manually add that component to the asset if it is missing (f.e. when doing some character or vehicle prefab which doesn't inherit from existing base prefabs) before trying to generate the images. '''Create/Update Selected Editable Prefabs''' plugin will take care of creating appropriate Editable Component, creating editable variant (when it is necessary) and will generate placeholder preview images which can be later replaced via this script. }}

	In case some non standard asset need an image, then it is possible to create [[#Configure World\| custom world]] with user selected camera parameters.		In case some non standard asset need an image, then it is possible to create [[#Configure World\| custom world]] with user selected camera parameters.
Line 21:		Line 21:
	Select '''SCR_EditorImageGeneratorEntity''' in default layer. Doing so will show current and target resolution in top left corner. Readjust the viewport to make values match.		Select '''SCR_EditorImageGeneratorEntity''' in default layer. Doing so will show current and target resolution in top left corner. Readjust the viewport to make values match.

	[[File:armareforger-gm-image-generation-adjust-viewport.mp4\|~~1200px~~]]		[[File:armareforger-gm-image-generation-adjust-viewport.mp4\|\|thumb \|200px \|alt=A spacesuited astronaut slowly climbs down a ladder on a complicated metal structure, and then hops the last step onto a bright terrain. \|Television clip of Buzz descending the ladder and stepping onto the Moon. ]]

	{{Feature\|informative\|If the viewport cannot be made narrow enough, force it to 4:3 resolution in ''Camera > View Aspect Ratio > 4:3'' }}		{{Feature\|informative\|If the viewport cannot be made narrow enough, force it to 4:3 resolution in ''Camera > View Aspect Ratio > 4:3'' }}

Reyhard: Added note about Windows display scale

2023-07-05T10:39:36Z

Added note about Windows display scale

← Older revision		Revision as of 12:39, 5 July 2023
Line 26:		Line 26:

	{{Feature\|warning\|The default value of 400x300 should be maintained, as otherwise image stretching or resolution issues might appear in the .edds file }}		{{Feature\|warning\|The default value of 400x300 should be maintained, as otherwise image stretching or resolution issues might appear in the .edds file }}

			{{Feature\|warning\|If you have problems with generating pictures even though '''Current resolution''' matches '''Target resultion''' then make sure you are using '''100% display scale''' in Windows display settings. }}

	== Select Prefabs ==		== Select Prefabs ==

Reyhard: added note about Script Authorization when using Preview Image generator

2023-05-25T09:05:13Z

added note about Script Authorization when using Preview Image generator

← Older revision		Revision as of 11:05, 25 May 2023
Line 17:		Line 17:

	In World Editor, load [enfusion://WorldEditor/worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent;5896.25,225.667,7097.26;-34.9951,53.0787,0 Worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent]		In World Editor, load [enfusion://WorldEditor/worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent;5896.25,225.667,7097.26;-34.9951,53.0787,0 Worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent]




	== Adjust Screen Resolution ==		== Adjust Screen Resolution ==

Line 46:		Line 42:
	{{Feature\|informative\|The system will spawn the entities on locations with matching labels. If the location does not match, or no location can be found, check the labels in the ''EditableEntityComponent'' of the prefab you are trying to capture images of.		{{Feature\|informative\|The system will spawn the entities on locations with matching labels. If the location does not match, or no location can be found, check the labels in the ''EditableEntityComponent'' of the prefab you are trying to capture images of.

	Note that this component only exists on Editable versions of prefabs, with the exception of ''Characters'', ''Groups'', and ''Vehicles''. Because of this it is important to select the right prefab type when taking images.}}		Note that this component only exists on Editable versions of prefabs, with the exception of ''Characters'', ''Groups'', and ''Vehicles''. Because of this it is important to select the right prefab type when taking images.}}{{Feature\|important\|When prompted, in '''Script Authorization Required''' window click '''Yes to All''', in order to give necessary privileges to preview images generator plugin.
			Alternatively it is possible to use [[Arma_Reforger:Startup_Parameters#scriptAuthorizeAll\|scriptAuthorizeAll]] startup parameter.}}
	= Configuring Custom World =		= Configuring Custom World =

Reyhard: Removed obsolete section about changing compression to PNG

2023-05-25T08:13:04Z

Removed obsolete section about changing compression to PNG

← Older revision		Revision as of 10:13, 25 May 2023
Line 30:		Line 30:

	{{Feature\|warning\|The default value of 400x300 should be maintained, as otherwise image stretching or resolution issues might appear in the .edds file }}		{{Feature\|warning\|The default value of 400x300 should be maintained, as otherwise image stretching or resolution issues might appear in the .edds file }}

	~~== Set Output Format ==~~

	~~In diagnostic menu, set ''Game > Compressed format in WB'' to ''true''~~

	~~[[Image:armareforger-gm-image-generation-debug-menu.gif]]~~

	~~{{Feature\|informative\|See [[Arma Reforger:Diag Menu\|Diag Menu]] for Diag Menu's how-to.}}~~

	~~{{Feature\|warning\|~~
	~~[[Arma Reforger:Diag Menu\|Diag Menu]] '''stops working after taking screenshots'''.~~
	~~If you already generated editor previews but you forgot to enable the compression, then you will have to restart Workbench and set the compression before starting generation of preview images.~~
	}}

	== Select Prefabs ==		== Select Prefabs ==

R3vo: cat

2023-01-01T11:08:59Z

cat

← Older revision		Revision as of 13:08, 1 January 2023
Line 109:		Line 109:


	{{GameCategory\|armaR\|Modding\|Tutorials}}		{{GameCategory\|armaR\|Modding\|Tutorials\|Game Master}}

Reyhard at 09:32, 3 December 2022

2022-12-03T09:32:15Z

← Older revision		Revision as of 11:32, 3 December 2022
Line 16:		Line 16:
	== Load World ==		== Load World ==

	In World Editor, load [~~https://enfusionengine.com/api/redirect?to=~~enfusion://~~ResourceManager~~/~~~ArmaReforger:~~worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent Worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent]		In World Editor, load [enfusion://WorldEditor/worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent;5896.25,225.667,7097.26;-34.9951,53.0787,0 Worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent]

Reyhard: fixed link

2022-12-03T09:31:40Z

fixed link

← Older revision		Revision as of 11:31, 3 December 2022
Line 16:		Line 16:
	== Load World ==		== Load World ==

	In World Editor, load [enfusion://~~WorldEditor~~/~worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent ~~''worlds\~~Editor\Slots\AssetImages\Eden_AssetImages.ent'']		In World Editor, load [https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~ArmaReforger:worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent Worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent]

Lou Montana: Fix Debug Menu → Diag Menu + link

2022-06-27T09:14:39Z

Fix Debug Menu → Diag Menu + link

← Older revision		Revision as of 11:14, 27 June 2022
Line 3:		Line 3:
	= Introduction =		= Introduction =

	Preview Images are special types of automatically generated images used in for instance '''Game Master Asset Browser'''.		Preview Images are special types of automatically generated images used in for instance '''Game Master Asset Browser'''.

	Scripts described in this tutorial will attempt to pick most appropriate background and camera settings for selected prefab and then, it will replace '''existing PNG''' file next to '''already existing EDDS''' file defined in '''Image''' property located inside editable entity component (depending on the type of the asset, it can be '''SCR_EditableEntityComponent''' , '''SCR_EditableCharacterComponent''', '''SCR_EditableVehicleComponent''' or '''SCR_EditableGroupComponent'''). By default, automatically generated Preview Images are located in '''UI/Textures/EditorPreviews/Auto ''' folder.		Scripts described in this tutorial will attempt to pick most appropriate background and camera settings for selected prefab and then, it will replace '''existing PNG''' file next to '''already existing EDDS''' file defined in '''Image''' property located inside editable entity component (depending on the type of the asset, it can be '''SCR_EditableEntityComponent''' , '''SCR_EditableCharacterComponent''', '''SCR_EditableVehicleComponent''' or '''SCR_EditableGroupComponent'''). By default, automatically generated Preview Images are located in '''UI/Textures/EditorPreviews/Auto ''' folder.
Line 15:		Line 15:

	== Load World ==		== Load World ==

	In World Editor, load [enfusion://WorldEditor/~worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent ''worlds\Editor\Slots\AssetImages\Eden_AssetImages.ent'']		In World Editor, load [enfusion://WorldEditor/~worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent ''worlds\Editor\Slots\AssetImages\Eden_AssetImages.ent'']


	== Adjust Screen Resolution ==		== Adjust Screen Resolution ==
	Select '''SCR_EditorImageGeneratorEntity''' in default layer. Doing so will show current and target resolution in top left corner. Readjust the viewport to make values match.
			Select '''SCR_EditorImageGeneratorEntity''' in default layer. Doing so will show current and target resolution in top left corner. Readjust the viewport to make values match.

	[[File:armareforger-gm-image-generation-adjust-viewport.mp4\|1200px]]		[[File:armareforger-gm-image-generation-adjust-viewport.mp4\|1200px]]
Line 27:		Line 30:

	== Set Output Format ==		== Set Output Format ==

	In diagnostic menu, set ''Game > Compressed format in WB'' to ''true''		In diagnostic menu, set ''Game > Compressed format in WB'' to ''true''

	[[Image:armareforger-gm-image-generation-debug-menu.gif]]		[[Image:armareforger-gm-image-generation-debug-menu.gif]]

	{{Feature\|informative\|~~Diagnostic menu is accessible in any Workbench viewport via Windows key + Left Control or Windows key + Left Shift~~. ~~Navigation in this debug menu is performed via arrow keys, f.e. arrow light~~ }}		{{Feature\|informative\|See [[Arma Reforger:Diag Menu\|Diag Menu]] for Diag Menu's how-to.}}

	{{Feature\|warning\|~~Debug menu~~ '''stops ~~to work~~ after taking screenshots'''. If you already generated editor previews but you forgot to enable the compression, then you will have to restart Workbench and set the compression before starting generation of preview images.}}		{{Feature\|warning\|
			[[Arma Reforger:Diag Menu\|Diag Menu]] '''stops working after taking screenshots'''.
			If you already generated editor previews but you forgot to enable the compression, then you will have to restart Workbench and set the compression before starting generation of preview images.
			}}

	== Select Prefabs ==		== Select Prefabs ==

	In World Editor's resource browser, select prefabs (*.et) you want to capture.		In World Editor's resource browser, select prefabs (*.et) you want to capture.

Line 41:		Line 49:

	[[Image:armareforger-gm-image-generation-select-prefabs.png\|800px]]		[[Image:armareforger-gm-image-generation-select-prefabs.png\|800px]]


	== Play ==		== Play ==
	~~Play the world. The system will spawn all selected prefabs one by one and take a screenshot of each of them.~~

	{{Feature\|informative\|The system will spawn the entities on locations with matching labels. If the location does not match, or no location can be found, check the labels in the ''EditableEntityComponent'' of the prefab you are trying to capture images of.		Play the world. The system will spawn all selected prefabs one by one and take a screenshot of each of them.

			{{Feature\|informative\|The system will spawn the entities on locations with matching labels. If the location does not match, or no location can be found, check the labels in the ''EditableEntityComponent'' of the prefab you are trying to capture images of.

	Note that this component only exists on Editable versions of prefabs, with the exception of ''Characters'', ''Groups'', and ''Vehicles''. Because of this it is important to select the right prefab type when taking images.}}		Note that this component only exists on Editable versions of prefabs, with the exception of ''Characters'', ''Groups'', and ''Vehicles''. Because of this it is important to select the right prefab type when taking images.}}
Line 51:		Line 61:
	= Configuring Custom World =		= Configuring Custom World =

	In case you would like to create custom world for preview images, following steps have to performed.		In case you would like to create custom world for preview images, following steps have to performed.

	{{Feature\|informative\|In case of troubles, [enfusion://WorldEditor/~worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent ''worlds\Editor\Slots\AssetImages\Eden_AssetImages.ent''] can be used as an example how prepare world for '''Preview Images''' generation.}}		{{Feature\|informative\|In case of troubles, [enfusion://WorldEditor/~worlds/Editor/Slots/AssetImages/Eden_AssetImages.ent ''worlds\Editor\Slots\AssetImages\Eden_AssetImages.ent''] can be used as an example how prepare world for '''Preview Images''' generation.}}

	== Create manager ==		== Create manager ==

	Insert '''SCR_EditorImageGeneratorEntity''' in the world.		Insert '''SCR_EditorImageGeneratorEntity''' in the world.


	== Create a position ==		== Create a position ==

	Insert '''SCR_EditorImagePositionEntity''' in the world.		Insert '''SCR_EditorImagePositionEntity''' in the world.

Line 71:		Line 84:
	** Force weapon type if the character might not hold this weapon by default. ''E.g. an AT Soldier''		** Force weapon type if the character might not hold this weapon by default. ''E.g. an AT Soldier''
	* It is recommended to give the image position a name which helps identifying the position in the hierarchy.		* It is recommended to give the image position a name which helps identifying the position in the hierarchy.


	== Create a camera ==		== Create a camera ==

	Insert '''SCR_CameraBase''' as a child of the position entity and add '''Hierarchy''' component to it.		Insert '''SCR_CameraBase''' as a child of the position entity and add '''Hierarchy''' component to it.

	* Use ''Set entity to view orientation'' plugin to move the camera to where World Editor's camera is. This will copy only position and rotation, not FOV!		* Use ''Set entity to view orientation'' plugin to move the camera to where World Editor's camera is. This will copy only position and rotation, not FOV!
	* Optionally add '''SCR_PostProcessCameraComponent''' with custom post-process effects.		* Optionally add '''SCR_PostProcessCameraComponent''' with custom post-process effects.
	* Enable ''Show Debug View Cone'' to see where the camera is pointed to even in World Editor.		* Enable ''Show Debug View Cone'' to see where the camera is pointed to even in World Editor.


	== Test the position ==		== Test the position ==

	Play the world with desired position entity selected. This will activate only this position, while ignoring all the others.		Play the world with desired position entity selected. This will activate only this position, while ignoring all the others.

	You still need compatible prefabs selected in '''World Editor's''' resource browser.		You still need compatible prefabs selected in '''World Editor's''' resource browser.


	== Repeat ==		== Repeat ==

	Return back to [[#Create a position\|create position]] paragraph and place as many positions as you need to cover all prefabs.		Return back to [[#Create a position\|create position]] paragraph and place as many positions as you need to cover all prefabs.


	{{GameCategory\|armaR\|Modding\|Tutorials}}		{{GameCategory\|armaR\|Modding\|Tutorials}}