Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
btwonion committed Oct 5, 2024
1 parent 55e1c90 commit 7c042b2
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/workflows/build-commit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:
- "changelog.md"
- ".editorconfig"
- "src/*/resources/lang/*"
- "media"
pull_request:
paths-ignore:
- "README.md"
Expand All @@ -17,6 +18,7 @@ on:
- "changelog.md"
- ".editorconfig"
- "src/*/resources/lang/*"
- "media"
workflow_dispatch:

jobs:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/readme-modrinth-sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
paths:
- "README.md"
- "media"
branches:
- main
workflow_dispatch:
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,21 @@
This mod provides a function to automatically drop items from the
inventory if they are blacklisted. You can easily disable it by pressing a hotkey (`default: j`).

<!-- modrinth_exclude.start -->
### - [Download on Modrinth](https://modrinth.com/mod/autodrop) -
<!-- modrinth_exclude.end -->

## Managing items

![Config screen sample](media/config-screen.gif)

- press the keybinding for the config GUI (`default: o`)
- use the configuration section of the modmenu integration
- archives can be toggled by double-clicking the archive in the GUI

### Component/Nbt filtering

*You have to be careful: Setting the item to null and leaving an empty component will cause the mod to drop every item.*
*You have to be careful: Setting the item to air and leaving an empty component will cause the mod to drop every item.*

The format of the components/nbt is always the item command syntax of the version of Minecraft you're playing on.
Unless you know the syntax by heart, you can simply use
Expand Down
Binary file added media/config-screen.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7c042b2

Please sign in to comment.