Configuration of the WorldEdit Documentation has been outdated

Open
#61 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by comparing the configuration page at https://worldedit.enginehub.org/en/latest/config/ with the locally generated configuration shown in the issue. Update the documentation so the configuration entries and their meanings match the current file, then verify the published page reflects the corrected content.

Written by the indexing model from the issue text.

Description

The Problem

Configuration Part of the documentation is wrong.It is different from the locally generated file I created.

Documentation: https://worldedit.enginehub.org/en/latest/config/

My Configuration:

#
# WorldEdit's Configuration File
#
# About editing this file:
# - DO NOT USE TABS. You MUST use spaces or Bukkit will complain and post
#   errors. If you use an editor, like Notepad++ (recommended for Windows
#   users), you must configure it to "replace tabs with spaces."
#   This can be changed in Settings > Preferences > Language Menu.
# - Don't get rid of indentations. They are indented so some entries that are
#   in categories, like "max-blocks-changed", are placed in the "limits"
#   category.
# - If you want to check the format of this file before putting it
#   into WorldEdit, paste it into http://yaml-online-parser.appspot.com/
#   and see if it gives you "ERROR:".
# - Lines starting with # are comments, so they are ignored.
# - If you want to allow blocks, make sure to change "disallowed-blocks" to []
#

limits:
    max-blocks-changed:
        default: -1
        maximum: -1
    vertical-height:
        default: 256
    max-polygonal-points:
        default: -1
        maximum: 20
    max-radius: -1
    max-super-pickaxe-size: 5
    max-brush-radius: 5
    butcher-radius:
        default: -1
        maximum: -1
    disallowed-blocks:
    - "minecraft:oak_sapling"
    - "minecraft:jungle_sapling"
    - "minecraft:dark_oak_sapling"
    - "minecraft:spruce_sapling"
    - "minecraft:birch_sapling"
    - "minecraft:acacia_sapling"
    - "minecraft:black_bed"
    - "minecraft:blue_bed"
    - "minecraft:brown_bed"
    - "minecraft:cyan_bed"
    - "minecraft:gray_bed"
    - "minecraft:green_bed"
    - "minecraft:light_blue_bed"
    - "minecraft:light_gray_bed"
    - "minecraft:lime_bed"
    - "minecraft:magenta_bed"
    - "minecraft:orange_bed"
    - "minecraft:pink_bed"
    - "minecraft:purple_bed"
    - "minecraft:red_bed"
    - "minecraft:white_bed"
    - "minecraft:yellow_bed"
    - "minecraft:powered_rail"
    - "minecraft:detector_rail"
    - "minecraft:grass"
    - "minecraft:dead_bush"
    - "minecraft:moving_piston"
    - "minecraft:piston_head"
    - "minecraft:sunflower"
    - "minecraft:rose_bush"
    - "minecraft:dandelion"
    - "minecraft:poppy"
    - "minecraft:brown_mushroom"
    - "minecraft:red_mushroom"
    - "minecraft:tnt"
    - "minecraft:torch"
    - "minecraft:fire"
    - "minecraft:redstone_wire"
    - "minecraft:wheat"
    - "minecraft:potatoes"
    - "minecraft:carrots"
    - "minecraft:melon_stem"
    - "minecraft:pumpkin_stem"
    - "minecraft:beetroots"
    - "minecraft:rail"
    - "minecraft:lever"
    - "minecraft:redstone_torch"
    - "minecraft:redstone_wall_torch"
    - "minecraft:repeater"
    - "minecraft:comparator"
    - "minecraft:stone_button"
    - "minecraft:birch_button"
    - "minecraft:acacia_button"
    - "minecraft:dark_oak_button"
    - "minecraft:jungle_button"
    - "minecraft:oak_button"
    - "minecraft:spruce_button"
    - "minecraft:cactus"
    - "minecraft:sugar_cane"
    - "minecraft:bedrock"

use-inventory:
    enable: false
    allow-override: true
    creative-mode-overrides: false

logging:
    log-commands: false
    file: worldedit.log
    # The format of custom log message. This is java general format string (java.util.Formatter). Arguments are:
    #   1$ : date - a Date object representing event time of the log record.
    #   2$ : source - a string representing the caller, if available; otherwise, the logger's name.
    #   3$ : logger - the logger's name.
    #   4$ : level - the log level.
    #   5$ : message - the formatted log message returned from the Formatter.formatMessage(LogRecord) method. It uses java.text formatting and does not use the java.util.Formatter format argument.
    #   6$ : thrown - a string representing the throwable associated with the log record and its backtrace beginning with a newline character, if any; otherwise, an empty string.
    # For details see:
    #   https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html
    #   https://docs.oracle.com/javase/8/docs/api/java/util/logging/SimpleFormatter.html#format-java.util.logging.LogRecord-
    format: "[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS %4$s]: %5$s%6$s%n"

super-pickaxe:
    drop-items: true
    many-drop-items: false

snapshots:
    directory:

navigation-wand:
    item: minecraft:compass
    max-distance: 100

scripting:
    timeout: 3000
    dir: craftscripts

saving:
    dir: schematics

files:
    allow-symbolic-links: false

history:
    size: 15
    expiration: 10

calculation:
    timeout: 100

debugging:
    trace-unflushed-sessions: false

wand-item: minecraft:wooden_axe
shell-save-type:
no-op-permissions: false
debug: false
show-help-on-first-use: true
server-side-cui: true
command-block-support: false
A Solution

Update the document.

Alternatives

Add comments to Config.yml

Anything Else?

I urgently need to know the meaning of these configurations.

Dominant language
Python
Stars
6
Forks
17
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from EngineHub/WorldEditDocs

All issues in EngineHub/WorldEditDocs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.