https://github.com/blucodegh/bedrock
A simply python library to access Minecraft: Bedrock Edition worlds.
https://github.com/blucodegh/bedrock
Last synced: 2 months ago
JSON representation
A simply python library to access Minecraft: Bedrock Edition worlds.
- Host: GitHub
- URL: https://github.com/blucodegh/bedrock
- Owner: BluCodeGH
- License: agpl-3.0
- Created: 2018-08-27T01:39:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-05-23T17:18:33.000Z (almost 3 years ago)
- Last Synced: 2023-03-09T04:27:08.235Z (about 2 years ago)
- Language: Python
- Homepage:
- Size: 950 KB
- Stars: 61
- Watchers: 9
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bedrock
The simple, easy to use python interface for Minecraft Bedrock worlds you've been waiting for.
## Quickstart
```python
import bedrock
with bedrock.World(path_to_save) as world:
block = bedrock.Block("minecraft:stone") # Name must include `minecraft:`
world.setBlock(0, 0, 0, block)
block = bedrock.Block("minecraft:stone", 2) # Data value
world.setBlock(0, 1, 0, block)
if world.getBlock(0, 2, 0).name == "minecraft:stone":
print("More stone!")
# Autosave on close.
print("Done!")
```
## Usage
### World
`World(path)`
`world.getBlock(x, y, z, layer=0, dimension=0)`
`world.setBlock(x, y, z, block, layer=0, dimension=0)`
### Block
`Block(name, properties=[], nbt=None)`
`block.name`
`block.properties`
Block properties are either a numerical data value or a list of bedrock.nbt tags that will become the block's nbt compound tag.
`block.nbt`
### CommandBlock
`CommandBlock(command="", hoverText="", blockType="I", direction="u", conditional=False, needsRedstone=False)`
`blockType` can be one of `I`, `C`, `R`. `direction` can be one of `u`, `d`, `+x`, `-x`, `+z`, `-z`.
Otherwise identical to `Block`.
## Binaries
bedrock requires a leveldb-mcpe binary from https://github.com/Mojang/leveldb-mcpe, or one of its forks if that is easier for you to build. On windows, this means a `.dll` named `LevelDB-MCPE-.dll`, where \ is either 32 or 64. **The architecture should match your python install, not your windows install**. On linux this means `libleveldb.so`, which still must match your python install architecture. Two `.dll`s and a 64 bit `.so` are provided, but there is no guarantee as to the updatedness (or security) of any of them. If you get an error that mentions ctypes and importing, you probably need to build your own leveldb binary. Be sure to **use Mojang's leveldb-mcpe and not the google leveldb when building**.