aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBuckarooBanzay <BuckarooBanzay@users.noreply.github.com>2020-05-04 10:03:45 +0200
committerBuckarooBanzay <BuckarooBanzay@users.noreply.github.com>2020-05-04 10:03:45 +0200
commit17915aa4c5d17ccdbc2f1d68e98d66cd0a945092 (patch)
tree632f3f7636097cf6a1c8303fc53d8f33d67f2814 /README.md
parenta6c03a3206527a00385c4b7d05ec2de3f2747e15 (diff)
downloadmesecons_debug-17915aa4c5d17ccdbc2f1d68e98d66cd0a945092.tar.gz
mesecons_debug-17915aa4c5d17ccdbc2f1d68e98d66cd0a945092.zip
modernize a bit
Diffstat (limited to 'README.md')
-rw-r--r--README.md57
1 files changed, 16 insertions, 41 deletions
diff --git a/README.md b/README.md
index ab72b75..7b76ee5 100644
--- a/README.md
+++ b/README.md
@@ -1,51 +1,26 @@
# Mesecons Debug Collection
-## Settings
-
-* `mesecons_debug_max_globalstep_time`
-* `mesecons_debug_cooldown_steps`
-* `mesecons_debug_autoflush`
-
-## Commands
-
-All of these commands require the `mesecons_debug` privilege.
-
-* `/mesecons_flush`.
-* `/mesecons_enable`.
-* `/mesecons_disable`.
-
-## Various nodes action_on() effector
+Allows to throttle mesecons activity per mapblock
-* `mesecons_debug_enable_pipeworks_filter`.
-* `mesecons_debug_disable_pipeworks_filter`.
+# Overview
-* `mesecons_debug_enable_pipeworks_mese_filter`.
-* `mesecons_debug_disable_pipeworks_mese_filter`.
+There is a cpu quota for every mapblock, if that quota is used up
+the mesecons contraptions will be slowed down for that mapblock
-* `mesecons_debug_enable_pipeworks_dispenser`.
-* `mesecons_debug_disable_pipeworks_dispenser`.
+The current mapblock-stats can be viewed with `/mesecons_hud on`
-* `mesecons_debug_enable_pipeworks_deployer`.
-* `mesecons_debug_disable_pipeworks_deployer`.
-
-* `mesecons_debug_enable_pipeworks_nodebreaker`.
-* `mesecons_debug_disable_pipeworks_nodebreaker`.
-
-* `mesecons_debug_enable_constructor_mk1`.
-* `mesecons_debug_disable_constructor_mk1`.
-
-* `mesecons_debug_enable_constructor_mk2`.
-* `mesecons_debug_disable_constructor_mk2`.
-
-* `mesecons_debug_enable_constructor_mk3`.
-* `mesecons_debug_disable_constructor_mk3`.
+## Settings
-## Various nodes on_timer() call
+* none yet
-* `mesecons_debug_enable_blinky_plant`.
-* `mesecons_debug_disable_blinky_plant`.
+## Commands
-## Circuit breaker commands
+All of these commands require the `mesecons_debug` privilege.
-* `mesecons_debug_circuit_breaker_stats` (no priv needed).
-* `mesecons_debug_circuit_breaker_stats_reset`.
+* `/mesecons_hud [on|off]` enables or disables the hud
+* `/mesecons_flush` Flushes the action queue
+* `/mesecons_enable` Enable the mesecons queue
+* `/mesecons_disable` Disables the mesecons queue
+* `/mesecons_stats` shows some mesecons stats for the current position
+* `/mesecons_whitelist_add` adds the current mapblock to the whitelist
+* `/mesecons_whitelist_remove` removes the current mapblock from the whitelist