-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
70 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,69 @@ | ||
# Fergun | ||
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE) [![Discord](https://discord.com/api/guilds/460627183501574144/widget.png)](https://discord.gg/V3TgaZRUPX) | ||
|
||
Rewrite WIP | ||
Fergun is an utility bot/application with lots of useful commands. | ||
|
||
You can invite Fergun to your Discord server clicking [here](https://discord.com/oauth2/authorize?client_id=680507783359365121&scope=bot%20applications.commands). | ||
|
||
Have any questions or need help with the bot? Join the [support server](https://discord.gg/V3TgaZRUPX). | ||
|
||
## Features | ||
- Translate text from and to more than 140 languages using a robust translation module that is powered by popular translators from Google Translate, Microsoft Translator and Yandex Translate | ||
- Image search from Google, DuckDuckGo and Brave | ||
- Reverse image search from Bing and Yandex | ||
- Perform OCR to images using Bing and Yandex | ||
- Perform text-to-speech using Google and Microsoft Azure | ||
- Translate a text multiple times using different translators for bad translations | ||
- Get inspirational quotes from InspiroBot | ||
- Search or get random definitions from Urban Dictionary | ||
- Search and get Wikipedia articles | ||
- Search and get music lyrics from Genius | ||
- Search YouTube videos | ||
- Get user information and server/global/default avatar | ||
- Generate images of colors | ||
- 2 supported languages (English and Spanish) | ||
- Support for localized output (like localized results) in most commands | ||
- And more coming soon™ | ||
|
||
## Setup | ||
|
||
### 0. Prerequisites | ||
* A Discord bot application (You can create one [here](https://discord.com/developers/applications)). | ||
* [.NET 6 SDK](https://dotnet.microsoft.com/download) | ||
|
||
### 1. Build and run the bot | ||
* Clone the repository: | ||
`git clone https://github.com/d4n3436/Fergun.git` | ||
|
||
* Build the bot: | ||
``` | ||
cd Fergun | ||
dotnet build -c Release | ||
``` | ||
|
||
* Go to the build output folder: | ||
``` | ||
cd src/bin/Release/net6.0 | ||
``` | ||
|
||
* Open `appsettings.json` with a text editor and set the application token: | ||
```json | ||
{ | ||
"Startup": | ||
{ | ||
"Token": "put your token here" | ||
} | ||
} | ||
``` | ||
|
||
* Start the bot by double clicking `Fergun.exe` or with the command `dotnet Fergun.dll`. | ||
|
||
The application should create the SQLite database automatically and start the bot. | ||
|
||
* To start using Fergun, simply type `/` in a server with the bot and use its commands. | ||
|
||
## Contributing | ||
Feel free to report bugs or request new features via issues or pull requests. Requesting new commands may or may not be accepted depending on the utility and usability of that command. | ||
|
||
## License | ||
Fergun is licensed under the [MIT license](LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters