digilines icon indicating copy to clipboard operation
digilines copied to clipboard

Documentation is missing

Open SmallJoker opened this issue 3 years ago • 2 comments

I believe this project would be much more modder-friendly if there was a sane documentation in this project.

README:

  • [ ] Proper readme structure (titles etc)
  • [ ] Project description
  • [ ] Exemplary screenshot
  • [ ] Mod features
  • [ ] Compatible mods, related mods
  • [ ] Reference to https://uberi.mesecons.net/ for examples
  • [ ] Reference to an API documentation

API documentation:

  • [ ] General concept: channels, triggers etc
  • [ ] Node def fields
    • [ ] Reference to pipeworks documentation
    • [ ] Digiline connection rules (x/y/z)
    • [ ] digilines table format
    • [ ] Special inventories, callbacks, idk?

SmallJoker avatar Jul 18 '21 12:07 SmallJoker

API documentation is created on Github wiki, welcome to review

jingkaimori avatar Nov 10 '21 04:11 jingkaimori

I also can't find the documentation for players. I'm trying to figure out how to use this mod and there's... nothing? All I've found so far is the forum thread: https://forum.minetest.net/viewtopic.php?f=11&t=5263

EDIT: The mesecons luacontroller page helped get me started: https://mesecons.net/luacontroller/

JordanL2 avatar Jan 03 '22 16:01 JordanL2