GithubHelp home page GithubHelp logo

esca-mmc / transparencysettings Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 0.0 65 KB

A mod for the game Stardew Valley, increasing the object transparency range around players and adding customization options. Requires the SMAPI mod loader.

License: Other

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

transparencysettings's Introduction

Transparency Settings

A mod for the game Stardew Valley that allows players to customize the distance at which trees, buildings, and various other objects become transparent. The mod generates a config.json file with detailed options and key bindings.

Contents

Installation

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

Settings

Transparency Settings includes settings that control the distance and conditions for each object type to become transparent. It also includes customizable key bindings for some transparency toggle buttons. GMCM is recommended for easier customization (see below).

To edit these settings:

  1. Run the game using SMAPI. This will generate the mod's config.json file in the Stardew Valley\Mods\TransparencySettings 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 the settings with in-game menus.

Object Type Settings

These settings customize the behavior of each object type that can become transparent.

Note: Some objects can't be made transparent by this mod. Non-interactive objects "drawn" directly on the in-game maps, like town buildings or some trees/bushes, won't be affected.

Name Valid settings Description
Enable true or false If true, these objects will use your custom transparency settings. If false, they will use Stardew's default transparency system.
BelowPlayerOnly true or false If true, these objects will only be transparent when they are "below" the player's vertical position.
TileDistance Any integer, e.g. 5 These objects will be transparent while the player is within this number of tiles. Setting this to a negative number will disable transparency completely (e.g. "TileDistance": -1).
MinimumOpacity A decimal from 0 to 1, e.g. 0.4 This is how transparent objects can be. 0 is completely transparent, and 1 is completely visible.

Key Bindings

These settings allows players to customize the key bindings for this mod's transparency toggle buttons.

These settings use SMAPI's Multi-key bindings system. For more information about valid button names, refer to the wiki's Key Bindings page.

Name Default binding Description
DisableTransparency None Disables all custom transparency, reverting to Stardew's default system. Press it again to re-enable your custom settings.
FullTransparency None Enables maximum transparency, making all valid object types transparent regardless of distance. Press it again to re-enable your custom settings.

Translation

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

The mod will load a file from the TransparencySettings/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
French fr.json Caranud

transparencysettings's People

Contributors

esca-mmc 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.