MrCrayfish/MrCrayfishFurnitureMod-Refurbished

refurbished_furniture_banner requires_framework forge fabric neoforge

About

Introducing the next generation of MrCrayfish's Furntiure Mod, built from the ground up with brand new blocks, models, original sounds, and gameplay mechanics. Experience the new yet familiar charm of the original mod, and furnish your house with the hundreds of new and original decorational and functional blocks. Jump into new gameplay mechanics with the introduction of the electricity system to power all your appliances and electronics. Take control of the mod, now featuring integration for CraftTweaker and extensive datapack support.

Features

Adds over 440+ functional and cosmetic blocks to decorate your house!
Over 70+ original sound effects (all recorded and engineered by MrCrayfish) to fulfil your immersion.
Brand new electricity system to deliver power to appliances and other electronics. Includes electricity generators, lightswitches, lights, and much more!
A working mail delivery system that allows you to send and recieve items into your own mailbox.
A fully functional computer block that has fun and useful apps.
Support for CraftTweaker, Just Enough Items and Farmer's Delight (Pot and Skillet can be used on Stove)

Building

Prerequisites

You will need to add a GitHub user and personal token to your gradle environment in order to access the required dependencies for building. This should be added as properties into the gradle.properties file located in the GRADLE_USER_HOME directory.

Add the following properties:

gpr.user=<USERNAME>
gpr.key=<GITHUB_PERSONAL_TOKEN>

Data Generation

Generated files such as crafting recipes, blockstates, models, etc are not available out of the gate. You will need to generate them yourself before you build the mod. If you do not generate them, the outputed mod will be missing required data.

Run the following command to generate the data for each respective modloaders subproject

./gradlew :forge:Data :fabric:runDatagen :neoforge:runData

Building the JAR

To build the mod, simply run the following command. This will produce an artifact for common and all the modloader subprojects. The outputted artifacts will be located in <subproject>/build/libs.

./gradlew build

If you would like to target a specific modloader, you can simply run:

./gradlew :<modloader>:build

You can also generate the data in the same command

./gradlew :forge:Data :fabric:runDatagen :neoforge:runData  build

It is important to note that if you build the mod yourself, you will have an unsigned version of the mod. This just means that others will not be able to confirm if the mod has been modified. The officially hosted versions on mrcrayfish.com, CurseForge, and Modrinth have been signed will a private key.

License

The source code of MrCrayfish's Furniture Mod: Refurbished is available under MIT. The Assets are unlicensed and MrCrayfish reserves all rights to them. The Assets are files within the following directories:

src/common/main/resources/assets
src/forge/main/resources/assets
src/fabric/main/resources/assets
src/neoforge/main/resources/assets

You can build the mod from source and include the Assets, however it can only be used strictly for personal use, distribution is not allowed. Versions of the mod without the Assets fall under the terms of MIT. If you have any inquiries on the usage of the Assets, submit a ticket in the Discord Server under #mod-support.

Unmodified versions of MrCrayfish's Furniture Mod: Refurbished may be distributed in a CurseForge or Modrinth modpack. You are free to change configuration files and include datapacks for the interest of providing a custom modpack experience without it counting towards a modified version of the mod.

MrCrayfish loves to see community content. You are allowed to create reviews, share gameplay, and develop addons for the mod. Attribution is not required, however linking back to the official project pages is appreciated. Also feel free to share your creations wth MrCrayfish, either on X (@MrCrayfish) or the Discord Server.

License notices can be found in LICENSE and ASSETS_LICENSE in the source files above. They are also packaged with the JAR file for every build of the mod.