lucid blocks

installing mods

1. download the .pck file (and any .dll files if they exist) for the mod you're interested in. be careful: mods may contain viruses that damage your computer or steal your information. ensure that you trust the developer of the mod before installation.

2. copy the .pck file into the mods/ folder located in the lucid blocks installation folder. you will need to create the mode/ folder manually if this is your first time installing a mod. for Windows users, the lucid blocks folder is located at C:\Program Files (x86)\Steam\steamapps\common\lucid-blocks\

3. test your mod by running the game like usual.

developing mods

1. download godot 4.6.stable.double, the game engine that lucid blocks was developed in. the godot engine is normally available for download on the Godot website, but the double precision variant must be compiled manually; downloading the linked version saves you from this step.

2. extract the lucid blocks project using GDRETools, a free Godot game decompiler.

3. open the lucid blocks project from the godot editor and make any changes that you wish. keep track of the files that you add or create.

4. once you are ready to share your mod, navigate to Project > Export within Godot, then select Add... > Windows Desktop. in your new preset, go to the Resources tab and switch the export mode to Export all resources in the the project except the resources checked below, then check the root folder to select all files in the project. after all files are selected, manually uncheck only the files that you edited. finally, click Export PCK/ZIP and export your mod as a .pck file.

5. your mod is now ready to share! popular sources include the lucid blocks discord server or the GameBanana page.

advanced mods

most mods can be developed using only GDScript, but more advanced mods may require edits to gdblocks, the custom C++ GDextension that lucid blocks uses to implement the voxel engine. unlike the GDScript code, the C++ code is not easily decompiled. therefore, you will need to compile the .dll file from the open-source repository using the following steps:

1. clone the repository for gdblocks, then move the downloaded contents into the lucid blocks Godot project folder. if done correctly, the SConstruct file should be in the top folder alongside the game/ and extension folders.

2. edit the code in VSCode (recommended) or your IDE of choice. if adding a custom class (for new biomes, structures, etc.), create a .cpp and .h file within extension/src and extension/include respectively. ensure that you include your custom class in register_types.cpp for it to appear within the godot editor. optionally, follow these steps to configure the VSCode C++ debugger.

3. compile the extension by following the debug instructions. this may require installing Python and SCons.

4. export your mod like usual, but include the new .dll when sharing your mod. users will need to override the existing .dll file in their lucid blocks installation folder with your own.