The in-game manual for BuildCraft.

Features:

• A Markdown-based format for the manual (very useful for converting for wikis, etc.)
• Splitting into sections (chapters, etc.)
• Right-clicking on a BC block should let it go to the assigned chapter (for instance, a chapter definition such as == Pipes:buildcraft.blockGenericPipe == or something)
• Book remembers position it was closed in
• Embedding PNG images

Bonus points:

• Rendering recipes (shapeless, shaped, assembly table)

Once the above things are done, I will look into crowdsourcing book content as part of BuildCraft-Localization.

Something like the Lexica Botania?

/engineering diary, yes

Being worked on proper for 8.0.x. Obviously it needs writing for the entire mod, and perhaps exporting to web pages so we can have a single system for up-to-date stuffs. Maybe in a separate repo?

There is a sperate repo with some documentation found here: https://github.com/BuildCraft/BuildCraft-Documentation

Here is a link to some upto date documentation which was planned to be moved to the doc repo but never got around to it: https://docs.google.com/document/d/1VfEx2Pd3ttRso2bnO1I7y2QkHMVwqQnKVDT_N8tZez8/edit

maybe using txt files? those can be read and parsed into MC and they can be re-used for the site with php as well

I forgot about that repo :P.

Currently my impl uses a custom markdown format which also allows for recipe and blueprint embedding. Also it will need updating to the (future) 8.0.x changes etc.

i do webdev (will be making sites in the summer anyways) so if you 'finalize' (or atleast mostly) that markdown format and the style of it then i could make it into a php doc site to put on the website

Ooo, that would be helpful :)

Although i'm not sure how you might be able to translate $[special.crafting](buildcraftcore:guide) with a php engine.

by replacing that with a div with the right style and background, then there will be some manual work of adding some more txt files that define those recipes (unless you can automaticly generate those jsons)

@asiekierka sounds cool and i'd like to help if you want with some of these things, some of these things i already have made for the eureka engineering diary and all of the other points are points for inprovement for it i have on my todo-list for it

Nice, the Eureka book is awesome, i expect the same from the BC book!.

@CubeWrench202 the eureka book will become more awsome later, finishing up sone BCA stuff first though