mt-mods / pipeworks

Pipeworks is a mod for Minetest allowing the crafting and usage of pipes and tubes
Other
15 stars 22 forks source link

[suggestion] Digiline docs #132

Open TheEt1234 opened 3 months ago

TheEt1234 commented 3 months ago

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)

wsor4035 commented 3 months ago

feel free to suggest some documentation for the wiki. not sure how people without access are supposed to contribute to a wiki on github 🤔. worse case post it here and a can control c/v it over

TheEt1234 commented 3 months ago

ok im kinda bad at writing but i think its still way better than having no docs

Digilines

Deployer, Dispenser, Node breaker

Teleporting Pneumatic Tube Segment

Autocrafter

Digiline Detecting Pneumatic Tube Segment

Digiline Filter-Injector

{
   sloteq = "priority", -- can be "priority", "random", or "rotation"
   exmatch = true, -- a boolean, turns off/on exact matching
   sloteq_index = 1, -- can only be 1 or nil, setting it to 1 will reset the sloteq_index
   tag = "any tag",
   tags = {"a","b"}, -- sets the item tag filter to that, the tags field takes priority over the tag field
   nofire = "not nil", -- if this is any value other than nil or false, it won't fire
   -- all of theese are filters:
   name = "default:dirt",
   group = "soil",
   count = 99,
   wear = 0,
   metadata = {},

   -- this is also a way to make multiple filters
   -- if the fields name/group/count/wear/metadata are present theese will be ignored
   [1] = {
      name = "default:dirt",
      group = "soil",
      count = 99,
      wear = 0,
      metadata = {},
   },
   [2] = ...
}

example usage:

pushing out 99 dirt:

{
  name = "default:dirt",
  count = 99
}

pushing out 99 of anything:

{count = 99}
OgelGames commented 3 months ago

Related: #104

TheEt1234 commented 3 months ago

oh, @OgelGames maybe it's a good idea to make a library for it (like a magic book, when you click on a machine with it, it would show the docs, and the library would convert markdown files(?) - or wait there is doclib, maybe that could be used) as this is a problem that many mods have

S-S-X commented 3 months ago

maybe it's a good idea to make a library for it (like a magic book, when you click on a machine with it, it would show the docs, and the library would convert markdown files(?) - or wait there is doclib, maybe that could be used) as this is a problem that many mods have

Also best to check out existing solutions and see what's wrong with those because attempt to solve this would not be first time and probably not even second time. See doc mod for one.

Furthermore I've looked at this a bit few years ago and actually even logged issue with some notes for it: https://github.com/S-S-X/metatool/issues/85

I've not really worked on this issue, just sharing some research.