Smile [REL] Multiple UIs for SH5 with TDC
This mod will bring back the missing basic functionality to SH5. It will also give the user multiple UI options to choose from. From the text file located in '\MODS\NewUIs_TDC_1_0_0_ByTheDarkWraith\Documentat ion':
NewUIs with TDC for SH5 by TheDarkWraith
version 1.0.0
This mod will bring the several new UIs to SH5. Currently the list of UIs are:
- SH3 style
- SH4 style
- SH5 Enhanced
SH3 style UI consists of:
- familiar 3 dials (throttle/speed, heading/rudder, depth25/depth260).
- Officer shortcut bar with commands for officers.
- TDC. TDC mode can be set to: no TDC, minimal dials, all dials (currently requires manual setup)
- Fuel, CO2, O2, and battery levels bargraph. Used to monitor levels of each. Current level displayed on bar graph.
SH4 style UI consists of:
- familiar 3 dials (throttle/speed, heading/rudder, depth25/depth260).
- TDC. TDC mode can be set to: no TDC, minimal dials, all dials (currently requires manual setup)
- Fuel, CO2, O2, and battery levels bargraph. Used to monitor levels of each. Current level displayed on bar graph.
SH5 Enhanced UI consists of:
- TDC. TDC mode can be set to: no TDC, minimal dials, all dials (currently requires manual setup)
- Heading bar integrated into the speed bar. Clicking the heading bar readout will reveal a heading/rudder dial. The dial is switchable from heading mode to rudder mode by clicking on the button under the dial. Clicking on the heading bar readout again will hide the dial (it retains the mode it was in when revealed again). Mousing into the heading bar readout and pressing the appropriate keys will set the ordered heading. You can press and hold the appropriate keys to keep changing the ordered heading. The appropriate keys (and all options) can be changed by editing \MODS\NewUIs_TDC_1_0_0_TheDarkWraith\data\Scripts\ Menu\TheDarkWraithUserOptions.py). Mousing out of the heading bar readout with a new ordered heading will cause this ordered heading to take effect. The dial can also be used to set the ordered heading / rudder angle. A tooltip has been integrated to be shown when you mouse into the heading bar readout. It will either display the current heading or if you have requested a new ordered heading the current ordered heading. Once within 5 degrees of the ordered heading the tooltip will start to display the current heading.
- Officer shortcut bar with commands for officers.
Common to all UIs:
- Option to enable heading display in Binocular view
- Added skwasjer's digital clock to top right
For those UIs that utilize the familiar 3 dials:
- 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.
- User can lock out each individual dial (and each state of the dial) from zooming.
- The animation rate of the dials expanding/contracting can also be changed.
- The dials can be customized by using a different .dds file. See the readme.txt file in \Dials.
For those UIs that utilize the TDC:
- There are three versions of the TDC included - All dials, minimal dials, and no TDC (currently requires manual setup).
- 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. User has option to disable TDC on each station mentioned.
- The mod defaults to minimal dials TDC on each station.
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 'NewUIs_TDC_1_0_0_TheDarkWraith' 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 'NewUIs_TDC_1_0_0_TheDarkWraith' 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 'NewUIs_TDC_1_0_0_TheDarkWraith' 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).
All user configurable settings can be found in the file '\MODS\NewUIs_TDC_1_0_0_TheDarkWraith\data\Scripts \Menu\TheDarkWraithUserOptions.py'
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\NewUIs_TDC_1_0_0_TheDarkWraith\data\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
Polish
I urge you to play the game with the enhanced SH5 UI. I prefer this UI to even the SH3 UI (familiar 3 dials). I still haven't gotten around to fixing the problems with the SH4 UI command bar yet.
The translated versions of the menu.txt are not updated with the new additions I have added. Please feel free to translate the new additions and send to me and I will update the mod with them.
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
Reaper 7 - graphics work (emergency surface icon). He also made the Enhanced Ship ID recognition manual
Ducimus - for vision of how stock SH5 UI needed to be improved
skwasjer - digital clock
jaxa - Polish translation of menu items added in menu.txt file.
AOTD_Rhonen - officer icons
If you feel you have contributed to this mod and I have failed to recognize you please PM about it. For those I did forget to mention THANK YOU!
Current additions working on for next version:
- user setup control of TDC via options in TheDarkWraithUserOptions.py
- new bells and whistles TBD
- adding the option to remove the lock / break lock
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.0 - first official release
- made dials customizable by using a new Dials.dds file (\data\Menu\Gui)
- (SH3 UI style) 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
- fixed missing tooltips for Battery level, CO2 level, Fuel level, and compressed air level
- fixed many other missing tooltips
- 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)
- (SH3/4 UI style) added ability for dials to zoom in/out
- 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
- (SH3/4 UI style) fixed 'stuttering' problem with dials when mousing in/out
- (SH3/4 UI style) 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
- (SH3/4 UI style) 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 the behavior of the map tools side bar. The bar is now intelligent and knows when to minimize itself and when to restore itself.
- 'TAB' key cycles the mini-map between it's different states. Shift-Tab puts it in minimized state.
- (SH3/5 UI Style) 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)
- (SH3/4 UI style) Each dial (and each dial's state) has it's own zoom level. User can change these to suit their liking
- (SH3/4 UI style) Animation rate of zoom in/out can be changed by user to suit their liking
- (SH3/4 UI style) some HUD items moved so as to not interfere with items moved by this mod
- (SH3/4 UI style) 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 'emergency surface' icon and command to the depth controls sidebar (Reaper 7 updated .dds file for this)
- (SH3/4 UI style) disabled the advanced HUD mode
- 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
- (SH3/4 UI style) added ability to lock out dials from zooming. Mod defaults to all dials able to zoom.
- added the abilitiy to use TDC all dials, TDC minimal dials, or no TDC. Mod defaults to TDC minimal dials (currently a manual setup)
- (SH3/4 UI style) 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
- (SH3/4 UI style) fixed bug where dials and all would show outside of the mission game state
- (SH3/5 UI style) Added officer icons to HUD. Basic functionality of the game is restored through these officers. Click on an officer to show his available order categories (note: it is possible that some categories do now show. Conditions have to be met before they can show - i.e. under water, target locked, etc.). Click on an order category will show the available orders via a bar above them. Same applies for orders - certain conditions have to be met for them to show.
- added skwasjer's digital clock to HUD
- added Reaper 7's Enhanced ship ID recognition manual
Known Bugs:
- When in SH5 Enhanced UI style and you have the heading/rudder dial visible and you switch to another station (periscopes, uzo, map, etc.) the dial will disappear. You have to click on the heading bar again to make it re-appear. This will be addressed in next version.
******************* NOTE *********************
- Right clicking on an officer icon will put you into a situation that is out of the sub and you cannot get back in! There's no reason to be right clicking on any of them or their orders. Left click only!
TDC modes:
All dials:
minimal dials:
No dials: