ComputerCraft Forums

ComputerCraft => Programs => APIs and Utilities => Topic started by: daelvn on Jan 16, 2019, 10:24 pm

Title: The CCRunX toolkit - From your computer to CCEmuX real quick!
Post by: daelvn on Jan 16, 2019, 10:24 pm
CCRunX Toolkit
CCEmuX is a great emulator as we know it, but as someone who had to keep moving the files to test the programs, it was a bit uncomfortable. But out of the necessity comes the solution, and I came up with...

CCRunX (
The concept is pretty simple: I have a folder which I want to be my environment. Well, I set up this folder as an environment called "my-project" and run it. And how is this done, you say?
Code Select
$ ccrunx configure my-project
$ ccrunx run my-project
Yeah, that's it, run that in a folder which has a subfolder called "my-project" and you're good to go, but functionality doesn't end here. You can create new IDs with "ccrunx n <id>", and using "ccrunx a <project> <folder>", you can attach the contents of <folder> into the container regardless of emptying it.
The code is here:
And you can install it via LuaRocks: "luarocks install ccrunx"

Now the problem lied in sharing all of this with someone else for debugging purposes, help, code sharing, releasing... anything. I immediately thought of LÖVE: their .love files are just structured .zips, so that is exactly what the next tool does:

CCRunX-Image (
It has a really simple usage, go on a folder that has a subfolder configured, and run:
Code Select
$ ccrunx-image compress my-project
$ ccrunx-image decompress ccrunx-image_my-project.ccrunx
Do the first command to generate the .ccrunx file and the second to open it: They alias to "ccrunx-image c" and "ccrunx-image d". It only depends on argparse and ltext.
The code is here:
And you can install it via LuaRocks: "luarocks install ccrunx-image"

Now, what if I have three of my containers, they're different development places, but I need to test them all together. This should be pretty obvious, when you think of containers you should think of Docker, and this next tool is just "docker-compose" but for CCRunX.

CCRunX-Compose (
The usage is rather simple, and to be fair, the configuration is, too, just not as simple as the others. This all is best understood with a practical example. Let's invent three programs, call them "paboot", "paunify" and "paxcomp", and extra files called "paunify-config". Pretty realistic, huh? Let's configure them all:
Code Select
$ ls
 paboot  paunify  paxcomp  paunify-config
$ ccrunx c paboot
$ ccrunx c paunify
$ ccrunx c paxcomp
$ ccrunx c paunify-config
# Although paunify-config will never be run, configuring it will allow us to place the files inside
# anywhere we desire.
Now, let's attach paunify-config to paunify:
Code Select
$ ccrunx a paunify paunify-config
And that's how we get our base ready, we don't need to run them right now, they already configured themselves.
This is the "hardest" part, we have to create our ccrunx-compose.yml file (à la Docker!), and below will be two examples: the first valid for our example, and the second explaining all the capabilities of the YAML file:
For our example:
Code Select
# ccrunx-compose.yml
      name:  Pantheon Bootloader
      id:    0
      name:  Pantheon XCompiler
      id:    1        # For some reason, we want this on computer with ID 1, we just do.
      after: moonc ?  # Turns out this was written in MoonScript! This should compile it for us.
      name:  Pantheon Unificated libraries
      id:    0
      id:    0
      path:  /etc/paunify/ # This is inside the container
Code Select
      name:  description or extended name
      id:    0
      path:  where to place the files
      after: run a command after it's placed
      image: ccrunx-image_example.ccrunx
      name:  it can decompress images too
          name: Example
          id:  0

  # Set startup files for computers
    0: file
    1: file

  config: ccemux.json
    - someplugin.jar
Now we just have to run "ccrunx-compose build [project]" (project is optional, it is "compose" by default, that's why our YAML file starts with "compose:") and the container will be created. To run it, you can either do it the ugly way "ccrunx r compose" or "ccrunx r project", or you can just "ccrunx-compose up" or "ccrunx-compose up project".
The code is here:
And you can install it via LuaRocks: "luarocks install ccrunx-compose"

That's all for CCRunX, it wouldn't have happened without CCEmuX, so big kudos to the CCEmuX team: drmarcuse, Lignum, Squid and Lemmmy! (i mean, primarily). Be sure to report any issues you might find!
~ daelvn
Title: The CCRunX toolkit - From your computer to CCEmuX real quick!
Post by: Justyn on Jan 16, 2019, 10:35 pm
Aww, I'm not part of the CCEmuX team???

Kidding, but this is seriously cool and far more elegant than my horrid solution of symlinking my projects in ID 0.