diff --git a/Thunderstone/BloodRefill/README.md b/Thunderstone/BloodRefill/README.md new file mode 100644 index 0000000..448ee07 --- /dev/null +++ b/Thunderstone/BloodRefill/README.md @@ -0,0 +1,39 @@ +# Blood Refill +A server-side only mod that allows players to refill their blood pool. + +When feed-killing an enemy, you'll be able to regain some blood. +The amount of blood regained is based on the level difference, blood type and blood quality of the killed enemy with V-Bloods refilling your blood pool for a much larger amount. + +
+Configuration Options + +* Enable/disable requiring feed-killing (when disabled, any kill grants some blood). +* Choose the amount of blood gained on a 'regular refill' (i.e. a refill without any level, blood type or quality punishments applied) +* A multiplier to reduce the amount of gained blood when feeding on an enemy of a different blood type. (blood dilution) +* The ability to disable different blood type refilling (i.e. a 0 multiplier for different blood types) +* Switch between having V-Blood act as diluted or pure blood, or have V-Blood completely refill your blood pool +* The options to make refilling random between 0.1L and the calculated amount (which then acts as a max refill amount) +* A global refill multiplier (applied after picking a random refill value) + +
+ +## How to manually install +* Install [BepInEx](https://v-rising.thunderstore.io/package/BepInEx/BepInExPack_V_Rising/) +* Install [Wetstone](https://v-rising.thunderstore.io/package/molenzwiebel/Wetstone/) +* (Locally hosted games only) Install [ServerLaunchFix](https://v-rising.thunderstore.io/package/Mythic/ServerLaunchFix/) +* Extract the Vmods._mod-name_.dll +* Move the desired mod(s) to the `[VRising (server) folder]/BepInEx/WetstonePlugins/` +* Launch the server (or game) to auto-generate the config files +* Edit the configs as you desire (found in `[VRising (server) folder]/BepInEx/config/`) +* Reload the mods using the Wetstone commands (by default F6 for client-side mods, and/or `!reload` for server-side mods) + * If this doesn't work, or isn't enabled, restart the server/game + +## Commands +Most of the VMods come with a set of commands that can be used. To see the available commands, by default a player or admin can use `!help`. +Normal players won't see the Admin-only commands listed. +The prefix (`!`) can be changed on a per-mod basis. +To prevent spam/abuse there's also a command cooldown for non-admins, this value can also be tweaked on a per-mod basis. +Commands can also be disabled completely on a per-mod basis. + +## More Details +* [ChangeLog](https://github.com/WhiteFang5/VMods/blob/master/CHANGELOG.md#blood-refill) diff --git a/Thunderstone/BloodRefill/manifest.json b/Thunderstone/BloodRefill/manifest.json index 841614a..88371e3 100644 --- a/Thunderstone/BloodRefill/manifest.json +++ b/Thunderstone/BloodRefill/manifest.json @@ -1,5 +1,5 @@ { - "name": "VMods - Blood Refill", + "name": "VMods_Blood_Refill", "description": "A mod that allows players to refill their blood pool.", "version_number": "1.0.0", "dependencies": [ diff --git a/Thunderstone/PvPLeaderboard/README.md b/Thunderstone/PvPLeaderboard/README.md new file mode 100644 index 0000000..23179f6 --- /dev/null +++ b/Thunderstone/PvPLeaderboard/README.md @@ -0,0 +1,41 @@ +# PvP Leaderboard +A server-side only mod that keeps track of Kills, Death and the K/D ratio of players and ranks them in a leaderboard. + +This mod also has the option to exclude low-level (or grief-kills) from counting towards the K/D of the leaderboard. +There's also an option to prevent cheesing this restriction where the highest gear score (in the past X minutes) is used instead of the current gear score. +Both legitimate and grief-kills can be announced server-wide. + +Players can see their own stats and the leaderboard itself using a command (By default: `!pvpstats`). +The leaderboard shows up to 5 ranks at a time and allows players to input a page number so they can "browse" the leaderboard (By default: `!pvplb []`). + +
+Configuration Options + +* Enable/disable announcing of legitimate kills +* Enable/disable announcing of grief-kills +* Set a Level Difference at which the K/D isn't counting anymore of the leaderboard. +* Enable/disable usage of the anti-cheesing system (highest gear score tracking) +* Change the amount of time the highest gear score is remembered/tracked + +
+ +## How to manually install +* Install [BepInEx](https://v-rising.thunderstore.io/package/BepInEx/BepInExPack_V_Rising/) +* Install [Wetstone](https://v-rising.thunderstore.io/package/molenzwiebel/Wetstone/) +* (Locally hosted games only) Install [ServerLaunchFix](https://v-rising.thunderstore.io/package/Mythic/ServerLaunchFix/) +* Extract the Vmods._mod-name_.dll +* Move the desired mod(s) to the `[VRising (server) folder]/BepInEx/WetstonePlugins/` +* Launch the server (or game) to auto-generate the config files +* Edit the configs as you desire (found in `[VRising (server) folder]/BepInEx/config/`) +* Reload the mods using the Wetstone commands (by default F6 for client-side mods, and/or `!reload` for server-side mods) + * If this doesn't work, or isn't enabled, restart the server/game + +## Commands +Most of the VMods come with a set of commands that can be used. To see the available commands, by default a player or admin can use `!help`. +Normal players won't see the Admin-only commands listed. +The prefix (`!`) can be changed on a per-mod basis. +To prevent spam/abuse there's also a command cooldown for non-admins, this value can also be tweaked on a per-mod basis. +Commands can also be disabled completely on a per-mod basis. + +## More Details +* [ChangeLog](https://github.com/WhiteFang5/VMods/blob/master/CHANGELOG.md#pvp-leaderboard) diff --git a/Thunderstone/PvPLeaderboard/manifest.json b/Thunderstone/PvPLeaderboard/manifest.json index adae35d..8f85692 100644 --- a/Thunderstone/PvPLeaderboard/manifest.json +++ b/Thunderstone/PvPLeaderboard/manifest.json @@ -1,5 +1,5 @@ { - "name": "VMods - PvP Leaderboard", + "name": "VMods_PvP_Leaderboard", "description": "A mod that keeps track of Kills, Death and the K/D ratio of players and ranks them in a leaderboard.", "version_number": "1.0.0", "dependencies": [ diff --git a/Thunderstone/PvPPunishment/README.md b/Thunderstone/PvPPunishment/README.md new file mode 100644 index 0000000..63561a3 --- /dev/null +++ b/Thunderstone/PvPPunishment/README.md @@ -0,0 +1,48 @@ +# PvP Punishment +A server-side only mod that punishes low-level kills. + +This mod also has the option prevent cheesing the low-level restriction where the highest gear score (in the past X minutes) is used instead of the current gear score. +Both the amount of offenses before being punishes as well as the punishment itself can be tweaked. + +
+Configuration Options + +* Set a Level Difference at which an offense is being recorded +* Enable/disable usage of the anti-cheesing system (highest gear score tracking) +* Change the amount of offenses a player can make before actually being punished +* Change the offense cooldown time before the offense counter resets +* Change the duration of the punishment +* Change the following for the actual punishment: + * % reduced Movement Speed + * % reduced Max Health + * % reduced Physical Resistance + * % reduced Spell Resistance + * amount of reduced Fire Resistance + * amount of reduced Holy Resistance + * amount of reduced Sun Resistance + * amount of reduced Silver Resistance + * % of reduced Physical Power + * % of reduced Spell Power + +
+ +## How to manually install +* Install [BepInEx](https://v-rising.thunderstore.io/package/BepInEx/BepInExPack_V_Rising/) +* Install [Wetstone](https://v-rising.thunderstore.io/package/molenzwiebel/Wetstone/) +* (Locally hosted games only) Install [ServerLaunchFix](https://v-rising.thunderstore.io/package/Mythic/ServerLaunchFix/) +* Extract the Vmods._mod-name_.dll +* Move the desired mod(s) to the `[VRising (server) folder]/BepInEx/WetstonePlugins/` +* Launch the server (or game) to auto-generate the config files +* Edit the configs as you desire (found in `[VRising (server) folder]/BepInEx/config/`) +* Reload the mods using the Wetstone commands (by default F6 for client-side mods, and/or `!reload` for server-side mods) + * If this doesn't work, or isn't enabled, restart the server/game + +## Commands +Most of the VMods come with a set of commands that can be used. To see the available commands, by default a player or admin can use `!help`. +Normal players won't see the Admin-only commands listed. +The prefix (`!`) can be changed on a per-mod basis. +To prevent spam/abuse there's also a command cooldown for non-admins, this value can also be tweaked on a per-mod basis. +Commands can also be disabled completely on a per-mod basis. + +## More Details +* [ChangeLog](https://github.com/WhiteFang5/VMods/blob/master/CHANGELOG.md#pvp-punishment) diff --git a/Thunderstone/PvPPunishment/manifest.json b/Thunderstone/PvPPunishment/manifest.json index baf8dc5..2453011 100644 --- a/Thunderstone/PvPPunishment/manifest.json +++ b/Thunderstone/PvPPunishment/manifest.json @@ -1,5 +1,5 @@ { - "name": "VMods - PvP Punishment", + "name": "VMods_PvP_Punishment", "description": "A mod that punishes low-level kills.", "version_number": "1.0.0", "dependencies": [ diff --git a/Thunderstone/RecoverEmptyContainers/README.md b/Thunderstone/RecoverEmptyContainers/README.md new file mode 100644 index 0000000..223ea36 --- /dev/null +++ b/Thunderstone/RecoverEmptyContainers/README.md @@ -0,0 +1,25 @@ +# Recover Empty Containers +A server-side only mod that allows players to recover empty containers. + +When a player drinks a potion or brew, an empty container (glass bottle or canteen) is given back to the player (or dropped on the floor when the player's inventory is full) + +## How to manually install +* Install [BepInEx](https://v-rising.thunderstore.io/package/BepInEx/BepInExPack_V_Rising/) +* Install [Wetstone](https://v-rising.thunderstore.io/package/molenzwiebel/Wetstone/) +* (Locally hosted games only) Install [ServerLaunchFix](https://v-rising.thunderstore.io/package/Mythic/ServerLaunchFix/) +* Extract the Vmods._mod-name_.dll +* Move the desired mod(s) to the `[VRising (server) folder]/BepInEx/WetstonePlugins/` +* Launch the server (or game) to auto-generate the config files +* Edit the configs as you desire (found in `[VRising (server) folder]/BepInEx/config/`) +* Reload the mods using the Wetstone commands (by default F6 for client-side mods, and/or `!reload` for server-side mods) + * If this doesn't work, or isn't enabled, restart the server/game + +## Commands +Most of the VMods come with a set of commands that can be used. To see the available commands, by default a player or admin can use `!help`. +Normal players won't see the Admin-only commands listed. +The prefix (`!`) can be changed on a per-mod basis. +To prevent spam/abuse there's also a command cooldown for non-admins, this value can also be tweaked on a per-mod basis. +Commands can also be disabled completely on a per-mod basis. + +## More Details +* [ChangeLog](https://github.com/WhiteFang5/VMods/blob/master/CHANGELOG.md#recover-empty-containers) diff --git a/Thunderstone/RecoverEmptyContainers/manifest.json b/Thunderstone/RecoverEmptyContainers/manifest.json index f7414f2..ecc1f3a 100644 --- a/Thunderstone/RecoverEmptyContainers/manifest.json +++ b/Thunderstone/RecoverEmptyContainers/manifest.json @@ -1,5 +1,5 @@ { - "name": "VMods - Recover Empty Containers", + "name": "VMods_Recover_Empty_Containers", "description": "A mod that allows players to recover empty containers when drinking potions or brews.", "version_number": "1.0.0", "dependencies": [ diff --git a/Thunderstone/ResourceStashWithdrawal/README.md b/Thunderstone/ResourceStashWithdrawal/README.md new file mode 100644 index 0000000..3082a13 --- /dev/null +++ b/Thunderstone/ResourceStashWithdrawal/README.md @@ -0,0 +1,28 @@ +# Resource Stash Withdrawal +A server & client side mod that allows players to withdraw items for a recipe directly from their stash. + +When a player is at a crafting or other workstation, he/she can click on the recipe or an individual component of a recipe with their middle-mouse button to withdraw the missing item(s) directly from their stash. +(The withdraw the full amount, CTRL+Middle Mouse Button can be used) + +Note: Players without the client-side mod can still join and play the server, but won't be able to make use of this feature. + +## How to manually install +* Install [BepInEx](https://v-rising.thunderstore.io/package/BepInEx/BepInExPack_V_Rising/) +* Install [Wetstone](https://v-rising.thunderstore.io/package/molenzwiebel/Wetstone/) +* (Locally hosted games only) Install [ServerLaunchFix](https://v-rising.thunderstore.io/package/Mythic/ServerLaunchFix/) +* Extract the Vmods._mod-name_.dll +* Move the desired mod(s) to the `[VRising (server) folder]/BepInEx/WetstonePlugins/` +* Launch the server (or game) to auto-generate the config files +* Edit the configs as you desire (found in `[VRising (server) folder]/BepInEx/config/`) +* Reload the mods using the Wetstone commands (by default F6 for client-side mods, and/or `!reload` for server-side mods) + * If this doesn't work, or isn't enabled, restart the server/game + +## Commands +Most of the VMods come with a set of commands that can be used. To see the available commands, by default a player or admin can use `!help`. +Normal players won't see the Admin-only commands listed. +The prefix (`!`) can be changed on a per-mod basis. +To prevent spam/abuse there's also a command cooldown for non-admins, this value can also be tweaked on a per-mod basis. +Commands can also be disabled completely on a per-mod basis. + +## More Details +* [ChangeLog](https://github.com/WhiteFang5/VMods/blob/master/CHANGELOG.md#resource-stash-withdrawal) diff --git a/Thunderstone/ResourceStashWithdrawal/manifest.json b/Thunderstone/ResourceStashWithdrawal/manifest.json index 26aef46..94a7069 100644 --- a/Thunderstone/ResourceStashWithdrawal/manifest.json +++ b/Thunderstone/ResourceStashWithdrawal/manifest.json @@ -1,5 +1,5 @@ { - "name": "VMods - Resource Stash Withdrawal", + "name": "VMods_Resource_Stash_Withdrawal", "description": "A mod that allows players to withdraw items for a recipe directly from their stash.", "version_number": "1.0.0", "dependencies": [