[REL] Old Style SH Controls (familiar 3 dials) for UI v1.3.1

[TheDarkWraith]

This mod has been discontinued. It has been made a part of another mod. See here: http://www.subsim.com/radioroom/show...69&postcount=1

Pre-requisites:

YOU MUST BE PATCHED TO THE LATEST VERSION RELEASED BY UBISOFT. Run your game updater (\Ubisoft\SilentHunter5\Support\GameUpdater\gu.exe ) to see if you are running the latest version of the game or not.


Old Style SH constrols for SH5 by TheDarkWraith
version 1.3.1
This mod will bring the familiar 3 dials back to SH5. The dials can be customized by using a different .dds file. See the readme.txt file in \Dials.
I've also included the Fuel, CO2, O2, and battery bargraph to this mod so the user can monitor levels.
The dials have two states.
The first dial has the states of: engine order telegraph and speed.
The second dial has states of heading and rudder angle (though angle displayed on dial doesn't match rudder deflection currently. Still sorting that out).
The third dial has states of shallow depth and deep depth.
To change states simply click on the button below the dial.
The dials will expand when the mouse is inside them and they will contract when mouse is outside them (like zoom in/out). Individual zoom levels can be set for throttle, speed, heading, rudder, depth260, and depth25. In the file (\data\Scripts\Menu\Page layout.py) find this section and change these values:
#
# Base Zoom levels
BaseZoomThrottle = 200 #(for throttle)
BaseZoomSpeed = 200 #(for speed)
BaseZoomHeading = 200 #(for heading)
BaseZoomRudder = 200 #(for rudder)
BaseZoomDepth260 = 200 #(for depth260)
BaseZoomDepth25 = 200 #(for depth25)
User can lock out dials from zooming by adjust these values in the file (\data\Scripts\Menu\Page layout.py):
#
ThrottleCanZoom = True #(set to false to disable zooming)
SpeedCanZoom = True #(set to false to disable zooming)
HeadingCanZoom = True #(set to false to disable zooming)
RudderCanZoom = True #(set to false to disable zooming)
Depth260CanZoom = True #(set to false to disable zooming)
Depth25CanZoom = True #(set to false to disable zooming)
The animation rate of the dials expanding/contracting can also be changed. Find this section in the file (\data\Scripts\Menu\Page layout.py):
#
# rate at which dials grow and shrink (in seconds)
DialsAnimationSpeed = 0.10 (change this value to change animation rate)
There are three versions of the TDC included - All dials, minimal dials, and no TDC. All dials will take control of the functionality of the SH5 interface for a torpoedo solution (and associated controls in the SH5 stock UI are removed). Minimal dials just exposes the dials not exposed by the stock SH5 UI and also uses the stock UI. No TDC removes the TDC from the mod. The TDC interfaces have been included on the obs periscope, attack periscope, and UZO. The mod defaults to minimal dials TDC.
To install All dials:
navigate to where you unzipped the mod to and open it up. Open up the folder 'TDC'. Select the folder 'All Dials' and open it up. Right click on 'data' folder and select copy. Navigate back to where you unzipped the mod to and open it back up. Select the 'MODS' folder and open it up. Select the 'OldStyleSHControls_1_3_1_ByTheDarkWraith' folder and open it up. Right click in any empty area and select paste. Say yes to all confirmation messages. Navigate back to where you unzipped the mod to and open it back up. Select the 'MODS' folder and right click on it. Select copy. Navigate to your '\Ubisoft\Silent Hunter 5\' folder and open it up. Right click in an empty area and select paste. Enable via JSGME (this assumes you setup JSGME to use the 'MODS' folder as default).
To install minimal dials:
navigate to where you unzipped the mod to and open it up. Open up the folder 'TDC'. Select the folder 'Minimal Dials' and open it up. Right click on 'data' folder and select copy. Navigate back to where you unzipped the mod to and open it back up. Select the 'MODS' folder and open it up. Select the 'OldStyleSHControls_1_3_1_ByTheDarkWraith' folder and open it up. Right click in any empty area and select paste. Say yes to all confirmation messages. Navigate back to where you unzipped the mod to and open it back up. Select the 'MODS' folder and right click on it. Select copy. Navigate to your '\Ubisoft\Silent Hunter 5\' folder and open it up. Right click in an empty area and select paste. Enable via JSGME (this assumes you setup JSGME to use the 'MODS' folder as default).
To install No TDC:
navigate to where you unzipped the mod to and open it up. Open up the folder 'TDC'. Select the folder 'No TDC' and open it up. Right click on 'data' folder and select copy. Navigate back to where you unzipped the mod to and open it back up. Select the 'MODS' folder and open it up. Select the 'OldStyleSHControls_1_3_1_ByTheDarkWraith' folder and open it up. Right click in any empty area and select paste. Say yes to all confirmation messages. Navigate back to where you unzipped the mod to and open it back up. Select the 'MODS' folder and right click on it. Select copy. Navigate to your '\Ubisoft\Silent Hunter 5\' folder and open it up. Right click in an empty area and select paste. Enable via JSGME (this assumes you setup JSGME to use the 'MODS' folder as default).

A BIG thanks to maerean_m for information and assistance he gave in helping me make the TDC come to life for the obs periscope, attack periscope, and UZO. Thanks again!!
The default text is English. There is a new folder called '\Text'. In it you will find folders of all the different languages I have for the mod. Navigate to you language and then copy the menu.txt file and paste in '\MODS\OldStyleSHControls_1_3_1_ByTheDarkWraith\da ta\Menu'. Then copy the 'MODS' folder to your '\Ubisoft\SilentHunter5\' folder (this assumes that you setup JSGME to use the MODS folder as default). Enable via JSGME.
Current languages supported by this are:
English
German
French

Contributors (\Included mods from others):
briklebritt - new dials. You can find them under \Dials\German\metric_briklebritt (these are the default dials used in this mod). His mod can be found under \Included mods from others\dials_briklebritt. His documentation file can be found under \Included mods from others\dials_briklebritt\documentation. He also contributed to German translations in menu.txt file.
idl0r - German translations of menu items added in menu.txt file.
TLT - French translation of menu.txt file.
FLB Sale U999 - used his TDC_metric.dds file for the dials in the TDC

Current additions working on for next version:
- Adding scrolling digits for speed, depth, and heading. Speed and depth have been coded but still working on heading/rudder
- quick buttons for various commands

This is JSGME ready. Navigate to where you unzipped the mod to and open it up. Select the 'MODS' folder and right click on it. Select copy. Navigate to your '\Ubisoft\Silent Hunter 5\' folder and open it up. Right click in an empty area and select paste. Enable via JSGME.
(this assumes you setup JSGME to use the 'MODS' folder as default)

Changelog:
v1.0 - first official release
- made dials customizable by using a new Dials.dds file (\data\Menu\Gui)
- the background that the dials are attached to and the battery,fuel,CO2,and compressed air can be customized by using a new hud.dds file (\data\menu\Gui)
- change structure of folders in the files to use only \data\menu\Gui instead of \data\menu\Skins\American(or German)\Gui\Layout
v1.0.1 - fixed missing tooltips for Battery level, CO2 level, Fuel level, and compressed air level
- fixed folder structure of zip file so that people unfamiliar with JSGME will find it easy to install this mod
v1.1.0 - new dials supplied by briklebritt used as default dials
- added folder '\Included mods from others'. You can find their complete mod there along with documentation (if supplied)
- added ability for dials to zoom in/out
v1.1.1 - added new folder called '\Text'. In it contains folders of all the different languages I have for this mod.
- renamed some global variables in Page layout.py to give better understanding of purpose
- fixed 'stuttering' problem with dials when mousing in/out
- fixed problem of other dials zooming in when one already zoomed in. User must mouse out of zoomed dial to be able to mouse in to another one
- zoomed dials dynamically reposition themselves when zoomed in to prevent any part of them from going offscreen (either the right edge or the bottom)
- changed when the map tools expand in the Page Default Hud.py file. They were set to expand when the map was in the 'Maximized' state. Now they expand in the 'TAI' state (which is first click of expand arrow on map)
- Removed 'ghosts' of SH4 style controls. There was the possibility that user could click on one and cause a CTD
- Default size of map on first click of expand arrow has been increased from default width and height to width = PageDefaultHud_Feedback_MapTools.Height + PageDefaultHud_Feedback_DepthGroup.Height and height = PageDefaultHud_Feedback_MapTools.Height + PageDefaultHud_Feedback_DepthGroup.Height thus making the map size the height and width of the expanded map tools and the DepthGroup's combined height to it's left (aesthetics)
- Each dial (and each dial's state) has it's own zoom level. User can change these to suit their liking
- Animation rate of zoom in/out can be changed by user to suit their liking
- Messages box moved to just left of battery/CO2/Fuel/Compressed air box
- Item notes moved to just above dials
- other items moved so as to not interfere with items moved by this mod
- New values for the dials (when you click on a dial to order it to a new depth, speed, etc.) now don't show up as 'small' hands. They appear as the size they should.
- Changed folder structure of mod. This mod now incorporates a MODS folder so end user can easily copy to their \Ubisoft\SilentHunter5\MODS folder.
- added the 'standard' depth controls back (located under the map controls just left of the map). Disabled the 'advanced' controls associated with map
v1.2.0 - added FLB Sale U 999's torpedo spread angle dial to UZO and attack periscope
v1.3.0 - removed FLB Sale U 999's torpedo spread angle dial
- added TDC with all dials to obs scope, attack periscope, and UZO!
v1.3.1 - centered Periscope and Observation scope oculars in the screen
- moved some TDC dials lower in the display and adjusted x offsets to the sides since centering oculars
- removed unneeded items from display in attack and observation scope pages
- added ability to lock out dials from zooming. Mod defaults to all dials able to zoom.
- added depth under keel display (old SH5 interface item)
- added the abilitiy to use TDC all dials, TDC minimal dials, or no TDC. Mod defaults to TDC minimal dials.
- fixed bug where if user has a dial zoomed and mouses over another dial and the previous dial zoomes out and user orders command on this dial the new value would show in the zoomed state
- fixed bug where dials and all would show outside of the mission game state

TheDarkWraith

you can find this mod incorporated into a combined UI mod here: http://www.subsim.com/radioroom/show...69&postcount=1

TheDarkWraith