CC-Tweaked
CC-Tweaked copied to clipboard
cc-tweaked
Improved help files for CraftOS
While the online documentation is now in a reasonable state, the in-game docs are pretty terrible. I'd really like to have an offline, "book"-style version of the docs, but that's a much longer term project.
A more short-term solution here would just be to somewhat improve the help files bundled with CraftOS.
The obvious thing to do here is generate these from the current docs. I don't think we want to copy the docs verbatim, but it might be worth having each module's description + its functions' signature & summary.
tweaked.cc is getting more complete now, and you have mentioned a few times that you are getting close to making your own markdown renderer, it makes me think of the docs that OpenComputers has in-game. OC just have the website in an item in-game, which can be quite good for people who stay behind on old versions of the mod as it means that they have access to documentation that they know are relevant for their version.
...it makes me think of the docs that OpenComputers has in-game.
@Lupus590 : I haven't used OpenComputers. If you (or anyone) has some screenshots of what this documentation looks like, I'd love to see it.
I guees, this can be this two mods:
- https://www.curseforge.com/minecraft/mc-mods/rtfm
- https://www.curseforge.com/minecraft/mc-mods/markdownmanual
The obvious thing to do here is generate these from the current docs.
I had a look at this over the Easter weekend. It's definitely possible, but you are really hitting the limits of CC's resolution. Even on a normal computer, the text is pretty cramped and hard to read.
I don't know, there's an annoying trade-off here. Conceptually I really like the idea of exposing the docs inside the computer - it doesn't make much sense to have a third documentation system. However, the UX is much worse, and it does limit what functionality that we can implement — there's no way of doing images, recipes or structures (i.e. Create's ponder functionality).