1
0
Fork 0
mirror of https://github.com/myned/modufur.git synced 2024-11-01 21:02:38 +00:00
modufur/README.md

48 lines
1.1 KiB
Markdown
Raw Normal View History

2018-02-13 04:28:26 +00:00
# Modufur
2022-02-21 10:51:13 +00:00
An experimental [Hikari](https://www.hikari-py.dev) Discord bot for reverse image searching using [SauceNAO](https://saucenao.com) & [Kheina](https://kheina.com).
2022-02-21 07:10:57 +00:00
## Requirements
[Python](https://www.python.org) 3.10+\
[Poetry](https://python-poetry.org)
2022-02-21 10:51:13 +00:00
## Installing
2022-02-21 07:10:57 +00:00
```
2022-02-21 10:51:13 +00:00
git clone -b hikari https://github.com/Myned/Modufur.git
2022-02-21 07:10:57 +00:00
```
```
cd Modufur
```
```
poetry install
```
## Usage
```
poetry run python run.py
```
2022-02-21 10:51:13 +00:00
## Setup
`config.toml` will automatically generate if it does not exist
2022-02-21 07:10:57 +00:00
```
guilds = [] # guild IDs to register commands, empty for global
client = 0 # bot application ID
token = "" # bot token
activity = "" # bot status
saucenao = "" # saucenao token
e621 = "" # e621 token
```
2022-02-21 10:51:13 +00:00
## Updating
```
cd Modufur
```
```
git pull
```
```
poetry env remove python
```
```
poetry update
```
2022-02-21 07:10:57 +00:00
## Credits
[hikari](https://github.com/hikari-py/hikari)\
[hikari-lightbulb](https://github.com/tandemdude/hikari-lightbulb)\
[hikari-miru](https://github.com/HyperGH/hikari-miru)\
[pysaucenao](https://github.com/FujiMakoto/pysaucenao)