A FUSE filesystem for querying and controlling Minecraft, as a universal mod platform (but mainly for fun). A blog post covering the technical details can be found here.
Warning: don't get your hopes too high, this is still WIP!
This plugin makes it possible to control your game through the filesystem, and therefore with common
Unix tools like cat
, find
, grep
etc. This means you can easily write Minecraft mods with
languages like bash and Python without needing to touch Java, gradle or Fabric.
For fun, to learn about FUSE, but most importantly - why not?
In ./scripts you can find some python that encapsulates the filesystem structure and makes for a nicer scripting experience. See the demo script for some examples.
import common
mc = Minecraft.from_args()
player = mc.player()
print(f"{player.name} is at {player.position}")
player.kill()
- Download latest release, or build it yourself
- Build FUSE filesystem with
cargo build --bin minecraft-fs --release
- Build Minecraft mod with
cd plugin; ./gradlew build
, which will build the jar file tobuild/libs
- Build FUSE filesystem with
- Install Minecraft mod
- Client version: 1.18.2
- Dependencies: Fabric Loader, Fabric API and Fabric Language Kotlin
- Install MCFS via mod manager/putting mod jar in
mods/
- Install as above
- Start Minecraft
- Mount the FUSE filesystem over an empty directory
mkdir mnt; ./minecraft-fs ./mnt
- Join a single player world - there's currently no support for multiplayer
Your mountpoint should contain something like the following:
$ cd mnt
$ ls
player version worlds
$ ls -l player
drwxr-xr-x - dom 21 Feb 20:27 control
lrwxr-xr-x 0 dom 21 Feb 20:27 entity -> world/entities/by-id/135
.rwxr-xr-x 256 dom 21 Feb 20:27 health
.rwxr-xr-x 256 dom 21 Feb 20:27 name
.rwxr-xr-x 256 dom 21 Feb 20:27 position
lrwxr-xr-x 0 dom 21 Feb 20:27 world -> ../worlds/overworld
Congratulations, you can now manipulate the game through reading and writing to these special files.
; wo=write only, ro=read only, rw=read and write
โโโ command ; wo, executes a command as the player
โโโ player
โย ย โโโ control ; all the files here are write-only
โย ย โย ย โโโ jump ; causes the player to jump on any input
โย ย โย ย โโโ move ; applies the given x,y,z force to the player
โย ย โย ย โโโ say ; makes the player chat
โย ย โโโ health ; rw, the player's health
โย ย โโโ name ; ro, the player's name
โย ย โโโ position ; rw, the player's position
โย ย โโโ gamemode ; rw, the player's gamemode
โย ย โโโ hunger ; rw, the player's hunger
โย ย โโโ exhaustion ; rw, the player's exhaustion
โย ย โโโ saturation ; rw, the player's food saturation
โย ย โโโ target ; wo, a position to look at
โย ย โโโ entity -> world/entities/by-id/135 ; symlink to player entity
โย ย โโโ world -> ../worlds/overworld ; symlink to player world
โโโ worlds
โโโ overworld
โย ย โโโ blocks
โย ย โ โโโ 100,64,250
โย ย โ โ โโโ adjacent ; dir of symlinks to adjacent blocks
โย ย โ โ โย ย โโโ above -> ../../100,65,250
โย ย โ โ โ โโโ below -> ../../100,63,250
โย ย โ โ โ โโโ east -> ../../101,64,250
โย ย โ โ โ โโโ north -> ../../100,64,249
โย ย โ โ โ โโโ south -> ../../100,64,251
โย ย โ โ โ โโโ west -> ../../99,64,250
โย ย โ โ โโโ pos ; ro, this block's position
โย ย โ โ โโโ type ; rw, the block's type
โย ย โ โโโ 100.2 64.555 250.1223 ; this works too
โย ย โ โ โโโ ...
โย ย โย ย โโโ README ; ro, explains the dir structure
โย ย โโโ entities
โย ย โย ย โโโ by-id
โย ย โย ย โ โโโ 107 ; entity id
โย ย โย ย โ โย ย โโโ health ; rw, the entity's health (if living)
โย ย โย ย โ โย ย โโโ living ; inaccessible, exists to indicate living
โย ย โย ย โ โย ย โโโ position ; rw, the entity's position
โย ย โย ย โ โย ย โโโ target ; wo, a position to look at
โย ย โย ย โ โย ย โโโ type ; ro, the entity's type
โย ย โย ย โ โโโ 108
โย ย โย ย โ โย ย โโโ health
โย ย โย ย โ โย ย โโโ living
โย ย โย ย โ โย ย โโโ position
โย ย โย ย โ โย ย โโโ target
โย ย โย ย โ โย ย โโโ type
โย ย โย ย โ ...
โย ย โย ย โโโ spawn ; rw, spawns an entity, read file for help
โย ย โโโ time ; rw, the world's time
โโโ nether
โย ย โโโ blocks
โย ย โย ย โโโ ...
โย ย โโโ entities
โย ย โย ย โโโ ...
โย ย โโโ time
โโโ end
โโโ blocks
โย ย โโโ ...
โโโ entities
โย ย โโโ ...
โโโ time
- More endpoints
- player gamemode
- entity hunger
- better player movement
- entity looking direction (yaw,pitch,roll)
- entity target pos
- symlink to entity vehicle
- Inventory management
- individual slots
- symlink to current slot, armour, other hand
- give/spawn items
- More block control
-
- orientation
- nbt tags
- Entity spawning
- More entity filters than
by-id
- by-type
- by-proximity-to a position and radius
- Server settings
- game rules
- pvp
- difficulty
- weather
- Event file for reacting to events
-
tail
able file of events such as player chat
-
- Client specific things
- pause/unpause game
- load into world, stop server
- Multiplayer support
- install as a server mod, control the server world
- install as a client mod and join an unmodded server, at least control the player