WDFUSE Tutorial - 3D Renderer - Revision history

Df21admin at 21:11, 18 March 2024

2024-03-18T21:11:32Z

← Older revision		Revision as of 14:11, 18 March 2024
Line 1:		Line 1:
	== 3D Renderer ==		== 3D Renderer ==
	One of the key WDFUSE features that has been missing since launch was a full 3D preview of your current mission. However, by 2022, one of the community members '''The-MAZZTer''' has created a Unity-based [https://github.com/The-MAZZTer/DarkForces Dark Forces Showcase] that allows for full 3D preview of a Dark Forces mission .		One of the key WDFUSE features that has been missing since launch was a full 3D preview of your current mission. However, by 2022, one of the community members '''The-MAZZTer''' has created a Unity-based [https://github.com/The-MAZZTer/DarkForces Dark Forces Showcase] that allows for full 3D preview of a Dark Forces mission .
	[[File:Showcase preview.png\|~~none~~\|thumb\|1035x1035px]]		[[File:Showcase preview.png\|thumb\|thumb\|1035x1035px\|center]]


Line 8:		Line 8:
	=== Renderer Install and Configuration ===		=== Renderer Install and Configuration ===
	The renderer does not come bundled with WDFUSE but it can be instantly installed and auto-configured through the game's '''Options''' menu. To get started either click the '''Options''' icon in the main menu bar at the top or press '''F9''' .		The renderer does not come bundled with WDFUSE but it can be instantly installed and auto-configured through the game's '''Options''' menu. To get started either click the '''Options''' icon in the main menu bar at the top or press '''F9''' .
	[[File:Options Bar.png\|~~none~~\|thumb\|340x340px]]		[[File:Options Bar.png\|thumb\|thumb\|340x340px\|center]]


	Switch to the 3D Renderer Tab and click <span style="color:#FF0000">'''<big>Download</big>'''</span> on the right hand side (''The actual picture of the Moldy Crow wit the word '''download'''''). It should take a few seconds to download and auto-configure the renderer. Otherwise, if you already have downloaded it simply Browse to the path where the executable '''Dark Forces Showcase.exe''' is located.		Switch to the 3D Renderer Tab and click <span style="color:#FF0000">'''<big>Download</big>'''</span> on the right hand side (''The actual picture of the Moldy Crow wit the word '''download'''''). It should take a few seconds to download and auto-configure the renderer. Otherwise, if you already have downloaded it simply Browse to the path where the executable '''Dark Forces Showcase.exe''' is located.
	[[File:RendererOptions.png\|~~none~~\|thumb\|843x843px]]		[[File:RendererOptions.png\|thumb\|thumb\|843x843px\|center]]


Line 26:		Line 26:
	=== Using 3D Renderer ===		=== Using 3D Renderer ===
	To start viewing your mission in 3D press the red '''3D Render''' button at the main menu or press the '''F7''' key. A new window will appear showing your mission. If you still have the original square from the Basics tutorial you will see it rendered in 3D.		To start viewing your mission in 3D press the red '''3D Render''' button at the main menu or press the '''F7''' key. A new window will appear showing your mission. If you still have the original square from the Basics tutorial you will see it rendered in 3D.
	[[File:Render Square.png\|~~none~~\|thumb\|826x826px]]		[[File:Render Square.png\|thumb\|thumb\|826x826px\|center]]
	You can move around the 3D world using the typical FPS '''WASD''' controls and aim with your mouse.		You can move around the 3D world using the typical FPS '''WASD''' controls and aim with your mouse.

Line 36:		Line 36:
	=== Renderer Options ===		=== Renderer Options ===
	If you press '''Escape''' in the 3D renderer you will see various options.		If you press '''Escape''' in the 3D renderer you will see various options.
	[[File:InRendererOptions.png\|~~none~~\|thumb\|857x857px]]		[[File:InRendererOptions.png\|thumb\|thumb\|857x857px\|center]]
	Here you can modify...		Here you can modify...

Line 50:		Line 50:
	* Whether to show warnings when loading ('''Recommended: Off)'''		* Whether to show warnings when loading ('''Recommended: Off)'''
	* Camera position displayed in X, Y, Z coordinates ('''Recommended: On);'''		* Camera position displayed in X, Y, Z coordinates ('''Recommended: On);'''
	[[File:RenderPos.png\|~~none~~\|thumb\|367x367px]]		[[File:RenderPos.png\|thumb\|thumb\|367x367px\|center]]

	'''Note''': Your settings are stored in the registry (including the width and height of your window).		'''Note''': Your settings are stored in the registry (including the width and height of your window).
	[[File:Registry Key.png\|~~none~~\|thumb\|1058x1058px]]		[[File:Registry Key.png\|thumb\|thumb\|1058x1058px\|center]]

	'''Advanced:''' Search for this key '''Computer\HKEY_USERS\<Your Windows User Key>SOFTWARE\MZZT\Dark Forces Showcase''' and delete values as you feel necessary.		'''Advanced:''' Search for this key '''Computer\HKEY_USERS\<Your Windows User Key>SOFTWARE\MZZT\Dark Forces Showcase''' and delete values as you feel necessary.

Df21admin at 15:27, 10 October 2022

2022-10-10T15:27:17Z

← Older revision		Revision as of 08:27, 10 October 2022
Line 11:		Line 11:


	Switch to the 3D Renderer Tab and click '''~~DOWNLOAD~~''' on the right hand side (''The actual picture of the Moldy Crow wit the word '''download'''''). It should take a few seconds to download and auto-configure the renderer. Otherwise, if you already have downloaded it simply Browse to the path where the executable '''Dark Forces Showcase.exe''' is located.		Switch to the 3D Renderer Tab and click <span style="color:#FF0000">'''<big>Download</big>'''</span> on the right hand side (''The actual picture of the Moldy Crow wit the word '''download'''''). It should take a few seconds to download and auto-configure the renderer. Otherwise, if you already have downloaded it simply Browse to the path where the executable '''Dark Forces Showcase.exe''' is located.
	[[File:RendererOptions.png\|none\|thumb\|843x843px]]		[[File:RendererOptions.png\|none\|thumb\|843x843px]]

Df21admin: Make download more explicit

2022-10-10T15:18:52Z

Make download more explicit

← Older revision		Revision as of 08:18, 10 October 2022
Line 11:		Line 11:


	Switch to the 3D Renderer Tab and click '''~~Download~~''' on the right hand side. It should take a few seconds to download and auto-configure the renderer. Otherwise, if you already have downloaded it simply Browse to the path where the executable '''Dark Forces Showcase.exe''' is located.		Switch to the 3D Renderer Tab and click '''DOWNLOAD''' on the right hand side (''The actual picture of the Moldy Crow wit the word '''download'''''). It should take a few seconds to download and auto-configure the renderer. Otherwise, if you already have downloaded it simply Browse to the path where the executable '''Dark Forces Showcase.exe''' is located.
	[[File:RendererOptions.png\|none\|thumb\|843x843px]]		[[File:RendererOptions.png\|none\|thumb\|843x843px]]

Df21admin at 17:06, 22 July 2022

2022-07-22T17:06:14Z

← Older revision		Revision as of 10:06, 22 July 2022
Line 30:		Line 30:

	If you have checked the '''Update Renderer with Changes''' checkbox when you move a map component it will be reflected in the 3D preview window. Try moving the map walls or the sector and you will see them get updated in 3D.		If you have checked the '''Update Renderer with Changes''' checkbox when you move a map component it will be reflected in the 3D preview window. Try moving the map walls or the sector and you will see them get updated in 3D.

			=== Panning: ===
			A '''very''' useful feature is you can switch between WDFUSE and the 3D Renderer by holding the '''ALT''' button so you can pan the cursor between the two programs. It will halt the camera in the renderer and allows you to control the mouse. Give it a try - you don't need to Alt-Tab between them anymore.

	=== Renderer Options ===		=== Renderer Options ===
Line 47:		Line 50:
	* Whether to show warnings when loading ('''Recommended: Off)'''		* Whether to show warnings when loading ('''Recommended: Off)'''
	* Camera position displayed in X, Y, Z coordinates ('''Recommended: On);'''		* Camera position displayed in X, Y, Z coordinates ('''Recommended: On);'''
			[[File:RenderPos.png\|none\|thumb\|367x367px]]

	[[File:~~RenderPos~~.png\|none\|thumb\|~~367x367px~~]]		'''Note''': Your settings are stored in the registry (including the width and height of your window).
			[[File:Registry Key.png\|none\|thumb\|1058x1058px]]

			'''Advanced:''' Search for this key '''Computer\HKEY_USERS\<Your Windows User Key>SOFTWARE\MZZT\Dark Forces Showcase''' and delete values as you feel necessary.

	Finally, if the 3D view state ever gets desynchronized from what you see in the editor simply press the 3D Render button again or press '''F11''' to refresh the view.		Finally, if the 3D view state ever gets desynchronized from what you see in the editor simply press the 3D Render button again or press '''F11''' to refresh the view.

Df21admin at 12:38, 21 July 2022

2022-07-21T12:38:11Z

← Older revision		Revision as of 05:38, 21 July 2022
Line 32:		Line 32:

	=== Renderer Options ===		=== Renderer Options ===
	If you press '''Escape''' in the 3D renderer you will see various options.		If you press '''Escape''' in the 3D renderer you will see various options.
	[[File:InRendererOptions.png\|none\|thumb\|857x857px]]		[[File:InRendererOptions.png\|none\|thumb\|857x857px]]
	~~Most are self-explanatory but it is recommended that~~ you ~~check "~~'''~~Show Camera Position~~'''~~" so~~ you can ~~see your exact~~ X,Y,Z coordinates.		Here you can modify...

			* Which object difficulties will be displayed
			* Which object types should be displayed
			* Which layers must be visible
			* What type of lighting can be displayed (Full Bright lighting (Ambient 31) or Dark Forces 8 bit versions
			* Music On or Off ('''Recommended: OFF )'''
			* The Volume of the music
			* How sensitive is the X/Y camera as you look around
			* Whether to invert the camera
			* The speed at which the camera can be moved
			* Whether to show warnings when loading ('''Recommended: Off)'''
			* Camera position displayed in X, Y, Z coordinates ('''Recommended: On);'''

	[[File:RenderPos.png\|none\|thumb\|367x367px]]		[[File:RenderPos.png\|none\|thumb\|367x367px]]

Df21admin at 05:19, 18 July 2022

2022-07-18T05:19:11Z

← Older revision		Revision as of 22:19, 17 July 2022
Line 1:		Line 1:
	== 3D Renderer ==		== 3D Renderer ==
	One of the key WDFUSE features that has been missing since launch was a full 3D preview of your current mission. However, by 2022, one of the community members '''The-MAZZTer''' has created a Unity-based [https://github.com/The-MAZZTer/DarkForces Dark Forces Showcase] that allows for full 3D preview of a Dark Forces mission.		One of the key WDFUSE features that has been missing since launch was a full 3D preview of your current mission. However, by 2022, one of the community members '''The-MAZZTer''' has created a Unity-based [https://github.com/The-MAZZTer/DarkForces Dark Forces Showcase] that allows for full 3D preview of a Dark Forces mission .
	[[File:Showcase preview.png\|none\|thumb\|1035x1035px]]		[[File:Showcase preview.png\|none\|thumb\|1035x1035px]]

DF21net at 18:35, 9 July 2022

2022-07-09T18:35:29Z

← Older revision		Revision as of 11:35, 9 July 2022
Line 41:		Line 41:

	With that, lets move to [[WDFUSE Tutorial - Advanced Geometry\|'''Advanced Geometry''']] section.		With that, lets move to [[WDFUSE Tutorial - Advanced Geometry\|'''Advanced Geometry''']] section.


			'''WDFUSE Tutorials'''
			#[[WDFUSE Tutorial - Introduction\|Introduction]]
			#[[WDFUSE Tutorial - Configuration]]
			#[[WDFUSE Tutorial - Basic Geometry]]
			#[[WDFUSE Tutorial - Basic Geometry II]]
			# [[WDFUSE Tutorial - 3D Renderer]]
			#[[WDFUSE Tutorial - Advanced Geometry]]
			#[[WDFUSE Tutorial - Advanced Geometry II]]
			#[[WDFUSE Tutorial - Advanced Geometry III]]
			#[[WDFUSE Tutorial - Objects]]
			#[[WDFUSE Tutorial - Scripting]]
			#[[WDFUSE Tutorial - Scripting II]]
			#[[WDFUSE Tutorial - Scripting III]]

DF21net at 18:25, 27 June 2022

2022-06-27T18:25:48Z

← Older revision		Revision as of 11:25, 27 June 2022
Line 40:		Line 40:
	Finally, if the 3D view state ever gets desynchronized from what you see in the editor simply press the 3D Render button again or press '''F11''' to refresh the view.		Finally, if the 3D view state ever gets desynchronized from what you see in the editor simply press the 3D Render button again or press '''F11''' to refresh the view.

	With that, lets move to Advanced Geometry section.		With that, lets move to [[WDFUSE Tutorial - Advanced Geometry\|'''Advanced Geometry''']] section.

DF21net: Created page with "== 3D Renderer == One of the key WDFUSE features that has been missing since launch was a full 3D preview of your current mission. However, by 2022, one of the community members '''The-MAZZTer''' has created a Unity-based [https://github.com/The-MAZZTer/DarkForces Dark Forces Showcase] that allows for full 3D preview of a Dark Forces mission. 1035x1035px The renderer has been modified by '''Karjala''' ( ''df21.net{ at }gmail.co..."

2022-06-23T17:54:27Z

Created page with "== 3D Renderer == One of the key WDFUSE features that has been missing since launch was a full 3D preview of your current mission. However, by 2022, one of the community members '''The-MAZZTer''' has created a Unity-based [https://github.com/The-MAZZTer/DarkForces Dark Forces Showcase] that allows for full 3D preview of a Dark Forces mission. none|thumb|1035x1035px The renderer has been modified by '''Karjala''' ( ''df21.net{ at }gmail.co..."

New page

== 3D Renderer ==
One of the key WDFUSE features that has been missing since launch was a full 3D preview of your current mission. However, by 2022, one of the community members '''The-MAZZTer''' has created a Unity-based [https://github.com/The-MAZZTer/DarkForces Dark Forces Showcase] that allows for full 3D preview of a Dark Forces mission.
[[File:Showcase preview.png|none|thumb|1035x1035px]]

The renderer has been modified by '''Karjala''' ( ''df21.net{ at }gmail.com'' ) and integrated into WDFUSE to allow full previews of the mission without having the need to launch the game.

=== Renderer Install and Configuration ===
The renderer does not come bundled with WDFUSE but it can be instantly installed and auto-configured through the game's '''Options''' menu. To get started either click the '''Options''' icon in the main menu bar at the top or press '''F9''' .
[[File:Options Bar.png|none|thumb|340x340px]]

Switch to the 3D Renderer Tab and click '''Download''' on the right hand side. It should take a few seconds to download and auto-configure the renderer. Otherwise, if you already have downloaded it simply Browse to the path where the executable '''Dark Forces Showcase.exe''' is located.
[[File:RendererOptions.png|none|thumb|843x843px]]

Within a few seconds you will get a pop-up saying that the renderer has been installed.

You will also notice two checkboxes.

# If you check the '''Update Renderer with Changes''' it means that any time you make a change in the editor, they will be reflected in the 3D renderer.
# If you check the '''Start 3D Render on Level Load''' it means that when you open up a new or existing project the launcher will start automatically.

Click them both and press '''ok''' to exit the Options menu.

=== Using 3D Renderer ===
To start viewing your mission in 3D press the red '''3D Render''' button at the main menu or press the '''F7''' key. A new window will appear showing your mission. If you still have the original square from the Basics tutorial you will see it rendered in 3D.
[[File:Render Square.png|none|thumb|826x826px]]
You can move around the 3D world using the typical FPS '''WASD''' controls and aim with your mouse.

If you have checked the '''Update Renderer with Changes''' checkbox when you move a map component it will be reflected in the 3D preview window. Try moving the map walls or the sector and you will see them get updated in 3D.

=== Renderer Options ===
If you press '''Escape''' in the 3D renderer you will see various options.
[[File:InRendererOptions.png|none|thumb|857x857px]]
Most are self-explanatory but it is recommended that you check "'''Show Camera Position'''" so you can see your exact X,Y,Z coordinates.
[[File:RenderPos.png|none|thumb|367x367px]]

Finally, if the 3D view state ever gets desynchronized from what you see in the editor simply press the 3D Render button again or press '''F11''' to refresh the view.

With that, lets move to Advanced Geometry section.