Skip to content

Commit

Permalink
Add more documentation (#318)
Browse files Browse the repository at this point in the history
Co-authored-by: SX <[email protected]>
  • Loading branch information
Athozus and S-S-X authored Nov 5, 2023
1 parent fc96135 commit 4d9bb7d
Show file tree
Hide file tree
Showing 4 changed files with 69 additions and 1 deletion.
4 changes: 3 additions & 1 deletion technic/doc/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ There are currently following types:
Switching Station
-----------------
The switching station is required to start electric network and keep it running.
Unlike in original mod this node does not handle power distribution logic but instead just resets network timeout.
Unlike in original mod this node does not handle power distribution logic but instead just resets network timeout. The polyfuse system is activated when there is too much lag, which causes network to skip cycles (it works slower). It is shown in the infotext when activated.

Network logic
-----------------
Expand All @@ -174,6 +174,8 @@ If any surplus exists from the PR nodes the batteries will be charged evenly wit
If total demand exceeds generator supply then draw difference from batteries.
If total demand is more than available power all RE nodes will be shut down.

You can only have one network per machine, else the switching station will indicate you that several networks are trying to access the machine.

### Node meta usage
Nodes connected to the network will have one or more of these parameters as meta data:
* `<LV|MV|HV>_EU_supply` : Exists for PR and BA node types. This is the EU value supplied by the node. Output
Expand Down
38 changes: 38 additions & 0 deletions technic/doc/chests.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,41 @@ likely be revised.
As with the chest of the basic Minetest game, each chest type comes
in both locked and unlocked flavors. All of the chests work with the
pneumatic tubes of the pipeworks mod.

## Sorting

Chests can be sorted with one button with the following sort types : natural sort, by item, by quantity, by type or by wear. The chests can also be sorted automatically when its content changes. On the UI, the three buttons are the following : toggle automatic sorting, toggle sorting type, sort

## Inventory move

Chests have the ability to move all or a certain type of item with a button. All items that fit with that type will move from inventory to chest or the contrary.

## Digilines

Only mithril chests can send digilines logs. They can send messages of following types :
* Player/pipeworks item taking
* Player/pipeworks item putting
* Pipeworks overflow (chest is full)

Example of digiline message :
```lua
{
player = "singleplayer",
items = {
{
meta = {
},
metadata = "",
count = 99,
name = "technic:quarry",
wear = 0
}
},
pos = {
y = 19,
x = 67,
z = 57
},
event = "put"
}
```
4 changes: 4 additions & 0 deletions technic/doc/digilines.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
This document describes the interaction of
technic machines with the `digilines` mod (https://github.com/minetest-mods/digilines)

## Digicables

Digicables are a type of cable that carry both electric power and digiline messages. Like both original types of cable (electric cable and digiline), you just have to connect cables to each other in order to transmit power/information. They are needed to access nuclear reactor digiline information. The digicables are available in HV, MV and LV.

## Switching station

**NOTE**: make sure the channel is set accordingly, "switch" in this case
Expand Down
24 changes: 24 additions & 0 deletions technic/doc/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,30 @@ The higher levels of the mining drill allow for drilling more blocks at once, su

This electric tool is a substantial upgrade above the pickaxe that you start mining with. The laser works by drilling directly forward 7 blocks making a path that's roughly 1-block in diameter. The laser is electric, requiring charging in a battery box (any voltage). As soon as an LV electrical system is set up, this is a great next step.

## Multimeter

<img src="../textures/technic_multimeter.png"/>

This electric tool is used for quick lookup at an electric network. It works by clicking on an electric node (cable, machine, generator, switchting station), and gives values about : the position of the attached switching station, its current status, the lag, the batteries, the supply and the demand, and the total of each type of node.

| Property | Example Value | Unit | Meaning |
|------------------|---------------|------------|---------------------------------------------------------------|
| Ref. point | 61, 19, 62 | Coordinate | The location of the cable below the switching station that initially triggered initialization of this network |
| Activated | yes | active | The current state of the network |
| Timeout | 1800.0 | s | Time remaining, in seconds, before the network will shut down |
| Lag | 0.60 | ms | The lag generated by the network |
| Skip | 0 | cycles | How many cycles are skipped when network lag value is high |
| Supply | 6000 | EU | How much power is supplied by generators |
| Demand | 4000 | EU | How much power is required by consumers |
| Battery charge | 2911956 | EU | The total of energy stored in batteries |
| Battery charge | 97.07 | % | The energy stored per the maximum that can be stored |
| Battery capacity | 3000000 | EU | The maximum amount of energy that can be stored in batteries |
| Nodes | 47 | count | The number of nodes of the network, excluding switch stations |
| Cables | 32 | count | The number of cables |
| Generators | 8 | count | The number of generators (supplying the network) |
| Consumers | 4 | count | The number of consumers (demanding power) |
| Batteries | 3 | count | The number of batteries (storing energy) |

## Sonic screwdriver

<img src="../textures/technic_sonic_screwdriver.png"/>
Expand Down

0 comments on commit 4d9bb7d

Please sign in to comment.