Coder Social home page Coder Social logo

esca-mmc / destroyablebushes Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 4.0 115 KB

A mod for the game Stardew Valley, allowing players to destroy every type of bush with an upgraded axe. Requires the SMAPI mod loader.

Home Page: https://www.nexusmods.com/stardewvalley/mods/6304

License: Other

C# 100.00%
stardew-valley stardew-valley-mods csharp

destroyablebushes's Introduction

Destroyable Bushes

A mod for the game Stardew Valley, allowing players to destroy every type of bush with an axe. Destroyed bushes drop small amounts of wood and respawn after 3 days by default. These features can be customized in the config.json file.

Contents

Installation

  1. Install the latest version of SMAPI.
  2. Download Destroyable Bushes from the Releases page on GitHub, Nexus Mods, or ModDrop.
  3. Unzip Destroyable Bushes into the Stardew Valley\Mods folder.

Multiplayer notes:

  • This mod should affect each player separately. Players who want to destroy bushes should install Destroyable Bushes and customize their own options as needed.
  • The host player's "WhenBushesRegrow" setting will be used.

Options

Destroyable Bushes includes options to limit where bushes can be destroyed, change the speed at which bushes regrow, and change the amount of wood dropped by each type of bush.

To edit these options:

  1. Run the game using SMAPI. This will generate the mod's config.json file in the Stardew Valley\Mods\DestroyableBushes folder.
  2. Exit the game and open the config.json file with any text editing program.

This mod also supports spacechase0's Generic Mod Config Menu (GMCM). Players with that mod will be able to change config.json settings from Stardew's main menu.

The available settings are:

Name Valid settings Description
AxeUpgradesRequired A positive integer (default 0) The number of axe upgrades required to destroy bushes. 0 allows any axe to remove bushes, 1 requires a copper axe or better, and so on.
AxeDamageMultiplier A decimal (default 1.0) A damage multiplier applied when hitting a non-tea bush. 0.5 deals 50% less damage, 2 deals 200% damage, 8 destroys bushes in 1 hit, etc. Note that to avoid bugs, walnut bushes always take at least 2 hits.
WhenBushesRegrow An integer and a unit of time, e.g. "3 days" (or null to never regrow bushes) If the unit is "days", bushes will respawn after that number of days. "Seasons" (or "months") will respawn bushes after that many seasons (on the first day of the season). "Years" will respawn bushes after that many years (on the first day of Spring).
DestroyableBushLocations A list of location names, e.g. ["farm", "forest", "woods"] A list of locations where bushes will be destroyable. If the list is blank, bushes will be destroyable at all locations. Names should be in quotation marks and separated by commas. To find a location's name, you may need to use another mod such as Debug Mode.
DestroyableBushTypes N/A The settings below control which types of bush will be destroyable.
SmallBushes true or false If true, small bushes will be destroyable.
MediumBushes true or false If true, medium bushes will be destroyable. These are the type that can produce berries.
LargeBushes true or false If true, large bushes will be destroyable.
WalnutBushes true or false If true, walnut bushes will be destroyable.
AmountOfWoodDropped N/A The settings below control how many pieces of wood are dropped by each bush type when destroyed. Players with the Forester profession will receive 25% more wood.
SmallBushes A positive integer (default 2) The number of wood pieces dropped by small bushes when destroyed.
MediumBushes A positive integer (default 4) The number of wood pieces dropped by medium bushes when destroyed.
LargeBushes A positive integer (default 8) The number of wood pieces dropped by large bushes when destroyed.
WalnutBushes A positive integer (default 4) The number of wood pieces dropped by walnut bushes when destroyed.
GreenTeaBushes A positive integer (default 0) The number of wood pieces dropped by green tea bushes when destroyed.

Commands

This mod adds the following commands to SMAPI's console. They require the Console Commands mod, which is installed automatically by SMAPI.

add_bush

The add_bush command creates a bush of the specified size. Bushes added by this command will regrow if that setting is enabled.

Usage: add_bush <size> [x y] [location]

  • size: The bush's size, as a name or number. 0 = "small", 1 = "medium", 2 = "large", 3 = "tea", 4 = "walnut".
  • x y (optional): The bush's tile coordinates. If not provided, the bush will appear in front of the player.
  • location (optional): The name of the bush's map, e.g. "Farm". If not provided, the player's current map will be used.

Examples:

  • add_bush 2
  • add_bush large
  • add_bush 2 64 19
  • add_bush 2 64 19 farm

remove_bush

The remove_bush command removes a bush from the specified location. Bushes removed by this command will NOT regrow.

Usage: remove_bush [x y] [location]

  • x y (optional): The bush's tile coordinates. If not provided, a bush will be removed on, or in front of, the player.
  • location (optional): The name of the bush's map, e.g. "Farm". If not provided, the player's current map will be used.

Examples:

  • remove_bush
  • remove_bush 64 19
  • remove_bush 64 19 farm

Translation

Destroyable Bushes supports translation of its Generic Mod Config Menu (GMCM) setting names and descriptions.

The mod will load a file from the DestroyableBushes/i18n folder that matches the current language code. If no matching translation exists, it will use default.json.

See the Stardew Valley Wiki's Modding:Translations page for more information. Please feel free to submit translation files through GitHub, Nexus Mods, ModDrop, or Discord.

Available Languages

Language File Contributor(s)
English default.json Esca-MMC
Brazilian Portuguese pt.json GremilinDHamelin
French fr.json Fsecho7
German de.json 777PamPam777
Japanese ja.json tikamin557
Korean ko.json wally232
Simplified Chinese zh.json sanyao1001 and ichbinaprogrammer
Turkish tr.json Rupurudu

destroyablebushes's People

Contributors

esca-mmc avatar ichbinaprogrammer avatar rupurudu avatar sanyao1001 avatar wally232 avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.