mt-mods / mt-mods/pipeworks

[suggestion] Digiline docs

Open
#132 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Lua
Stars
20
Forks
31
Avg merge
1m
Merged PRs (30d)
9

Description

There doesn't seem to be any mention of digilines in the wiki, so if players want to use the digilines features they need to dig thru pipeworks source code which is inconvenient

(Also, maybe its worth simplifying the pipeworks code by using connected nodeboxes? I don't know if this would work because pipeworks tubes are transparent, but it's what technic does and would allow a pipeworks tube to use 1 node instead of 10 - https://api.minetest.net/nodes/#node-boxes, and while at it, automatically generate the noctr and ends textures)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the pipeworks source for its digilines features and the wiki, then identify the player-facing usage that needs documenting. Done means the relevant digilines features are described in the wiki so players do not need to read source code; the connected-nodebox and texture ideas are separate suggestions.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.