Skip to content

Commit f3d4bea

Browse files
authored
Added README
README yipee!
1 parent 89ea8a5 commit f3d4bea

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Weather Gains
2+
3+
![Thunderstore Version](https://img.shields.io/thunderstore/v/RobuxTrex/Weather_Gains?style=for-the-badge&logo=thunderstore&logoColor=white)
4+
![Thunderstore Downloads](https://img.shields.io/thunderstore/dt/RobuxTRex/Weather_Gains?style=for-the-badge&logo=thunderstore&logoColor=white)
5+
6+
Weather Gains is a flexible mod which allows you to multiply the value and quantity of scrap based on the weather.
7+
8+
I suggest that the values in the configuration are reviewed and tweaked based on your preferences. I believe that
9+
the values provided are balanced, but your mileage may vary!
10+
11+
## Features
12+
- Ability to modify the **credit values of scrap** based on the active weather;
13+
- Ability to modify the **amount of scrap** based on the active weather;
14+
- Ability to modify the **value of the Apparatus (Lung) prop** based on the active weather;
15+
- Extremely detailed configuration which allows you to change basically anything about the mod;
16+
- Supports **all** weather types that are currently in Lethal Company (including clear/no weather);
17+
- *May* support other mods that modify the scrap values/amount;
18+
- Open sourced on GitHub
19+
- Tested and functional on v65+ (may work for many older versions, but **use at your own risk**)
20+
21+
## License + Source Code
22+
This mod is distributed under the **GNU General Public Licence v3**. For more information, please read the `LICENSE.md` file (press the `Manual Download` button and extract the `.zip`).
23+
24+
Furthermore, you may review the source code of this mod on GitHub. Pull Requests and Code Modifications are appreciated and will be actively reviewed.

0 commit comments

Comments
 (0)