From 3a708a03b65105ed2c8fc3c283a0f2f3381b6bfe Mon Sep 17 00:00:00 2001 From: Jordan Irwin Date: Fri, 30 Jul 2021 16:17:09 -0700 Subject: [PATCH] Re-generate HTML docs --- docs/reference/index.html | 7 +- docs/reference/topics/api.html | 3 +- docs/reference/topics/commands.html | 3 +- docs/reference/topics/config.html | 151 ++++++++++++++++++++++++++++ docs/reference/topics/settings.html | 28 ++++-- docs/reference/topics/tools.html | 3 +- 6 files changed, 181 insertions(+), 14 deletions(-) create mode 100644 docs/reference/topics/config.html diff --git a/docs/reference/index.html b/docs/reference/index.html index 0f8df68..fb7f023 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -36,6 +36,7 @@
  • api
  • commands
  • tools
  • +
  • config
  • @@ -62,13 +63,17 @@ tools Cleaner Tools + + config + World Path Configuration +
    generated by LDoc 1.4.6-antum-dev -Last updated 2021-07-29 13:38:35 +Last updated 2021-07-30 16:16:51
    diff --git a/docs/reference/topics/api.html b/docs/reference/topics/api.html index 0d90465..27d26cc 100644 --- a/docs/reference/topics/api.html +++ b/docs/reference/topics/api.html @@ -44,6 +44,7 @@
  • api
  • commands
  • tools
  • +
  • config
  • @@ -389,7 +390,7 @@
    generated by LDoc 1.4.6-antum-dev -Last updated 2021-07-29 13:38:35 +Last updated 2021-07-30 16:16:51
    diff --git a/docs/reference/topics/commands.html b/docs/reference/topics/commands.html index 047abaa..d94b775 100644 --- a/docs/reference/topics/commands.html +++ b/docs/reference/topics/commands.html @@ -44,6 +44,7 @@
  • api
  • commands
  • tools
  • +
  • config
  • @@ -306,7 +307,7 @@
    generated by LDoc 1.4.6-antum-dev -Last updated 2021-07-29 13:38:35 +Last updated 2021-07-30 16:16:51
    diff --git a/docs/reference/topics/config.html b/docs/reference/topics/config.html new file mode 100644 index 0000000..76b2e6b --- /dev/null +++ b/docs/reference/topics/config.html @@ -0,0 +1,151 @@ + + + + + Cleaner mod for Minetest + + + + +
    + +
    + +
    +
    +
    + + +
    + + + + + + +
    + +

    Topic config

    +

    World Path Configuration

    +

    + +

    + + +

    JSON Configurations

    + + + + + +
    cleaner.jsonMain configuration file.
    + +
    +
    + + +

    JSON Configurations

    + +
    +
    + + cleaner.json +
    +
    + Main configuration file.

    + +

    Registering items, entities, etc. for cleaning can be done in cleaner.json + in the world directory (<world_path>/cleaner.json). If it does not exist + it will be created automatically when the server is started.

    + +

    It is formatted as follows:

    + +
    {
    +  "entities" :
    +  {
    +    "remove" : []
    +  },
    +  "items" :
    +  {
    +    "replace" : {}
    +  },
    +  "nodes" :
    +  {
    +    "remove" : [],
    +    "replace" : {}
    +  },
    +  "ores" :
    +  {
    +    "remove" : []
    +  }
    +}
    +
    + +

    remove key works for nodes, entities, & ores. replace key works for + nodes & items. Their functions are self-explanatory. + + + + + + + + + + +

    Usage:

    +
      +
      Cleaning nodes example:
      +{
      +  "nodes" :
      +  {
      +    "remove" : [
      +      "old:node_1",
      +      "old:node_2",
      +    ],
      +    "replace" : {
      +      "old:node_3" : "new:node_1",
      +      "old:node_4" : "new:node_2",
      +    }
      +  },
      +}
      +
    + +
    +
    + + +
    +
    +
    +generated by LDoc 1.4.6-antum-dev +Last updated 2021-07-30 16:16:51 +
    +
    + + diff --git a/docs/reference/topics/settings.html b/docs/reference/topics/settings.html index 835fab0..823da59 100644 --- a/docs/reference/topics/settings.html +++ b/docs/reference/topics/settings.html @@ -43,6 +43,7 @@
  • api
  • commands
  • tools
  • +
  • config
  • @@ -60,7 +61,7 @@ - +
    cleaner.unsafeEnables unsafe methods.Enables unsafe methods & chat commands.
    @@ -76,18 +77,25 @@ cleaner.unsafe
    - Enables unsafe methods.

    -

    cleaner.remove_ore +

    Enables unsafe methods & chat commands.

    + + + + +

    Definition:

    + + + -

    Setting Type:

    - -

    Default Value:

    - @@ -104,7 +112,7 @@
    generated by LDoc 1.4.6-antum-dev -Last updated 2021-07-29 13:38:35 +Last updated 2021-07-30 16:16:51
    diff --git a/docs/reference/topics/tools.html b/docs/reference/topics/tools.html index 754f481..40f9e99 100644 --- a/docs/reference/topics/tools.html +++ b/docs/reference/topics/tools.html @@ -43,6 +43,7 @@
  • api
  • commands
  • tools
  • +
  • config
  • @@ -114,7 +115,7 @@ use (left-click):
    generated by LDoc 1.4.6-antum-dev -Last updated 2021-07-29 13:38:35 +Last updated 2021-07-30 16:16:51