Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation is missing #74

Open
13 tasks
SmallJoker opened this issue Jul 18, 2021 · 2 comments
Open
13 tasks

Documentation is missing #74

SmallJoker opened this issue Jul 18, 2021 · 2 comments

Comments

@SmallJoker
Copy link
Member

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?
@jingkaimori
Copy link

API documentation is created on Github wiki, welcome to review

@JordanL2
Copy link

JordanL2 commented Jan 3, 2022 •
edited
Loading

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/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@SmallJoker @jingkaimori @JordanL2