Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fr1kin committed Aug 4, 2017
1 parent 16ccabc commit 2add190
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -24,25 +24,25 @@ _How do I enter an argument that contains spaces?_

Use quotes.

Example: `.spambot add spam "This will be treated as one argument"`
Example: `.spambot spam add spam "This will be treated as one argument"`

_Is there a GUI?_

No, but I do plan on making one.

_How do I see a list of mods?_

Type `.help` in chat.
Type `.mods <search>` in chat. The search argument is optional.

_How do I toggle a mod?_

Type `.\<mod name\> enabled 1` to enable, and `.\<mod name\> enabled 0` to disable.
Type `.<mod name> enabled 1` to enable, and `.<mod name> enabled 0` to disable.

Example: `.step enabled 1` will enable step hack.

_How do I see a list of commands for a mod?_

Type `.\<mod name\>` and it should show a list of settings (if any), their current value, and their description.
Type `.<mod name>` and it should show a list of settings (if any), their current value, and their description.

Example: .`.step`

@@ -54,32 +54,34 @@ Example: `.step -?` or `.step --help` or `.step enabled -?` etc

_How do I use the Markers mod?_

`.markers add stone` Will add stone and all its variants to the block list
`.markers options add stone` Will add stone and all its variants to the block list

`.markers add 1 -i` Will add stone by its block ID
`.markers options add 1 -i` Will add stone by its block ID

`.markers add stone -r 255 -g 0 -b 0` Will add stone and give it the color red.
`.markers options add stone -r 255 -g 0 -b 0` Will add stone and give it the color red.

`.markers add stone -m 1` Will add stone with the meta variant of 1 (Granite)
`.markers options add stone -m 1` Will add stone with the meta variant of 1 (Granite)

`.markers add shulker --regex` Will add any block that contains the word "shulker" in its name
`.markers options add shulker --regex` Will add any block that contains the word "shulker" in its name

`.markers remove stone` Will remove stone from Markers
`.markers options remove stone` Will remove stone from Markers

_How do I use the SpamBot mod?_

`.spambot add test` Will add a new entry called "test"
`.spambot spam add test` Will add a new entry called "test"

`.spambot add test "Test text"` Will append "Test text" to the test entry message list.
`.spambot spam add test "Test text"` Will append "Test text" to the test entry message list.

`.spambot add test --type SEQUENTIAL` Will set the spam type to sequential. (Use `.spambot add -?` to see acceptable arguments)
`.spambot spam add test --type SEQUENTIAL` Will set the spam type to sequential. (Use `.spambot add -?` to see acceptable arguments)

`.spambot add test --keyword !test` Will set the trigger keyword to "!test"
`.spambot spam add test --keyword !test` Will set the trigger keyword to "!test"

`.spambot add test --trigger REPLY` Will set the trigger mode to "REPLY" (Use `.spambot add -?` to see acceptable arguments)
`.spambot spam add test --trigger REPLY` Will set the trigger mode to "REPLY" (Use `.spambot add -?` to see acceptable arguments)

`.spambot add test --enabled true` Will enable the spam entry
`.spambot spam add test --enabled true` Will enable the spam entry

`.spambot import test import_test.txt` Will import messages from the file "import_test.txt" inside .minecraft/forgehax
`.spambot spam import test import_test.txt` Will import messages from the file "import_test.txt" inside .minecraft/forgehax

`.spambot spam export test export_test.txt` Will export messages from the entry into a text file under /forgehax.

`.spambot remove test` Will remove the test entry and all its contents
`.spambot spam remove test` Will remove the test entry and all its contents

0 comments on commit 2add190

Please sign in to comment.