https://github.com/neumond/python-computer-craft
Pythonization of ComputerCraft Minecraft mod. Write Python instead Lua!
https://github.com/neumond/python-computer-craft
computercraft minecraft python
Last synced: 3 months ago
JSON representation
Pythonization of ComputerCraft Minecraft mod. Write Python instead Lua!
- Host: GitHub
- URL: https://github.com/neumond/python-computer-craft
- Owner: neumond
- License: mit
- Created: 2016-12-03T13:36:36.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-11-19T22:29:19.000Z (about 2 years ago)
- Last Synced: 2025-09-02T05:57:49.261Z (5 months ago)
- Topics: computercraft, minecraft, python
- Language: Python
- Size: 358 KB
- Stars: 77
- Watchers: 6
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pythonized CC Tweaked (ComputerCraft) API
**Warning**: CPython can't build safe sandboxes for arbitrary untrusted code
[(read more)](https://nedbatchelder.com/blog/201206/eval_really_is_dangerous.html).
Never use code in this repo if you don't trust your players!
1. Before you start Minecraft, enable localhost in mod server config
In case of singleplayer it's located inside your saves folder.
In case of multiplayer check your server folder.
Edit `computercraft-server.toml`
```toml
[[http.rules]]
host = "127.0.0.0/8"
action = "allow" # change here deny to allow
```
2. Install & start python language server
Choose one of the following:
Docker way:
```sh
docker run -it -p 8080:8080 neumond/python-computer-craft
```
Install & run manually:
```sh
pip install computercraft
python -m computercraft.server
```
3. Start Minecraft, open up any computer and type:
```sh
wget http://127.0.0.1:8080/ py
py
```
Now you have python REPL in computercraft!
To quit REPL type `exit()` and press enter.
To run any program:
```sh
py program.py # relative to current dir
py /path/to/program.py
```
`py` is short Lua program that interacts with the server.
`cc` module contains almost everything *as is* in ComputerCraft documentation:
```python
from cc import disk, os
disk.eject('right')
print(os.getComputerLabel())
```
Opening a file:
```python
from cc import fs
with fs.open('filename', 'r') as f:
for line in f:
print(line)
```
Waiting for event (`os.captureEvent` instead `os.pullEvent`):
```python
from cc import os
timer_id = os.startTimer(2)
for e in os.captureEvent('timer'):
if e[0] == timer_id:
print('Timer reached')
break
```
Using modems:
```python
from cc import peripheral
modem = peripheral.wrap('back')
listen_channel = 5
# this automatically opens and closes modem on listen_channel
for msg in modem.receive(listen_channel):
print(repr(msg))
if msg.content == 'stop':
break
else:
modem.transmit(msg.reply_channel, listen_channel, msg.content)
```
Using parallel:
```python
from cc import parallel, os
def fn():
os.sleep(2)
print('done')
parallel.waitForAll(fn, fn, fn)
```
Importing in-game files as modules:
```python
from cc import import_file
p = import_file('/disk/program.py') # absolute
m = import_file('lib.py', __file__) # relative to current file
```
More examples can be found in this repository.