Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
derNiklaas committed Apr 17, 2024
1 parent ee9f8ce commit 52a0959
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
# Build Bugs

> A simple utility to speed up (build-) bug reports.
### Requirements
You need Minecraft 1.20.4 and at least [Noxesium 1.2](https://modrinth.com/mod/noxesium/version/1.2.0).

You need Minecraft 1.20.4 and at least [Noxesium 1.2](https://modrinth.com/mod/noxesium/version/1.2.0).

### Usage

This mod adds the ``/buildbug`` command and two hotkeys, the first hotkey (default ``U``) is used to quickly gather information about your location.
The second hotkey (default ``I``) is used to quickly generate a /bugreport.
This mod adds the ``/buildbug`` command and two hotkeys, the first hotkey (default ``U``) is used to quickly gather
information about your location.
The second hotkey (default ``I``) is used to quickly generate a /bugreport.

- ``/buildbug`` - Prints out location information, same as the hotkey.
- ``/buildbug config clipboard <true/false>`` (default: ``false``) - If set to true, automatically copies any ``/bugreport`` links or ``/buildbug`` coordinates to the clipboard.
- ``/buildbug config debug <true/false>`` (default: ``false``) - If set to true, prints out any incoming noxesium packet and information about the current internal state.
- ``/buildbug config clipboard <true/false>`` (default: ``false``) - If set to true, automatically copies
any ``/bugreport`` links or ``/buildbug`` coordinates to the clipboard.
- ``/buildbug config debug <true/false>`` (default: ``false``) - If set to true, prints out any incoming noxesium packet
and information about the current internal state.
- ``/buildbug config eventip <IP>`` (default:``example.com``) - Allows the mod to also function on the specified server.
- ``/buildbug forcestate <type> <subtype> <map>`` - Forces the internal state of the mod.
- ``/buildbug resetstate`` - Resets the internal state of the mod.
- ``/buildbug version`` - Prints out the version of the mod.

![](images/example.png)

0 comments on commit 52a0959

Please sign in to comment.