Hello! This is the first release of gwater2, a revolutionary dynamic water addon for Garry's Mod.

Please read everything so you know how to install and use this addon!

------------- Role integration ---------------

Later releases will be done through discord so that you do not need to pay monthly to get updates. If in the event you do not have the 'Patron' role, simply DM me your basic info (email address & Boosty name) so I can see if you are/were subscribed and I will update you with the proper role(s)

-------------- Read Me! -----------------

Before installing I would like to say a couple of things..

1. PLEASE report bugs, issues, comments, and critique to me through patreon or in my discord (https://discord.gg/xWvhfargMY). Feedback is VERY important to me! :D

2. PLEASE do not redistribute or publicly post this anywhere (its illegal!). If I see that gwater2 has been publicly posted anywhere else online before its final release (which will be free by the way...), I will completely drop this project, and it will not be finished.

3. At the moment gwater2 does NOT work with MSAA on. This is an unintended effect caused by the source engine materialsystem. Eventually this will be fixed when I rewrite all the shaders, but as of now having it enabled breaks the water surface. Sorry

4. Multiplayer does not work! Only use gwater2 in singleplayer! Multiplayer will be fixed in a later update :)

------------- How to install -------------

1. Download the .ZIP file attached at the bottom of this post.

2. Find your GarrysMod folder, the easiest way to do this is by going to steam, right clicking the GarrysMod game in your steam library -> manage -> Browse local files

  3. Drag gwater2.zip into the recently opened GarrysMod folder and unzip its contents INTO the folder. It should ask you if you want to replace 1 (or more) files, this is intentional. If it doesn't ask, you may have done something wrong  

4. Optionally delete the .zip file, open up gmod and start playing! At the moment there is only a water gun swep (instructions found near the bottom right when holding it). and a custom menu which can be opened with (by default) the 'G' key. (This bind can be changed in the utilities tab of the gmod menu)

5. If you are a Linux user, apologies. At the moment there is not a Linux-only install. For now using Photon should suffice, however if you have experience with compiling these kinds of projects, I would be more than happy to chat (preferably with voice) and provide the source code. Feel free to contact me through patreon, or discord dm (my server: https://discord.gg/xWvhfargMY)

--------------------------- How to Uninstall ---------------------------

1. Navigate to your Garrys Mod directory (see step 2 in the installation instructions)

2. Go to GarrysMod/garrysmod/addons

3. Remove the 'gwater2' folder. The addon is now uninstalled

4. Optionally remove everything in GarrysMod/garrysmod/shaders, GarrysMod/garrysmod/lua/bin, and the FleX .dlls in GarrysMod/ for a "full" uninstall

-------- When can I expect updates, and what will be in those updates? ---------

1. At the moment, college is being a real pain and the only time I'll get to work on this project will be during breaks. This means you can expect another small update in mid-March and a bigger one around late May. You may feel free to unsubscribe from my patreon since there will not be any major development until then. (I hope you can understand?)

2. Here is the list of things you can expect in future updates:

- Cloth

- Reaction forces (water can force objects around)

- Diffuse particles (foam / bubbles)

- General optimizations

- Better isosurface estimation (smoother water surface)

- More menu options

- Editable particle limit (set the limit to any number, right now its capped to 100,000)

- Multiplayer support

- SENTS / Entities (like drain)

- Saveable presets

- Simulation accuracy settings

- Swimming

- Better under water effect

- Color mixing or some form of color blending

- Parser compatibility for all .bsp types

- Better API

3. Here is the list of ideas I have, which are in the back of my mind. Unsure if I will implement them

- Sound

- Softbodies / Rigidbodies

- Proper water lighting

- Linux compile

- Water gun model

---------------- "I can trust you... right?" -----------------

This garrysmod addon comes with something called a Binary Module. This 'module' allows native C++ to run on your computer, which basically allows direct access to the inner workings of your components. This lets me get the most performance possible out of your hardware, but you may also have (understandable) concerns about security.

A recent situation occurred not too long ago with another paid addon named "beatrun". This addon had a backdoor which publicly listed IP's of everyone who installed it.

I promise that this addon will NOT do anything other than its intended purpose. There are NO backdoors, viruses, bitcoin miners, trackers, whatever. This mod only provides the soul purpose of simulating and rendering dynamic fluids, and nothing else.

If interested, the source code of this project will eventually be public. You may backtrace in the github repo and view the source code during the time of this release.

Thanks for reading, and have fun!