Skip to content

crackx02/VoxelTerrain

Repository files navigation

VoxelTerrain

crystalCave5 crystalCave6 crystalCave2

Showcase Video (click the image)
VoxelTerrain Video 1

Showcase Video (click the image)
VoxelTerrain Video 2

This mod re-enables the hidden, unreleased, disabled voxel terrain system in Scrap Mechanic.

However, that is not all!
As the "vanilla" implementation was found to be somewhat disappointing (for example, the terrainSphereModification function throwing an error instead of allowing terrain to be placed back down!), the mod also immediately and massively expands the system in various ways by implementing a large custom Lua scripting API.

This API allows for a lot of modding freedom - terrain can be manipulated in a variety of shapes and ways, such as erasing terrain, placing terrain, painting ground materials and even importing and voxelizing 3D models!

There are also features for restricting the system, e.g. preventing players from digging out an important structure or object.

FAQ

Q: Does the Voxel Terrain DLL mod replace all terrain with Voxel Terrain?
A: No, it simply adds the ability for Blocks and Parts mods and Custom Games (such as the Voxel Terrain Showcase Mod) to create and manipulate Voxel Terrain!
-
Q: Does this Voxel Terrain here work like the one showcased by Axolot for Chapter 2?
A: Yes, the DLL mod enables and expands the unfinished Voxel Terrain implementation hidden within the game's code.
-
Q: Does the Voxel Terrain DLL mod allow using Voxel Terrain in the Tile Editor?
A: No, this is currently not supported. However, the DLL does provide Lua API functions usable for terraforming/sculpting/saving and loading chunks, etc. A basic example of this is present in the Showcase Mod.
-
Q: Is this mod multiplayer-compatible?
A: The mod is fully multiplayer-compatible, under the condition that both the host and client(s) have the DLL installed.
Note that, even if one side does not have the DLL, standard gameplay will still work - only the actual voxel terrain is affected by this.
However, having a very large amount of voxel terrain in a world can cause the connection to fail, which is a problem in the game's code, not a fault of this mod.

Showcase Mod

To showcase the gameplay side of things, a VoxelTerrain Showcase mod has been uploaded to the Steam workshop.

The showcase mod mainly focuses on the gameplay, e.g. drilling your way through cave systems, mining resources, etc.

Note that the showcase mod requires this VoxelTerrain DLL to be installed (see How to Use section below).

How to Use

To use this mod, a DLL injector such as this one is required.

After installing an injector, simply add the VoxelTerrain.dll mod to your DLLModules directory as written in the injector's description.

Technical Details

Lua API

This DLL provides a large custom Lua API for the voxel terrain system.
As described above, this includes, but is not limited to, features to erase or place terrain in various shapes and ways,
runtime importing and voxelization of 3D models, terrain restriction systems and more.
All of these Lua API features are documented in the ScrapMechanicTools website.

API Usage Examples

For examples of how to use the voxel terrain scripting API, feel free to dig through the scripts and files of the VoxelTerrain Showcase mod!

About

Re-enables and expands the hidden, unreleased voxel terrain system in Scrap Mechanic

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages