peacedevwastaken / dynamicsurroundingsfabric Goto Github PK

Dynamic Surroundings: Fabric Edition

A Minecraft Fabric Mod that alters the fabric of Minecraft experience by weaving a tapestry of sound and visual effects.

This mod is a successor to the Forge-based Dynamic Surroundings series. Though a lot of the functionality is similar, the ultimate feature set will be different. My focus is on extending the Vanilla aspect of gameplay rather than introducing anything radical. Microsoft is adding features to Minecraft filling the gaps that Dynamic Surroundings have tried to address. I expect this trend to continue.

Minecraft 1.20.4 Requirements

• JAVA 17+ (I am using Adoptium https://adoptium.net/)
• Fabric Loader >=0.15.1
• Fabric API 0.91.2+1.20.4
• 100% client side; no server side deployment needed

Minecraft 1.20.1 Requirements

• JAVA 17+ (I am using Adoptium https://adoptium.net/)
• Fabric Loader >=0.14.22
• Fabric API >=0.91.0+1.20.1
• 100% client side; no server side deployment needed

Recommended Additions

• For Config UI support, either:
  • Cloth Config API (CurseForge) or (Modrinth)
  • YetAnotherConfigLib (YACL) (CurseForge) or (Modrinth) - Only for the 1.20.4 version
  • If neither are installed, mod configuration will not be available in game.
• Mod Menu (Modrinth) to get in-game mod configuration menu listings.
• Presence Footsteps (Modrinth) for footstep acoustics

Videos

• Steam, Fire Jets, and Waterfalls (YouTube)
• Cave Reverb (YouTube)
• Having a wander (YouTube)

Features

• Enhanced Sound processing - performs calculations in the background, adding a reverb effect to spacial sounds.
• Individual Sound Control - Set key bind and activate in-game. Use this feature to block, cull, and control the volume at which sounds play. And as a bonus, you can play the sound to hear it.
• Biome sounds - Atmospheric sounds that play based on biomes in the area. Seamless blending of sounds as the player moves throughout the world.
  • This does not replace the Minecraft feature of a singular biome background sound. Currently, the various biomes in the Nether use this capability. Dynamic Surroundings does not provide sound configurations for that dimension.
• Hot block effects such as flame jets over lava, and steam where water hits a hot block.
  • Hot blocks are things like Lava and Magma.
• Waterfall sound and visual effect - will trigger when flowing water is detected nearby.
• Replace Minecraft's thunder sound with improved versions.
• Various "DS" client side commands for dumping configuration information. (I currently use these while developing. I do plan to document at some point for general use.)
• Custom debug HUD that can be accessed by key bind. Moves the Dynamic Surroundings clutter out of the traditional F3 display.

Embedded Jars

• OpenJDK Nashorn JavaScript Engine 15.4 (https://github.com/openjdk/nashorn)

FAQ

• Will additional features from the Forge version be integrated into the Fabric version?
  • See below.
• Will there be updates for the Forge/NeoForge loaders?
  • Forge - a good chance.
  • NeoForge - Maybe. Forge and NeoForge are diverging, and I am not sure of the impacts on Dynamic Surroundings yet.

What's Being Dropped

• Aurora. Good at turning a computer into a space heater, and I do not know enough about shaders to improve.
• Specialized fog effects. Minecraft has made some improvements in this area, and I expect it to continue. I don't want to be in a position of overriding (or managing the problem) of when Microsoft adds more dynamic content.
• Weather effects. Again, there have been improvements to Minecraft. I may add some additional processing around weather, but I do not expect to make major changes.

As I indicated, these features are not planned. Based on time commitments, I may change my mind. :)

Planned Features

• Making the config system publicly available so that pack authors can configure things. This is possible with this release, but I may change things. Besides, it has to be documented so that someone would know what to do.

License

The MIT License (MIT)

Copyright (c) 2023-2024 OreCruncher

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.