GWater – Dynamic Water [v1.4]

If you liked this item, please rate it up on Steam Workshop page.

Authors: andreweathan, Mee

Last revision: 11 Apr, 2022 at 00:10 UTC

File size: 7.01 MB

On Steam Workshop

Description:
(IMPORTANT!) PLEASE READ THE ENTIRE DESCRIPTION!

IN ORDER TO USE THIS ADDON YOU WILL NEED A BINARY MODULE! (found here)[github.com]
WE CANT BUNDLE THE MODULE WITH THE ADDON DUE TO WORKSHOP RESTRICTIONS!
IF YOU CANNOT FIGURE OUT HOW TO INSTALL IT, ASK QUESTIONS IN THIS DISCORD[discord.gg]
WARNING/NOTICE: THIS MOD IS NOT MADE FOR LOW SPEC COMPUTERS DUE TO THE COMPUTATIONAL POWER REQUIRED TO SIMULATE WATER. NVIDIA FLEX DOES A GOOD JOB AT NOT OVERHEATING YOUR GPU, HOWEVER IF YOU DO NOT HAVE ADEQUATE COOLING TO YOUR COMPONENTS IT *WILL* FRY THEM. WE DO NOT TAKE RESPONSIBILITY IF ANY OF YOUR COMPONENTS SHUT DOWN OR OVERHEAT BECAUSE OF THIS MOD. WE DO NOT WANT TO KILL YOUR COMPONENTS AND IT IS HIGHLY UNLIKELY THAT ANYTHING BAD WILL HAPPEN, BUT PLEASE KEEP THIS IN MIND.

(ALSO PRETTY IMPORTANT)

Due to the computing power needed to calculate water in real-time, GWater needs a half-decent GPU (my gpu is a Radeon R7 240 and FPS starts to go low at 6k particles and more, but Mee’s GPU can handle way more and not drop a lot of frames)
We don’t guarantee this will run well for you, but you can avoid getting stuck at low fps with a high particle count by turning down the particle limit or using the alternative rendering in the menu.
Because the rendering is done in LUA (instead of C++), rendering water will likely be laggy. If someone with experience with source shaders could help, that would be awesome.

GWater is an addon that lets you spawn real time, intractable flowing water in-game!
It comes with a custom menu, where you can change nearly everything about it to get the best experience you want.
It also comes with a little support to develop addons that use GWater, for the fellow LUA nerds out there!

Setting it up may seem complicated, but if you follow the instructions (and have a good enough pc!), you’ll be able to use it in no time!
Please note that this addon isnt perfect, it may cause crashing and/or low framerates

Things to note
  1. World collisions will not work properly on some surfaces of the map, blame Garry for not fixing surfaceinfos
  2. This addon will not work properly without the binary module, the module is the heart of the water simulation! (installation steps below) (you also need to subscribe to the addon)
  3. As of now, water will only collide with props, but we may add support for things like ragdolls/players in the future!
  4. As of now, GWater only works on the Windows OS (However, it is possible to get it on linux using something called “Proton”)

HOW TO INSTALL THE MODULE:

Method 1:

  1. Go to the GitHub repository for GWater (link is at the bottom & top)
  2. Go to the releases tab and download the GWater installer (gwater.exe)
  3. Close the game in case you haven’t already.
  4. Run the installer and press "Install". The installer will automatically detect where to install GWater for you, and where to place each DLL!

If you don’t trust the installer (or it somehow fails), you can always set it up manually!
Method 2: (the manual way)

  1. Go to the releases tab and download the GWater zip.
  2. Extract its contents to a folder
  3. Move everything except the gmcl_GWater dlls to your "GarrysMod" folder
  4. Move the gmcl_GWater dlls to the GarrysMod/garrysmod/lua/bin folder (create it if it doesn’t exist)

DOWNLOAD CAN BE FOUND HERE![github.com]
If you need help installing, ask in this discord server![discord.gg]

FAQ:

Q: I crash when I go to singleplayer! Why?
A: You may not meet the minimum requirements to run Nvidia FleX (or have a conflicting addon)
-NVIDIA: GeForce Game Ready Driver 372.90 or above
-AMD: Radeon Software Version 16.9.1 or above
if you do not have these graphics cards or higher, it will not run!
https://gameworksdocs.nvidia.com/FleX/1.2/lib_docs/index.html#requirements

Q: Why do I need to download something?
A: Similar to VRMOD, the water requires an external module in order to simulate the particles and effectively use the GPU to calculate them.

Q: Where is the menu?
A: Type gwater_menu in console, or go to the utilities tab and find GWater, there should be a button to open the menu

Q: Will GWater work on *OS other than windows*?
A: Honestly, we don’t know how to compile it for Linux so if anyone could help us with that, it would be awesome, I have seen some people use something called “proton” (on linux) which works perfectly fine. Mac support will never be added due to macs generally being terrible, and Nvidia FleX doesnt support it.

Q: Why doesnt my water collide with the map?
A: Garry sadly did not provide us with enough data from the map to effectively get 100% collision, this means that water will not collide with displacements and some map surfaces

Q: How can source handle this much?
A: It cant, the particles are being calculated externally on your GPU

Q: Where is the installer?
A: on the github… in releases tab… on the right sidebar…

Q: lua/autorun/gwater_main.lua:26: Couldn’t load module library!
A: make sure to update the module or install it correctly
(also try restarting gmod a couple times, sometimes it loads improperly)

Servers (that i know of) that have it installed:
DServers[discord.com]

EXTRAS:
Playlist of GWater development videos
THE TRAILER! (ALSO HAS LINKS)

Credits:
Code and References

Kodya: Helped make swimming good
Neatro: Helped fix holes in the world collision
– PotatoOS: We used references from his collision code
Nvidia’s FleX Library[github.com]

Translations
Russian:

Kodya
With small corrections by [RUS/ENG] Jackal and matohin

Turkish:

Hikan-Teki

Romanian:

andreweathan

FINAL NOTE: we are no longer supporting this addon because of its laggy and impractical use. all your questions likely can be answered by re-reading the description, looking at the tutorial, or searching in the gwater discord. Thank you.
-andrew & mee