Add a chunkloader #158

leca457 · 2025-08-02T10:21:13Z

This PR has two versions of a chunk loader: a normal one and for admins which does not require power and works infinitely.

The crafting recipe for the normal one is:

M # M
# M #
M # M

Where M is a sbz_resources:matter_blob and # is empty.
I think that the recipe must be changed and it was added purely as a test and it is very unbalanced, obviously.
The chunk loader consumes 25 power.

Textures are CC-BY-SA 4.0 (they are a slight rework of the textures from the original mod I was basing on.)

leca457 · 2025-08-02T10:22:03Z

Sorry if it's crappy, it's my first serious mod and first PR

TheEt1234

Also, textures in sbz are 1 node = 16x16 pixels, you have to change them

TheEt1234 · 2025-08-02T13:12:36Z

mods/chunkloader/crafting.lua

+        { "",          matter_blob, "" },
+        { matter_blob, "",          matter_blob }
+    }
+})


this looks unfinished? you should buff the recipe, make it involve warp devices or something

I did mention that the crafting recipe is for testing only and I am counting on you on providing more balanced recipe because no one could know your game better, I suppose :)

it is not my game (i only wrote/added majority of the code), i stopped actively working on it, and i don't design recipes that well, i find it an annoyance tbh

Is this resolved?

TheEt1234 · 2025-08-02T13:13:44Z

mods/chunkloader/logic.lua

@@ -0,0 +1,39 @@
+chunkloader.action = function(pos, _, meta, supply, demand)


I think it would be ideal if the chunkloader worked only if the player was online, in multiplayer

Because having it be always loaded might not be a great idea for server performance

Also, you should maybe check how switching stations behave when you walked away from them (Are they loaded?)

The idea of chunkloaders came to my mind when I created a super advanced battery factory and wanted it to work all night through so that I could wake up in the morning and see all batteries ready for use.

I understand concerns about server performance and I think that we might add a limit for a player to, for example, have a limit of N chunk loaders per server or something (the N may be put to the config for better configurability).

I checked it in singleplayer and it looks like everything's okay but yea I think it needs better testing and some improvements

The idea of chunkloaders came to my mind when I created a super advanced battery factory and wanted it to work all night through so that I could wake up in the morning and see all batteries ready for use.

well, in sbz i had always the idea of "Instead of waiting, how about expanding your factory instead"

I understand concerns about server performance and I think that we might add a limit for a player to, for example, have a limit of N chunk loaders per server or something (the N may be put to the config for better configurability).

Oh yeah, i completely forgot about that, that is needed, limit the player to only be able to make like 30 chunkloaders

As for performance, skyblock zero is not very performant, at least not as performant as i'd want it to be i guess, it would be nice if machines weren't constantly loaded for no reason

I checked it in singleplayer and it looks like everything's okay but yea I think it needs better testing and some improvements

ok

TheEt1234 · 2025-08-02T13:13:52Z

mods/chunkloader/logic.lua

+    local prev_state = meta:get_int("prev_state") == 1
+    local perpetual = meta:get_int("perpetual") == 1
+
+    local power_needed = 25


Buff this to a lot more, like 300 power

TheEt1234 · 2025-08-02T13:14:58Z

mods/chunkloader/perpetual_chunkloader.lua

+core.register_node("chunkloader:loader_inf", {
+    short_description = "Chunk Loader (INF)",
+    description =
+    "Chunk Loader (INF)\nKeeps the mapblock it's located in active\nDoes not consume power.\nInfinite.\nOnly for admins.\nAnd mods maybe\nMods like moderators, not ones that are written in Lua.",


Better to simplify to "Creative Mapblock Loader"

Also, nitpick: i suggest renaming it to mapblock loader, as a chunk implies a mapgen chunk, which is a LOT larger of an area

Yea, I kinda came from minecraft and it's a kind of legacy :)

But in general, I do agree with the renaming

TheEt1234 · 2025-08-02T13:19:53Z

I think this is good for your first PR

leca457 · 2025-08-02T15:01:34Z

So, if I:

will implement the limiting mechanic (N chunkloaders per player)
Reduce the texture resolution to 16x16
Come up with a better crafting recipe
Make it use 300 power

This could be accepted?

TheEt1234 · 2025-08-02T15:23:02Z

So, if I:

1. will implement the limiting mechanic (N chunkloaders per player)

2. Reduce the texture resolution to 16x16

3. Come up with a better crafting recipe

4. Make it use 300 power

This could be accepted?

yes and

mapblock loaders owned by players who are not online won't load anything
you need to come up with a quest for it, the format for quests is quite intuitive, then you need to add the name of the mapblock loader node to a table somewhere, to make the quest unlock on craft
also you will need to get it approved by zander (i might ping them on discord about this, once i think this is finished)

ChefZander · 2025-08-03T17:35:12Z

I like this PR, when the requested changes are implemented i'll merge it

…d storage instead of players' meta

leca457 · 2025-08-07T20:38:21Z

Just so you know, I'm working on it. I have implemented the limit mechanism, resized textures and renamed it to mapblock loader. Now I'm thinking about the recipe and the quest.

leca457 · 2025-08-11T20:15:37Z

I think that all your requirements should be met now and it is ready for merge.

I'd like to also note that I'd like to make it highlight the mapblock it is located in on punch, just like the jumpdrive, but it is planned for now.

I think we could merge it as soon as I implement it :)

leca457 · 2025-08-11T20:46:12Z

You know it was a lot easier when you read the docs and have a nice and handy vizlib. I think it is done now

Desour · 2025-08-12T20:19:30Z

mods/mapblockloader/logic.lua

+    meta:set_string("infotext", run and "Running" or "Idle")
+
+    if prev_state == 0 and run == 1 then
+        core.forceload_block(pos)


This is limited to 16 blocks by default (see doc).

(Also, I'd recommend to use transient forceloading, and keeping track of the active forceloaders yourself. This avoids leaks if something is modified (e.g. forceloader is removed with worldedit, or mod is removed). The non-transient is kind of an unnecessary and bad feature.)

Ok, I will fix it, thanks for the comment!

TheEt1234 · 2025-08-15T09:34:25Z

is this ready?

TheEt1234

tl;dr i think there still is some work to do

TheEt1234 · 2025-08-15T09:35:54Z

mods/mapblockloader/crafting.lua

+    output = "mapblockloader:loader",
+    recipe = {
+        { warp_crystal, 	 retaining_circuit, warp_crystal         },
+        { retaining_circuit, titanium_block,       retaining_circuit },


have some fun with phlogiston circuits, and phlogiston, xD

Ok, what do you think if I place phlogiston crystal in the middle, instead of titanium block and replace retaining circuits with phlogiston ones?

TheEt1234 · 2025-08-15T09:36:17Z

mods/mapblockloader/creative_mapblockloader.lua

+core.register_node("mapblockloader:creative_loader", {
+    short_description = "Creative Mapblock Loader",
+    description =
+    "Creative mapblock Loader\nKeeps the mapblock it's located active.\nDoes not consume power.\nInfinite.\nOnly for admins.\nAnd mods maybe\nMods like moderators, not ones that are written in Lua.",


\nOnly for admins.\nAnd mods maybe\nMods like moderators, not ones that are written in Lua.

remove this... or no... just replace it with

description = "Forces the mapblock to be always loaded"

assuming that is what it does

I wanted it to be some sort of a joke :D

TheEt1234 · 2025-08-15T09:38:26Z

mods/mapblockloader/creative_mapblockloader.lua

+        meta:set_string("infotext", "Working")
+    end,
+    on_destruct = function(pos, _)
+        core.forceload_free_block(pos)


If deleted with something like worldedit, there could be some trouble, is this acceptable?

@Desour told me about it a bit higher.

I think that I should save coordinates of new loaders and when a new mapblock emerges, check if there are loaders in this mapblock (using mod storage) and if there is, check the position and if there's no loader, do not force load the mapblock and remove the pos from the storage.

Would that be ok?

Suggestion:

Use transient forceload only.

Store list of forceloader node positions in memory (or pos hash set). And store it in modstorage.

On server startup (i.e. in core.after(0)), load the list. And go through all the positions. If there is a foreceloder (you can load the block with core.load_area, and then use get_node), forceload the block, otherwise remove the nodepos (and log to warning or info).

Also do this check of the positions also every now and then.

Use an lbm, or an abm with a long interval, to add missing forceloader positions to the list.

Note that forceloading does counting, see builtin/game/forceloading.lua. So match every load with a free, or else there will be conflicts with other mods.

Btw. to avoid players forceloading the whole map, you could also make a per-player limit of forceloaders (with a priv (also for singleplayer) to allow infinitely many). And you could make it so that foreceloaders of a player only work while the player is on the server (store owner(s) in node meta, and store pos list per player in worlstorage).

TheEt1234 · 2025-08-15T09:39:28Z

mods/mapblockloader/logic.lua

+
+mapblockloader.on_punch = has_vizlib and function(pos, _, player)
+    if not player or player:get_wielded_item():get_name() ~= "" then
+        -- Only show loaded area when using an empty hand


i think you should remove this check, dunno why vizlib has the tradition of doing that

To be honest, I just copied it from jumpdrive :)

TheEt1234 · 2025-08-15T09:41:10Z

mods/mapblockloader/mapblockloader.lua

@@ -0,0 +1,64 @@
+sbz_api.register_stateful_machine("mapblockloader:loader", {
+    short_description = "mapblock Loader",


Mapblock Loader

TheEt1234 · 2025-08-15T09:42:00Z

mods/mapblockloader/logic.lua

@@ -0,0 +1,57 @@
+mapblockloader.action = function(pos, _, meta, supply, demand)


What happens when it gets moved by a piston or jumpdrive? (sbz development is so joyful i know)

rn it seem that the only problem that previous forceload will persist forever..
I think that if I'll implement the tracking mechanism described above, it will be OK with pistons and jumpdrives

TheEt1234 · 2025-08-15T09:47:56Z

mods/mapblockloader/logic.lua

+    if demand + power_needed > supply then
+        meta:set_int("prev_state", meta:get_int("running"))
+        meta:set_int("running", 0)
+        return power_needed, false


Also add core.forceload_free_block here?

It is setting running to 0 and on the next called action it will unload the mapblock

TheEt1234 · 2025-08-15T09:48:54Z

mods/mapblockloader/utils.lua

+function mapblockloader.create_config()
+    file = io.open(mapblockloader.config_path, "w")
+    local default_config = {
+        mapblockloaders_per_player = 10


Could probably notify the user of this limit in some way, do that in the questbook

It is up to server owner and yea, I'll write about it in QB

TheEt1234 · 2025-08-15T09:49:29Z

mods/sbz_progression/quests/Mapblock_loaders.md

@@ -0,0 +1,15 @@
+
+# Questline: Mapblock loaders


An entire questline? just for the mapblock loader?

TheEt1234 · 2025-08-15T09:50:11Z

mods/sbz_progression/quests.lua

@@ -15,6 +15,7 @@ local quest_files = {
    "Pipeworks_and_fluid_transport",
    "Reactor",
    "Jumpdrive",
+    "Mapblock_loaders",


Correct would be "Mapblock_loader", as this would try to unlock you the questline (Side note: you shouldn't make your own questline just for mapblock loaders)

Yea I thought about where to place it and Didn't really find a good place. I see that the 'Completionist' questline is a kind of questline for everything that didn't match for any of the others :D

… the Completionist.

TheEt1234

You should also resolve conversations that have been solved

or can only zander do that, i dunno github

TheEt1234 · 2025-08-17T07:05:32Z

mods/mapblockloader/crafting.lua

-        { warp_crystal, 	 retaining_circuit, warp_crystal         },
+        { warp_crystal,       phlogiston_circuit, warp_crystal },
+        { phlogiston_circuit, phlogiston_crystal, phlogiston_circuit },
+        { warp_crystal,       phlogiston_circuit, warp_crystal },


yeah, but maybe something expensive at the center, maybe a warp device?

TheEt1234 · 2025-08-17T07:05:59Z

mods/mapblockloader/creative_mapblockloader.lua

@@ -1,7 +1,7 @@
 core.register_node("mapblockloader:creative_loader", {
    short_description = "Creative Mapblock Loader",
    description =
-    "Creative mapblock Loader\nKeeps the mapblock it's located active.\nDoes not consume power.\nInfinite.\nOnly for admins.\nAnd mods maybe\nMods like moderators, not ones that are written in Lua.",
+    "Forces the mapblock to be always loaded",


Forces the mapblock that it is inside of to always be loaded

TheEt1234 · 2025-09-03T18:34:18Z

If this PR won't have the requested changes/testing, i may implement something like this on my own (where i believe i know all the ways a player could seriously mess with a forceloader)

add chunkloader

87e65b7

TheEt1234 suggested changes Aug 2, 2025

View reviewed changes

ChefZander mentioned this pull request Aug 3, 2025

Luacontroller can't execute chat_debug even in protected area #157

Closed

leca added 3 commits August 5, 2025 23:01

fixes ChefZander#157

fc4a84d

add the limit

3cccfc0

use config file for limit storage, store amount of chunkloaders in mo…

24af4dc

…d storage instead of players' meta

leca added 4 commits August 11, 2025 22:31

rename

d6771ae

add a quest to questbook

82e83cc

remove unneded chat message

e1e771e

achievment on craft

6583e59

show loaded area

154a19b

Desour reviewed Aug 12, 2025

View reviewed changes

TheEt1234 suggested changes Aug 15, 2025

View reviewed changes

Description/naming stuff, edit craft, move from separate questline to…

3704497

… the Completionist.

TheEt1234 suggested changes Aug 17, 2025

View reviewed changes

		@@ -0,0 +1,39 @@
		chunkloader.action = function(pos, _, meta, supply, demand)

		@@ -0,0 +1,64 @@
		sbz_api.register_stateful_machine("mapblockloader:loader", {
		short_description = "mapblock Loader",

		@@ -0,0 +1,57 @@
		mapblockloader.action = function(pos, _, meta, supply, demand)

Add a chunkloader #158

Are you sure you want to change the base?

Add a chunkloader #158

Uh oh!

Conversation

leca457 commented Aug 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

leca457 commented Aug 2, 2025

Uh oh!

TheEt1234 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TheEt1234 Aug 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TheEt1234 Aug 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TheEt1234 commented Aug 2, 2025

Uh oh!

leca457 commented Aug 2, 2025

Uh oh!

TheEt1234 commented Aug 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ChefZander commented Aug 3, 2025

Uh oh!

leca457 commented Aug 7, 2025

Uh oh!

leca457 commented Aug 11, 2025

Uh oh!

leca457 commented Aug 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TheEt1234 commented Aug 15, 2025

Uh oh!

TheEt1234 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

leca457 commented Aug 2, 2025 •

edited

Loading

TheEt1234 left a comment •

edited

Loading

TheEt1234 Aug 2, 2025 •

edited

Loading

TheEt1234 Aug 2, 2025 •

edited

Loading

TheEt1234 commented Aug 2, 2025 •

edited

Loading