A mod that lets you pick and change sonar overlays without swapping out mods and avoids the downfalls of XML override mods. Something I noticed when looking for a simple mod that added clock positions to the sonar since when I play with friends we use clock callouts and I'm dumb and keep getting 3 and 9 mixed up.
This mod changes the texture as the objects load in instead of needing an constantly updated XML file. I initially made it just for my own texture but decided "Why can't I make it swap and choose between other textures?"
Adding a GUI to this would balloon the code 3-or-4-fold so it's a console command for now. I want to work on another mod now but if I revisit this I'd redo the code to be able to customise more parts of the sonar UI. This was my first lua mod so it's a 2-day rushed mess. I referenced code from other mods but it does the job.
If you would like me to remove a texture or have a texture you want included, feel free to get in contact. Any problems, please let me know. Hope you find this useful.
How to use:
By default this mod will change all Sonar overlays to my modified oClock overlay. (Yay nepotism)
You can change this using the console (F3 by default while in a server lobby or mission) and typing
sonaroverlay list
to see a list of available overlays by names and numbers. You can then type
sonaroverlay <choice>
replacing <choice> with any name or number to switch to that overlay.
Due to the way this mod works, changes won't apply till you go to the next mission/level/round. Sorry.
Currently Included Overlays:
- Default[list]
- The Barotrauma default sonar overlay, if you need it.
[*] oClock[list]
[*] Triiodine's oClock Radar overlay. Useful if you use clock callouts to your gunners.
[/list]
[*] oClockNumbers[list]
[*] My edit of the oClock overlay with just the numbers.
[/list]
[*] Degree[list]
[*] Triiodine's DegreesRadar overlay. Contains bearings and ship side names.
[/list]
[*] DegreeSideless[list]
[*] My edit removing the side names to remove a little clutter.
[/list]
[*] ImmersiveGreen[list]
[*] Immersive Sonar UI's Nav Terminal overlay. An interesting overlay combining bearing and clock positions.
[/list]
[*] ImmersiveBlue[list]
[*] Now in Blue! Immersive Sonar UI's Shuttle UI.
[/list]
[*] ImmersiveOrange[list]
[*] And Orange! Immersive Sonar UI's Monitor UI
[/list]
[*] ImmersivePurple[list]
[*] My Purple edit of the Immersive Sonar UI. Because I like Purple
[/list]
[*] ImmersiveNeutral[list]
[*] My Neutral edit of the Immersive Sonar. To match the default beige for those you don't want the bright colours. Inspired by Minimax.
[/list]
[*] ImmersiveOrangeDim[list]
[*] Immersive Sonar Dim Orange edit by Minimax
[/list]
[*] ImmersiveGreenDim[list]
[*] Immersive Sonar Dim Green edit by Minimax
[/list]
[*] ImmersivePurpleDim[list]
[*] Immersive Sonar Dim Purple edit by Minimax
[/list]
[*] ImmersivePink[list]
[*] Immersive Sonar Pink edit by Minimax
[/list]
[*] ImmersiveWhite[list]
[*] Immersive Sonar White edit by Minimax
[/list]
[*] ImmersiveDark[list]
[*] Immersive Sonar Dark edit by Minimax
[/list]
[*] ImmersiveNeon[list]
[*] Immersive Sonar Neon edit by Minimax
[/list]
[*] ImmersivePurplePink[list]
[*] Immersive Sonar Purple & Pink Gradient edit by Minimax
[/list]
[*] ImmersivePinkBlue[list]
[*] Immersive Sonar Pink & Blue Gradient edit by Minimax
[/list]
[*] ImmersiveSunset[list]
[*] Immersive Sonar Sunset Gradient edit by Minimax
[/list]
[/list]
- 0 / Off[list]
- If you need to disable the mod for some reason, maybe to go back to an XML mod's overlay but don't want to or can't go to the Main Menu because you're in a campaign
[/list]
[hr]This is a Clientside-only Lua mod this does not need to be on the server to work.
Installing Client-side Lua:
You can tell if it's already installed if you see this in the top left of the Main Menu.
- Open hosting menu
- Select LuaForBarotrauma in ServerExecutable and host a server
- While hosting, open the console window (most commonly 'F3')
- Type in or copy, then execute the console command:
install_cl_lua
(Video if you don't understand the instructions above: https://www.youtube.com/watch?v=wEeJ70vH1TM )
Credits:
oClockRadar / Sonar [Alt Appearance] by Triiodine
DegreeRadar / Sonar by Triiodine
Immersive Sonar UI by _]|M|[_
Storiage Icons by Dr. Turtle for the config file code and a handy mod.
Velocity Indicator by Jericho another handy mod and code gave me a good start point for this mod.
Minimax for contributing some extra Immersive Sonar variants and touching up existing ones.
