Needs lua-5.2 or newer, luafilesystem, luautf8, luaffi, and SDL2.
luasocket is optional but is required for the Internet Component and higher precision timing.
luasec is optional but is required for HTTPS.
For lua-5.4 you need to install bit32 via luarocks.
Note: OCEmu is currently tested with lua-5.2, lua-5.3 and lua-5.4
This git repository contains submodules, please clone using git clone --recursive https://github.com/zenith391/OCEmu.git
Binaries: Windows 64bit
The binaries above have everything pre compiled and packed up for ease of use.
If you'd like to compile OCEmu yourself for Windows, the provided script msys2_setup_ocemu.sh
will automated the compiling process for Windows, run it inside of the MSYS2 environment.
Ignore the Lua Libraries step as it doesn't work on Windows and the script does this for you.
apt-get install lua5.2 liblua5.2-dev libsdl2-dev subversion
Lua 5.2:
Install a versioned luarocks for 5.2 as described in: http://stackoverflow.com/a/20359102
# Download and unpack the latest luarocks from: http://luarocks.org/releases
./configure --lua-version=5.2 --lua-suffix=5.2 --versioned-rocks-dir
make build
sudo make install
Lua 5.3: The same as above but with Lua 5.3:
# Download and unpack the latest luarocks from: http://luarocks.org/releases
./configure --lua-version=5.3 --lua-suffix=5.3 --versioned-rocks-dir
make build
sudo make install
Follow the luarocks step below.
Here you can directly grab ocemu-zenith
and its dependencies from the AUR (thanks to AtomicScience).
If you use yay, here is the command:
yay -S ocemu-zenith
Manual Build Grab the Lua 5.2, luarocks, lua52-filesystem, lua52-sec & lua52-socket from the official repos using Pacman.
pacman -S lua52 luarocks lua52-filesystem lua52-sec lua52-socket
Then install the luarocks requirements
luarocks --lua-version 5.2 install luafilesystem
luarocks --lua-version 5.2 install luautf8
luarocks --lua-version 5.2 install luasocket
luarocks --lua-version 5.2 install luasec
cd luaffifb
luarocks --lua-version 5.2 make
# OpenComputer's lua source code is not provided, if you have svn then use the provided Makefile
# If you hate svn, manually download assets/loot, assets/lua, and assets/font.hex into src/
For Lua 5.3 support, replace 5.2
by 5.3
in the commands.
Mac users can get up and running quickly by using brew.
Brew installs luarocks as part of the lua package.
# Run this before the luarocks install steps below
brew install lua
brew install sdl2
Follow the luarocks steps below.
luarocks-5.2 install luafilesystem
luarocks-5.2 install luautf8
luarocks-5.2 install luasocket
luarocks-5.2 install luasec
cd luaffifb
luarocks-5.2 make
# OpenComputer's lua source code is not provided, if you have svn then use the provided Makefile
# If you hate svn, manually download assets/loot, assets/lua, and assets/font.hex into src/
For Lua 5.3 support, replace 5.2
by 5.3
in the commands.
You can find the above mentioned assets in the OpenComputers Repository.
https://github.com/MightyPirates/OpenComputers
The assets are under src/main/resources/assets/opencomputers.
Here you will find the loot and lua folders together with the font.hex file.
You can download the whole Repository as a zip file, extract it and copy the needed files to the src folder of OCEmu.
Launch boot.lua with lua5.2, and provided everything is installed, you'll have a working Emulator.
OCEmu stores its files in the following locations:
OS | Location |
---|---|
Windows | %APPDATA%\\OCEmu |
Linux | $XDG_CONFIG_HOME/ocemu or $HOME/.config/ocemu or $XDG_DATA_HOME/ocemu or $HOME/.local/share/ocemu |
cd src
lua boot.lua
If you want to use a custom path (for example, for running multiple machines with unique filesystems) you can specify the machine path as an argument to boot.lua via the --basedir option:
cd src
lua boot.lua --basedir=/path/to/my/emulated/machine_a