Custom Fluids

experimental

intermediate

scripting

FORMAT & MIN ENGINE VERSION 1.20.30

This tutorial assumes an advanced understanding of blocks and the execute command. Check out the blocks guide before starting.

EXPERIMENTAL

Requires Holiday Creator Features for use of block tag Molang queries and to trigger block events.

Requires Beta APIs to use @minecraft/server module version 1.6.0-beta.

Creating fluids that are identical to vanilla fluids is not currently possible, but you can make something similar! This template/tutorial is designed to assist you in creating a custom "semi-fluid".

Flow Logic

The fluid block has states defining whether it is a source and its depth.
If there is air beneath fluid blocks, it will be converted into falling fluid.
Fluids with a depth above 1 will spread horizontally with decreasing depths.
- This will not occur if there is falling fluid below.
Flowing fluid block must have another fluid block adjacent to survive.
Source blocks do not need to have other fluid blocks surrounding themselves.

This implementation does not include face culling due to its current complexity.

Source Fluid Block

Below is the code for a custom fluid. Copy and quick replace custom_fluid with your fluid's name. When the source block detects air in its surroundings, it replaces it with the outer fluid blocks. If the source block detects air beneath it, it will also place a falling fluid block underneath.

Download Custom Fluid Geometry

Custom Fluid Block JSON

BP/blocks/custom_fluid.jsonCopy

json

{
  "format_version": "1.20.30",
  "minecraft:block": {
    "description": {
      "identifier": "wiki:custom_fluid",
      "menu_category": {
        "category": "none"
      },
      "states": {
        "wiki:source": [true, false],
        // Depth of fluid - default to 4
        "wiki:depth": [4, 5, 3, 2, 1]
      }
    },
    "components": {
      "minecraft:light_dampening": 0,
      "minecraft:collision_box": false,
      "minecraft:selection_box": false,
      "minecraft:destructible_by_explosion": false,
      // Trigger fluid spread
      "minecraft:queued_ticking": {
        "looping": true,
        "interval_range": [20, 20], // Fluid speed in ticks
        "on_tick": {
          "event": "wiki:flow"
        }
      },
      "minecraft:material_instances": {
        "*": {
          "texture": "custom_fluid", // Shortname defined in `RP/textures/terrain_texture.json`
          "render_method": "blend",
          "ambient_occlusion": false,
          "face_dimming": false
        }
      },
      "minecraft:loot": "loot_tables/empty.json",
      "tag:custom_fluid": {}
    },
    "events": {
      "wiki:flow": {
        "sequence": [
          // Dry out
          {
            "condition": "!q.block_state('wiki:source') && ((q.block_state('wiki:depth') == 5 && !q.block_neighbor_has_any_tag(0, 1, 0, 'custom_fluid')) || (q.block_state('wiki:depth') == 1 && !(q.block_neighbor_has_any_tag(1, 0, 0, 'custom_fluid_2') || q.block_neighbor_has_any_tag(-1, 0, 0, 'custom_fluid_2') || q.block_neighbor_has_any_tag(0, 0, 1, 'custom_fluid_2') || q.block_neighbor_has_any_tag(0, 0, -1, 'custom_fluid_2')) || q.block_state('wiki:depth') == 2 && !(q.block_neighbor_has_any_tag(1, 0, 0, 'custom_fluid_3') || q.block_neighbor_has_any_tag(-1, 0, 0, 'custom_fluid_3') || q.block_neighbor_has_any_tag(0, 0, 1, 'custom_fluid_3') || q.block_neighbor_has_any_tag(0, 0, -1, 'custom_fluid_3'))) || (q.block_state('wiki:depth') == 3 && !(q.block_neighbor_has_any_tag(1, 0, 0, 'custom_fluid_4', 'custom_fluid_5') || q.block_neighbor_has_any_tag(-1, 0, 0, 'custom_fluid_4', 'custom_fluid_5') || q.block_neighbor_has_any_tag(0, 0, 1, 'custom_fluid_4', 'custom_fluid_5') || q.block_neighbor_has_any_tag(0, 0, -1, 'custom_fluid_4', 'custom_fluid_5'))))",
            "die": {}
          },
          // Spread
          {
            "condition": "q.block_state('wiki:depth') == 4",
            "run_command": {
              "command": [
                "execute if block ~~~1 air run setblock ~~~1 wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=3]",
                "execute if block ~~~-1 air run setblock ~~~-1 wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=3]",
                "execute if block ~1~~ air run setblock ~1~~ wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=3]",
                "execute if block ~-1~~ air run setblock ~-1~~ wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=3]"
              ]
            }
          },
          {
            "condition": "q.block_state('wiki:source') && q.block_neighbor_has_any_tag(0, 1, 0, 'custom_fluid')",
            "set_block_state": {
              "wiki:depth": 5
            }
          },
          {
            "condition": "q.block_state('wiki:source') && !q.block_neighbor_has_any_tag(0, 1, 0, 'custom_fluid')",
            "set_block_state": {
              "wiki:depth": 4
            }
          },
          {
            "condition": "q.block_state('wiki:depth') == 3",
            "run_command": {
              "command": [
                "execute if block ~~~1 air unless block ~~-1~ air unless block ~~-1~ wiki:custom_fluid run setblock ~~~1 wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=2]",
                "execute if block ~~~-1 air unless block ~~-1~ air unless block ~~-1~ wiki:custom_fluid run setblock ~~~-1 wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=2]",
                "execute if block ~1~~ air unless block ~~-1~ air unless block ~~-1~ wiki:custom_fluid run setblock ~1~~ wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=2]",
                "execute if block ~-1~~ air unless block ~~-1~ air unless block ~~-1~ wiki:custom_fluid run setblock ~-1~~ wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=2]"
              ]
            }
          },
          {
            "condition": "q.block_state('wiki:depth') == 2",
            "run_command": {
              "command": [
                "execute if block ~~~1 air unless block ~~-1~ air unless block ~~-1~ wiki:custom_fluid run setblock ~~~1 wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=1]",
                "execute if block ~~~-1 air unless block ~~-1~ air unless block ~~-1~ wiki:custom_fluid run setblock ~~~-1 wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=1]",
                "execute if block ~1~~ air unless block ~~-1~ air unless block ~~-1~ wiki:custom_fluid run setblock ~1~~ wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=1]",
                "execute if block ~-1~~ air unless block ~~-1~ air unless block ~~-1~ wiki:custom_fluid run setblock ~-1~~ wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=1]"
              ]
            }
          },
          {
            "condition": "q.block_state('wiki:depth') == 5 && q.block_neighbor_has_any_tag(0, 1, 0, 'custom_fluid')",
            "run_command": {
              "command": [
                "execute if block ~~-1~ wiki:custom_fluid [\"wiki:depth\"=3] run setblock ~~-1~ wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=5]",
                "execute if block ~~-1~ wiki:custom_fluid [\"wiki:depth\"=2] run setblock ~~-1~ wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=5]",
                "execute if block ~~-1~ wiki:custom_fluid [\"wiki:depth\"=1] run setblock ~~-1~ wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=5]",
                "execute unless block ~~-1~ air unless block ~~-1~ wiki:custom_fluid if block ~1~~ air run setblock ~1~~ wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=3]",
                "execute unless block ~~-1~ air unless block ~~-1~ wiki:custom_fluid if block ~~~1 air run setblock ~~~1 wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=3]",
                "execute unless block ~~-1~ air unless block ~~-1~ wiki:custom_fluid if block ~-1~~ air run setblock ~-1~~ wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=3]",
                "execute unless block ~~-1~ air unless block ~~-1~ wiki:custom_fluid if block ~~~-1 air run setblock ~~~-1 wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=3]"
              ]
            }
          },
          // Fall
          {
            "run_command": {
              "command": "execute if block ~~-1~ air run setblock ~~-1~ wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=5]"
            }
          },
          {
            "condition": "q.block_neighbor_has_any_tag(0, -1, 0, 'flowing_custom_fluid')",
            "run_command": {
              "command": "setblock ~~-1~ wiki:custom_fluid [\"wiki:source\"=false,\"wiki:depth\"=5]"
            }
          }
        ]
      },
      "wiki:pick_up": {
        "die": {},
        "decrement_stack": {},
        "run_command": {
          "command": "give @s lava_bucket",
          "target": "other"
        }
      }
    },
    "permutations": [
      {
        "condition": "q.block_state('wiki:source')",
        "components": {
          // Enables the block to be picked up by an item of choice
          "minecraft:selection_box": {
            "origin": [-7.5, 0.5, -7.5],
            "size": [15, 13, 15]
          },
          "tag:custom_fluid_source": {}
        }
      },
      {
        "condition": "!q.block_state('wiki:source')",
        "components": {
          "tag:flowing_custom_fluid": {}
        }
      },
      {
        "condition": "q.block_state('wiki:depth') == 5",
        "components": {
          "minecraft:geometry": "geometry.fluid.5",
          "tag:custom_fluid_5": {}
        }
      },
      {
        "condition": "q.block_state('wiki:depth') == 4",
        "components": {
          "minecraft:geometry": "geometry.fluid.4",
          "tag:custom_fluid_4": {}
        }
      },
      {
        "condition": "q.block_state('wiki:depth') == 3",
        "components": {
          "minecraft:geometry": "geometry.fluid.3",
          "tag:custom_fluid_3": {}
        }
      },
      {
        "condition": "q.block_state('wiki:depth') == 2",
        "components": {
          "minecraft:geometry": "geometry.fluid.2",
          "tag:custom_fluid_2": {}
        }
      },
      {
        "condition": "q.block_state('wiki:depth') == 1",
        "components": {
          "minecraft:geometry": "geometry.fluid.1",
          "tag:custom_fluid_1": {}
        }
      }
    ]
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

Fluid Bucket

To place your custom fluid you need a custom bucket item. Below is the JSON for the custom bucket. Replace any instance of custom_fluid with your fluid's name.

Custom Bucket Item JSON

BP/items/custom_fluid_bucket.jsonCopy

json

{
  "format_version": "1.20.30",
  "minecraft:item": {
    "description": {
      "identifier": "wiki:custom_fluid_bucket",
      "menu_category": {
        "category": "items"
      }
    },
    "components": {
      "minecraft:max_stack_size": 1,
      "minecraft:icon": {
        "texture": "custom_fluid_bucket" // Shortname defined in `RP/textures/item_texture.json`
      },
      "minecraft:block_placer": {
        "block": "wiki:custom_fluid"
      }
    }
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

Scripts

The fluids use a script to add the ability for the player to float/sink in the fluid. The script also adds fog. To add your fluid to the script, put the ID of your new fluids in the fluids string array.

BP/manifest.jsonCopy

json

{
  "modules": [
    ...
    {
      "type": "script",
      "language": "javascript",
      "entry": "fluids.js",
      "uuid": ...,
      "version": [1, 0, 0]
    }
  ],
  "dependencies": [
    {
      "module_name": "@minecraft/server",
      "version": "1.6.0-beta"
    }
  ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

Fluid Movement & Fog Script

BP/scripts/fluids.jsCopy

javascript

import { system, world } from "@minecraft/server";

const fluids = ["wiki:custom_fluid"];

system.runInterval(() => {
  const players = world.getPlayers();

  for (const player of players) {
    // Fluid effects
    if (
      fluids.includes(world.getDimension(player.dimension.id).getBlock({ ...player.location, y: player.location.y + 1 }).typeId) ||
      fluids.includes(world.getDimension(player.dimension.id).getBlock(player.location).typeId)
    ) {
      player.addEffect("slowness", 3, { amplifier: 2, showParticles: false });
      player.addEffect("slow_falling", 4, { showParticles: false });
      if (player.isJumping) {
        player.addEffect("levitation", 3, { amplifier: 2, showParticles: false });
      }
    }
    // Fluid fog
    if (fluids.includes(world.getDimension(player.dimension.id).getBlock({ ...player.location, y: player.location.y + 1.63 }).typeId)) {
      player.runCommand("fog @s push wiki:custom_fluid_fog fluid_fog");
    } else {
      player.runCommand("fog @s remove fluid_fog");
    }
  }
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

Result

By the end your BP folder should look like this:

📁BP

📁blocks

📝custom_fluid.json

📁items

📝custom_fluid_bucket.json

📁scripts

📝fluids.js

📁RP

📁fogs

📝custom_fluid.json

Download Example Pack

If anything goes wrong, or if you require all of the template files, they are available for download here. The pack includes everything necessary for a functional fluid.

Download MCADDON

Edit Custom Fluids on Github.

Contributors

Custom Fluids

Flow Logic #

Source Fluid Block #

Fluid Bucket #

Scripts #

Result #

Download Example Pack #

Contributors

Flow Logic

Source Fluid Block

Fluid Bucket

Scripts

Result

Download Example Pack