CC-Tweaked VS middleclass

My main passion right now is working with the ComputerCraft mod for Minecraft, which adds a flexible Lua-based fantasy terminal to the game. I'm most known for CraftOS-PC, a cross-platform desktop and mobile C++ app which recreates the ComputerCraft environment outside Minecraft. I'm currently working on writing an operating system for it called Phoenix, which aims to implement a full-fledged POSIX/Linux-like environment all in Lua.

For those that don't know, CC:Tweaked is the sucessor of ComputerCraft, a fabulous mod for Java Minecraft that adds computers that runs a Lua VM and are able to run programs, interact with some blocks and do redstone stuff. Also it add "mobile" computers/robots aka Turtles that have everything computers do plus they are mobile and can break and place blocks in the world. For large scale building and intricate redstone projects this is a must have mod.

Github repository here

https://tweaked.cc/ ## Other nice if you already know some basics of programming

A better and updated version of the wiki is at https://tweaked.cc

if you want some documentation for all the bits and pieces there is https://tweaked.cc/

LDoc isn't really meant for this, but you can generate on each file individually and then hack in links with some post-processing. Alternatively, if you have the time to dig into an even less documented format, illuaminate natively supports multi-file docs. (See here for an example config file.)

Oh dear, I hadn't quite appreciated how confusing this was. There's an open issue to make the fact that the file is read-only a little more obvious - I will bump that up my priority list.

Known issue that a fair amount of people have been reporting (in discord as well).

For all CC specific things, the CC: Tweaked docs found here are very very useful. You can check out the turtle, redstone, and fs APIs here (listed in the sidebar under "Globals") if you want more precise info than what tutorials are able to give you.

I am trying to document my code and I am using LDoc for that and for OOP I am using the library middleclass. All of my classes are in a main framework folder and inside that I have each namespace as a folder and then classes that are specific to that namespace in those folders.

The ConTeXt typesetting system tightly integrates Lua. One aspect of Lua that I dislike is its inability to easily write OOP-ish code. What's impressive about the language is that it can be extended to do so in astonishingly little code:

* https://github.com/kikito/middleclass

With OOP in place, I was able to typeset a hexagonal grid and a symbolic representation of a neural network on top, using a more OOP-like approach. The classes are straightforward.

A vertex defines a point in 2D space:

* https://github.com/DaveJarvis/keenwrite-themes/blob/main/bos...

An edge connects two vertices:

* https://github.com/DaveJarvis/keenwrite-themes/blob/main/bos...

A graph connects edges:

* https://github.com/DaveJarvis/keenwrite-themes/blob/main/bos...

A priority queue serves for ordering graph edges by weight of adjoining vertices:

* https://github.com/DaveJarvis/keenwrite-themes/blob/main/bos...

With these concepts in hand, we can typeset a grid and a "neural network" on top:

* https://github.com/DaveJarvis/keenwrite-themes/blob/main/bos...

Here's an example of the output for chapter 1:

* https://i.ibb.co/19DCDZy/ch-1.png

And chapter 14, where the "network" has grown in complexity:

* https://i.ibb.co/ncf16vg/ch-2.png

This is for my near future hard sci-fi book on AGI. I'm looking for alpha readers to give me feedback. See profile for contact details.

To reduce the amount of boilerplate code, I created the fork of middleclass repo suitable for Neovim plugin managers: it just adds a symlink to middleclass.lua file in lua/ directory. middleclass is well known and tested, so I suggest using it as a standard class realization. I also open a pull request to merge it upstream.

Not exactly what op asked, but if you want classes in Lua definitely check out https://github.com/kikito/middleclass

Like /u/TheMightyHUG pointed out below, there are patterns you can use to do OOP without any extra help. In the past I have used some libraries to improve the ease of doing so, specifically middleclass: https://github.com/kikito/middleclass

Same, but when I do I like when authors include everything in one file so it's easy to manage. Here we have the library, some small 10 line file with helper functions that's required and we also need to remember about the licence. Take middleclass as an example, one file, license included, ready to plug and develop.