diff --git a/README.md b/README.md index 7e5a2c6..9ad3274 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ # MC_BBS -Access OpenComputers (minecraft) functionality via serial \ No newline at end of file +Access OpenComputers (minecraft) functionality via serial interface. +## Features +Includes: +- A python shim to allow OpenComputers to act as a "server" with a client socket +- A Lua BBS server to be used in an OpenComputers machine + +## Usage +Move the contents of lua/ to an OpenComputers disk, run the BBS with your shim server address as an argument +Move the contents of py/ to a real world server of your choice and run `shim.py`. +Point a tcpser instance at the shim and let it fly! diff --git a/lua/shim.lua b/lua/shim.lua new file mode 100644 index 0000000..f556aa8 --- /dev/null +++ b/lua/shim.lua @@ -0,0 +1 @@ +-- Placeholder! diff --git a/py/shim.py b/py/shim.py new file mode 100644 index 0000000..09fd402 --- /dev/null +++ b/py/shim.py @@ -0,0 +1 @@ +#Placeholder!