Skip to content

Commit 2e38140

Browse files
Update README
1 parent 05e07ca commit 2e38140

2 files changed

Lines changed: 27 additions & 7 deletions

File tree

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,40 @@
11
# CCBox
22
System virtualisation program for ComputerCraft.
3-
My entry for CCJam 2017.
4-
This program was made with and tested for the [ComputerCraft 1.80 Nightly](https://cc.crzd.me/) builds.
3+
This was originally my entry for CCJam 2017, but has since been updated.
4+
You can find the original code for the CCJam 2017 in the `ccjam-2017` tag.
5+
This program was made with and tested for the [ComputerCraft 1.80 Nightly](https://cc.crzd.me/) builds, but could run on older versions too.
56

67
# Download
7-
[pastebin get PheuiSP1 ccbox.lua](https://pastebin.com/PheuiSP1)
8+
It is recommended you build this program yourself (see Building), as this download can be outdated.
9+
[pastebin get PheuiSP1 ccbox.lua](https://pastebin.com/PheuiSP1)
810

911
# How to use
1012
Get a boot file ([bios.lua](https://github.com/dan200/ComputerCraft/blob/master/src/main/resources/assets/computercraft/lua/bios.lua)):
1113
`wget https://raw.githubusercontent.com/dan200/ComputerCraft/master/src/main/resources/assets/computercraft/lua/bios.lua bios.lua`
1214
And then simply run `ccbox`.
1315
You can exit a VM by running `shutdown`.
1416
There are many different options available:
15-
16-
![](https://img.crzd.me/ccbox.png)
17-
Note that the `tempfs` mount type is currently not implemented due to time constraints.
17+
```
18+
usage: ccbox [--help] [--boot BOOT-FILE] [--log LOG-FILE] [--command STARTUP-COMMAND] [--disable-net] [--enable-rs] [--enable-per] [--enable-disk] [--non-advanced] [VFS-MOUNTS...]
19+
20+
VFS-MOUNTS The virtual file system mounts.
21+
`<attrs>:<mount>:[dir]`
22+
attr: attributes. w (write), t (tempfs), c (ccfs)
23+
Temp doesn't require a dir argument.
24+
mount: mount point (has to start with /)
25+
dir: host file system directory
26+
Can be relative to the current directory.
27+
Default: cw:/:. c:/rom:/rom
28+
--help, -h Show this help message
29+
--boot, -b The boot file. Default: ./bios.lua
30+
--log, -l The log file.
31+
--command, -c The startup command.
32+
--disable-net, -n Disables networking (http, socket).
33+
--enable-rs, -R Enables redstone passthrough.
34+
--enable-per, -P Enables peripheral passthrough.
35+
--enable-disk, -D Enables disk drive passthrough.
36+
--non-advanced Run as a standard (non-advanced) computer.
37+
```
1838

1939
# Building
2040
Compiling is done with the [Urn](https://gitlab.com/urn/urn) compiler:

config.lisp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
mount: mount point (has to start with /)
1212
dir: host file system directory
1313
Can be relative to the current directory.
14-
Default: rw:/:. r:/rom:/rom"
14+
Default: cw:/:. c:/rom:/rom"
1515
:default '("cw:/:." "c:/rom:/rom"))
1616

1717
(add-argument! spec '("--boot" "-b")

0 commit comments

Comments
 (0)