swingthevine/qsand-minecraft

A mod that adds quicksand and dungeons to Minecraft.

QuickSand And Numerous Dungeons (QSAND)
How Versioning Works
Licenses
Overview
Some Examples
FAQ
Gradle Issue
Resources

QuickSand And Numerous Dungeons (QSAND)

How Versioning Works

The versioning system for this mod follows the Semantic Versioning rules. As such, it is formatted in an X.Y.Z format where:

• X is the major version. This is incremented when a non-backward compatible update is pushed. This is for new features.
• Y is the minor version. This is incremented whenever I push to GitHub. This is for stable bug-fixes.
• Z is the patch version. This is incremented whenever I launch Minecraft to test a patch. This is for unstable bug-fixes/features.

The versioning system for names and releases of versions of this mod are formatted in an A.B.C-X.Y.Z format where A.B.C is the Minecraft version.

Licenses

Overview

(Below, mentions of this "Project" is referring to this Minecraft mod)
Most of this Project is licensed under the GNU General Public License v3.0 (GNU GPLv3.0). All software, code, models, and libraries in this repository are licensed under the GNU GPLv3.0 license. However all media (images, videos, and sounds) in this Project is licensed under the Creative Commons Attribution Share Alike 4.0 International (CC-BY-SA-4.0) license. Trademarks of this Project can be used without permission from the author(s) of this Project except for when using the trademark would imply that you are connected with, or sponsored, endorsed, or granted official status by, the author(s) of this Project.

Basically, you can use this Project as long as:

• You do disclose that your source was this Project (and provide a reference to the Project).
• You do use the same license when modifying this Project.
• You do document the changes made when modifying this Project.
• You don't re-upload an unmodified version of this Project.
• You don't claim to be this Project or it's author(s).
• You don't violate the licenses.

Some common edge cases are outlined below.

Some Examples

The Project (or any parts of the Project) can be used in this non-exhaustive list of scenarios. All mentions of "trademarks" refer to media that is used to identify the Project. All mentions of "media" in this list below include trademarks being used in a way that does not imply that you are connected with, or sponsored, endorsed, or granted official status by, the author(s) of this Project. This list is merely an example. If there are conflicts between this list and the licenses, the licenses should be followed.

As A User Or Content Creator:

Permitted _{Click to expand}

Permitted: You include this Project in a modpack. You include a reference to this Project.

Permitted: You use this Project to display/showcase this Project.

Permitted: You use media from this Project to display/showcase this Project. You include the license to the media (CC-BY-SA-4.0).

Permitted: You distribute unmodified copies of this Project. You include a reference to this Project.

Permitted: You gain a monetary benefit without violating the Project's licenses.

Forbidden _{Click to expand}

Forbidden: You include this Project in a modpack. You don't add a reference to this Project. (You must reference this Project as a source)

Forbidden: You use media from this Project to display/showcase this Project. You don't add the license to the media (CC-BY-SA-4.0). (A license for the media must be included somewhere)

Forbidden: You distribute unmodified copies of this Project. You don't add a reference to this Project. (You must reference this Project as a source)

Forbidden: You upload an unmodified version of this Project to a Minecraft-related website, archive, etc. Faithful recreations (unmodified, updated versions) of the Project that run on a version of Minecraft the Project does not support at the time of the upload are permitted. (You are not permitted to use the trademarks of this Project in this manner unless it is a faithful recreation that runs on a version of Minecraft the Project does not support at the time of the upload)

As A Developer:

Permitted _{Click to expand}

Permitted: You gain a monetary benefit without violating the Project's licenses.

Permitted: You create your own open-source mod and include parts of this Project in your mod. You license the entire mod under the GNU GPLv3.0 (or a later version of this) license.

Permitted: You create your own open-source mod and include parts of this Project in your mod. You license the parts of this Project under the GNU GPLv3.0 (or a later version of this) license. You license the rest of the mod under a different license.

Permitted: You create your own closed-source mod and include parts of this Project in your mod. You license the entire mod under the GNU GPLv3.0 (or a later version of this) license.

Permitted: You create a open-source derivative (modified version) of this Project, extending the Project's functionality whilst including the entire Project inside your derivative. You include a reference to this Project. You license the entire derivative under the GNU GPLv3.0 (or a later version of this) license.

Permitted: You create a open-source derivative (modified version) of this Project, extending the Project's functionality whilst including the entire Project inside your derivative. You include a reference to this Project. You license the parts of this Project under the GNU GPLv3.0 (or a later version of this) license. You license the rest of the derivative under a different license.

Permitted: You create a closed-source derivative (modified version) of this Project, extending the Project's functionality whilst including the entire Project inside your derivative. You include a reference to this Project. You license the entire derivative under the GNU GPLv3.0 (or a later version of this) license.

Permitted: You create a faithful recreation (unmodified, updated version) of this Project. The faithful recreation is open-source. The faithful recreation supports a version of Minecraft the Project does not support. You include a reference to this Project. You license the entire derivative under the GNU GPLv3.0 (or a later version of this) license.

Permitted: You create a faithful recreation (unmodified, updated version) of this Project. The faithful recreation is closed-source. The faithful recreation supports a version of Minecraft the Project does not support. You include a reference to this Project. You license the entire derivative under the GNU GPLv3.0 (or a later version of this) license.

Forbidden _{Click to expand}

Forbidden: You create your own open-source mod and include parts of this Project in your mod. You license the entire mod under a different license. (The unpackaged parts of the Project must be licensed under the GNU GPLv3.0 license or a later version of this license)

Forbidden: You create your own closed-source mod and include parts of this Project in your mod. You license the entire mod under the different license. (Since the mod is packaged, you can't license only the parts of the Project. The entire packaged mod must be licensed under the GNU GPLv3.0 license or a later version of this license)

Forbidden: You create an open-source derivative (modified version) of this Project, extending the Project's functionality whilst including the entire Project inside your derivative. You don't add a reference to this Project. You license the entire derivative under a different license. (You must reference this Project as a source. The unpackaged Project in your derivative must be licensed under the GNU GPLv3.0 license or a later version of this license)

Forbidden: You create a closed-source derivative (modified version) of this Project, extending the Project's functionality whilst including the entire Project inside your derivative. You don't add a reference to this Project. You license the entire derivative under a different license. (You must reference this Project as a source. Since the derivative is packaged, you can't license only the Project. The entire packaged derivative must be licensed under the GNU GPLv3.0 license or a later version of this license)

Forbidden: You create a faithful recreation (unmodified, updated version) of this Project. The faithful recreation is open-source. The faithful recreation supports a version of Minecraft the Project does not support. You don't add a reference to this Project. You license the entire derivative under a different license. (You must reference this Project as a source. Since the faithful recreation is a copy of the Project, you can not change the license. The entire faithful recreation must be licensed under the GNU GPLv3.0 license or a later version of this license)

Forbidden: You create a faithful recreation (unmodified, updated version) of this Project. The faithful recreation is closed-source. The faithful recreation supports a version of Minecraft the Project does not support. You don't add a reference to this Project. You license the entire derivative under a different license. (You must reference this Project as a source. Since the faithful recreation is a copy of the Project, you can not change the license. The entire faithful recreation must be licensed under the GNU GPLv3.0 license or a later version of this license)

Forbidden: You upload an unmodified version of this Project to a Minecraft related website, archive, etc. Faithful recreations (unmodified, updated versions) of the Project that run on a version of Minecraft the Project does not support at the time of the upload are permitted. (You are not permitted to use the trademarks of this Project in this manner unless it is a faithful recreation that runs on a version of Minecraft the Project does not support at the time of the upload)

FAQ

Don't you have to use the same license as the Forge MDK? _{Click to expand}

Nope! The Forge MDK is a software library licensed under the GNU Lesser General Public License v2.1 (GNU LGPLv2.1). According to (section 2a of) that license, a work (Minecraft mod) based on the software library (Forge MDK) must be a software library itself in order for the license to carry over. Since this Project is not a software library, I can use a different license.

Why does the Project have two different licenses? _{Click to expand}

There are multiple reasons.

First, I wanted developers looking to make their own mods to have a way to use this Project's media assets. We are programmers, not artists. Being able to reuse assets dramatically speeds up the process of creating a mod. The media assets may be of higher quality than what the developer can obtain. In this case, reusing the media assets would increase the quality of the mod and user experience.

Second, I wanted content creators to be able to use the media assets to showcase the Project. Content creators usually run a risk of getting a DMCA violation for using a mod's media assets. Having a different license that allows them to use media assets eliminates that risk.

Third, the media license explicitly states that trademark rights are not granted by the license (Section 2b2). This allows me to send DMCA violations to mods impersonating the Project whilst simultaneously allowing content creators and developers to use the Project's trademarks in a way that does not impersonate the Project. In addition, if development of the Project is permanently halted, it allows developers to use the media assets to make a faithful recreation of the Project and continue updating it to new versions of Minecraft.

Gradle Issue

If you encounter gradle issues with cached libraries missing, take a look at the Repair Gradle Instructions.

Resources

An exhaustive list of references I used to make this mod. If you are looking to develop a 1.8.9 mod, this list will come in handy. A "⭐" icon means it is an exceptionally good resource.

• More Fun Quicksand Mod decompiled and deobfuscated to be used as a base. Not as easy as it sounds...
• CJMinecraft's YouTube playlist with an example of custom blocks with metadata
• RadMan63's Minecraft Forum thread on blockstates
• ⭐ Kevin M's YouTube playlist on how to create custom mob models
• BlueHexalon's Minecraft Forum thread and TheGoldCrayon's Minecraft Forum thread on troubleshooting custom model errors
• Jacknoshima's Minecraft Forum thread on moving spawn eggs to a custom creative tab
• ⭐ darkk7's Minecraft Forum post with a list of changes made to the World Renderer and Tessalator
• Lothrazar's Minecraft Forum thread with code about using World Renderer and OpenGL
• ⭐ WillieWillus's GitHub gist with a general overview of how the rendering engine changed between 1.7 and 1.8
• DragonessAtHeart's Minecraft Forum thread on IRenderFactory
• Lothrazar's GitHub repo with an example of a custom rendering factory for custom entities
• BlueHexalon's GitHub repo with an example of an alternative rendering method for custom entities
• ⭐ MyCrayfish's YouTube playlist with a good example on Tile Entities
• ⭐ Choonster's GitHub repo with an example of custom fluids
• ⭐ Emasher's Minecraft Forum thread with a guide on the Forge Biome Dictionary
• ⭐ TehNut-Mods's GitHub repo with a functioning Config Handler
• ⭐ MCPCFanC's Minecraft Forum thread with an explanation of every aspect of the mcmod.info file

qsand-minecraft's Issues

Implement Long Stick

Add the features and calculations of the Long Stick item.

Add Liquid Gun

Implements the Liquid Gun. This will be resolved once the item is functional.

Improve Quicksand Block Data Storage

Currently, they are stored in an extremely large Object array. In addition, parts are duplicates of data stored elsewhere. This situation is not ideal. However, I do not fully understand how that array is used. If I change it, it will break unknown aspects of the mod. Improving this will be a huge endeavor.

Update The MFQM Wiki With My Findings

Update the MFQM Wiki with the information I discovered from deciphering the mod. This can not be started until #16 is resolved.

Implements Sinking Slime

Adds the Sinking Slime block and it's features (Slime Hole). This issue will be resolved once the block is functional.

Implement Liquid Mire

Adds the Liquid Mire block. This issue will be resolved once the block is functional.

Implement Brown Clay

Adds the Brown Clay block. This issue will be resolved once the block is functional.

Finish CONTRIBUTING.md

Pull requests must be formatted correctly. It takes me so long to decipher uncommented code. I'll not accept uncommented pull requests. CONTRIBUTING.md helps devs not waste time on a pull request I won't accept. It is a win-win situation.

Implement Sinking Rug

Adds the Sinking Rug block. This issue will be resolved once the block is functional.

Implement Swallowing Flesh

Adds the swallowing flesh block. This issue is resolved once the block is functional.

Implement Corrupted Sand

Adds the Corrupted Sand block. This issue will be resolved once the block is functional.

Implement Tar

Adds the Tar fluid block. This issue is resolved once the fluid is functional.

Implement Peat

Adds the Peat block. This issue will be resolved once the block is functional.

Implement Wading Boots

Add the properties and calculations for the Wading Boots

Implement Bog

Adds the Bog fluid. This issue is resolved when the block is functional.

Implement Rope

Adds the Rope item. This Issue is resolved once the rope is functional.

Add SUPPORT.md

Add a support file containing resources for people making Issue reports.
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

Implement Soft Quicksand

Adds the Soft Quicksand block. This issue will be resolved once the block is functional.

Create Discord server

Having a Discord server for the community to talk in is a big goal of mine. It will take some time, but we will have one.

Decipher MFQM Calculations

I still do not understand some of the calculations and variables from MFQM. This issue is resolved when the following are deciphered:

• What controls "Thickness"
• What controls "Viscosity"
• What controls "Suction power"
• What controls "Solidity"
• What "movDis" does
• What "movCof" does
• What "movKofDiv" does
• What "kof1" does
• What "kof1m" does

Fix Larvae Block Texture

The Larvae Block is not currently animated. The animation needs to be figured out. See what MrBlackGoo did for it in MFQM.

Implement Dry Quicksand

Adds the Dry Quicksand fluid block. This issue will be resolved when the block is functional.

Update Block Comments

The comments for the modded blocks have gotten old and outdated.

Implement Dense Webbing

Adds the Dense Webbing block. This issue will be resolved once the block is functional.

Add Grass Blocks

Implements Moor Grass, Bog Grass, Cranberry Grass, and Cranberries.

Implement Custom World Structures

MFQM has a custom desert temple. This issue should implement the structure.

Add FUNDING.md

Add a funding/sponsor button/file to the project so people can donate to the project's author.
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

Add Recipes

Add all custom recipes for MFQM

Implement Mire

Adds the Mire block. This issue will be resolved once the block is functional.

Add Bottle of Mire

Implements the capability to capture Liquie Mire in a glass bottle. This can not be started until #23 is resolved.

Implement Tangleroot Moss

Adds the Tangleroot Moss block. This issue will be resolved once the block is functional.

Merge Quicksand Block Calculations

Most calculations for a quicksand block can be merged into a parent class (SinkingBlock). This can only be started once issue #16 is resolved.

Implement Wax

Adds the Wax block and the related tree blocks. This feature will be completed once all the blocks are functional.

Implement Mineral Clay

Adds the Mineral Clay block. This issue will be resolved once the block is functional.

Combine Proxies

The proxies should be combined. However, since they function correctly, there is no rush.

Implement Hardened Clay

Adds the Hardened Clay block. This issue will be resolved once the block is functional.

Implement Wet Peat

Adds the Wet Peat block. This issue will be resolved once the block is functional.

Implement Flesh Blocks

Adds all variants of Flesh blocks. This issue will be resolved once all of the blocks are functional. This excludes #43 but includes "Meat Wall"

Implement Tentacle Functionality

Adds functionality to the tentacles that spawn in mud and swallowing flesh.

Implement Moor

Adds the Moor block. This issue will be resolved once the block is functional.

Finish SECURITY.md

It is vital that people know how to properly submit security vulnerabilities. SECURITY.md will guide them through the process.

Switch Branch to 1.8.9

The branch needs to be switched to 1.8.9 and off of master. However, a lot of things are hardcoded on the branch name. Those will need to be changed.

• The Ants
• The Action Workflow
• README.md shields
• etc.

Implement Life Jacket

Adds the life jacket. This issue is resolved once the Life Jacket is functional.

Test The Mod In Survival

Test out every aspect of the mod in survival to make sure they function properly. This can not be started until all of these are resolved: #1 #3 #4 #13 #14 #15 #17 #18 #19 #20 #22 #23 #24 #25 #26 #27 #29 #30 #31 #32 #33 #34 #35 #37 #38 #39 #40 #41 #42 #43 #44 #45 #46 #47 #48

Implement Mucus Blossom

Adds all blocks related to the Mucus Blossom. This issue is resolved once a man-made mucus blossom functions properly.

Implement Grappling Hook

Adds the Grappling Hook item. This issue will be resolved once the grappling hook is functional.

Implement Sinking Clay

Adds the Sinking Clay block and it's unique features. This issue will be resolved once the block is functional.

Implement Jungle Quicksand

Adds the Jungle Quicksand block. This issue will be resolved once the block is functional.

Fix Bubbles Spawning On Fluid Blocks

Since Block Fluids don't extend Block (they extend BlockFluidClassic), Bubbles can't operate correctly. This is because some Bubble functions assume the block extends Block.
The issue mainly lies in QuicksandManager.java

Add Naturally Generating Quicksand

It shouldn't be too hard... right?