mirror of
https://github.com/qwerinope/qweribot.git
synced 2025-12-19 00:51:37 +01:00
add proper README
This commit is contained in:
44
README.md
44
README.md
@@ -1,15 +1,41 @@
|
||||
# qweribot
|
||||
|
||||
To install dependencies:
|
||||
## Commands
|
||||
|
||||
```bash
|
||||
bun install
|
||||
```
|
||||
All of these command need a prefix. By default this is `!`
|
||||
|
||||
To run:
|
||||
Arguments like `[this]` are optional.
|
||||
Arguments like `{this}` are required.
|
||||
|
||||
```bash
|
||||
bun run index.ts
|
||||
```
|
||||
### Fun commands
|
||||
|
||||
This project was created using `bun init` in bun v1.2.13. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
|
||||
COMMAND|FUNCTION|USER|ALIASES
|
||||
-|-|-|-
|
||||
`ping`|Testing command|anyone|`ping`
|
||||
`yabai`|Random number|anyone|`yabai` `goon`
|
||||
`seiso`|Random number|anyone|`seiso`
|
||||
|
||||
### Item commands
|
||||
|
||||
COMMAND|FUNCTION|USER|ALIASES
|
||||
-|-|-|-
|
||||
`iteminfo {item}`|Get item function and aliases|anyone|`iteminfo` `itemhelp` `info`
|
||||
`inventory [target]`|Get inventory contents of target or self|anyone|`inventory` `inv`
|
||||
`give {target} {item} {amount}`|Give targeted user amount of items|anyone|`give`
|
||||
`use {item} ...`|Use item. More info at [The items section](#items)|anyone|`use`
|
||||
`admingive {target} {item} {amount}`|Give targeted user amount of new items|admins|`admingive`
|
||||
|
||||
### Administrative commands
|
||||
|
||||
COMMAND|FUNCTION|USER|ALIASES
|
||||
-|-|-|-
|
||||
`vulnchatters`|Get amount of chatters vulnerable to explosives|anyone|`vulnchatters` `vulnc`
|
||||
|
||||
## Items
|
||||
|
||||
Items can be used with the alias as a command (example: `!grenade`) or with the [`use` command](#item-commands).
|
||||
|
||||
NAME|COMMAND|FUNCTION|ALIASES
|
||||
-|-|-|-
|
||||
Blaster|`blaster {target}`|Times targeted user out for 60 seconds|`blaster` `blast`
|
||||
Grenade|`grenade`|Times a random vulnerable chatter out for 60 seconds|`grenade`
|
||||
|
||||
Reference in New Issue
Block a user