-
Notifications
You must be signed in to change notification settings - Fork 0
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
1 parent
60942b3
commit cafc40a
Showing
1 changed file
with
53 additions
and
34 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,51 +1,70 @@ | ||
| A Dragalia Lost bot that gives information on Adventurers, Dragons, and Wyrmprints | ||
| # NefBot - A Discord Bot for Dragalia Lost | ||
| 1. [About](#about) | ||
| 2. [Installation](#installation) | ||
| 3. [Issues](#issues) | ||
| 4. [License](#license) | ||
|
|
||
| ## Requirements | ||
| - [Python 3.6 or higher](https://www.python.org/) | ||
| - [discord.py 0.16.12](https://github.com/Rapptz/discord.py). You can install this by opening a command prompt or terminal window and typing the following: | ||
| ``` | ||
| python -m pip install discord.py==0.16.12 | ||
| ``` | ||
| # About | ||
| ## Summary | ||
| A simple discord bot used to gather information from the Dragalia Lost mobile game. It is able to pull up information regarding adventurers, dragons, and wyrmprints as well as querying the database it uses to find any of the three with a combination of elements (weapon, element, abilities, etc). | ||
| ## Adventurer Searching | ||
| <img src="https://imgur.com/wmm77hF.png" width="400"> | ||
|
|
||
| ## Installation | ||
| 1. Go to the [DiscordApp developers application site](https://discordapp.com/developers/applications) and create a New Application | ||
|  | ||
| 2. Name the application anything you'd like | ||
|  | ||
| 3. Note down the Client ID, you can copy this and save it for now | ||
|  | ||
| 4. Select Bot on the left hand side, and create a new bot | ||
|  | ||
| 5. Visit the following URL, replacing the CLIENT_ID in it with the client id you copied down in step 3: https://discordapp.com/oauth2/authorize?client_id=CLIENT_IDscope=bot | ||
| 6. Select the server you want the bot to appear in | ||
|  | ||
| 7. Copy the token from the bot page | ||
|  | ||
| 8. Set the TOKEN parameter in the config_example.py file that you copied from step 7 in the file | ||
|  | ||
| 9. Change the name of the config_example.py -> config.py | ||
| 10. Install d | ||
| 10. Run the bot using the following command in the command prompt or terminal | ||
| You can search for adventurers with the following command | ||
| ``` | ||
| python main.py | ||
| ^adv [name] | ||
| ``` | ||
| Names are not case sensitive and you can use incomplete names as well. Additionally, if multiple results would be found, the latest one released in game will be pulled. | ||
|
|
||
| ## Wyrmprint and Dragon Searching | ||
| <img src="https://imgur.com/J9Gpl4R.png" width="400"> | ||
|
|
||
| ## Features | ||
| Searching for adventurers, dragons, and wyrmprints with the following command: | ||
| You can search for wyrmprints and dragons with the following command | ||
| ``` | ||
| ^(adv|wyr|dra) [name] [level] | ||
| ^(dra|wyr) [name] [leve] | ||
| ``` | ||
| Names are not case sensitive. Additionally, if multiple results would be found, they are sorted by release date in descending order. Level is an optional attribute that will list the abilities/skills of the search result. If level=1, then this gives a 0 unbind wyrmprint or dragon. If level=2, then this gives a max unbound wyrmprint or dragon. This only works with wyrmprints and dragons currently. By default the level is set to 2. | ||
| Level is an optional attribute that will list the abilities/skills of the search result. If level=1, then this gives a 0 unbind wyrmprint or dragon. If level=2, then this gives a max unbound wyrmprint or dragon. By default the level is set to 2. | ||
|
|
||
| ## Querying | ||
| <img src="https://i.imgur.com/1rs8lfC.png" width="400"> | ||
|
|
||
| There exists additionally a query function to find adventurers, dragons, or wyrmprints with specific skills, abilities, rarities, element, weapon, etc. | ||
| ``` | ||
| ^query type=(adv|wyr|dra) key=value | ||
| ``` | ||
| Key is defined as an attribute (such as element or weapon) where value is the value of the key. Multiple key value pairs can be given. If the value has spaces, surround it with quotes. Below is an example searching for water axe adventurers with the Freeze Res ability. | ||
| Key is defined as an attribute (such as element or weapon) where value is the value of the key. Multiple key value pairs can be given. If the value has spaces, surround it with quotes. Below is an example searching for adventurers with the Bog Res ability at 100%. | ||
| ``` | ||
| ^query type=adv element=Water ability="Freeze Res" weapon=Axe | ||
| ^query type=adv ability="Bog Res +100%" | ||
| ``` | ||
| Be warned this will return ALL results, and may spam the chat log. Use at your own discretion. | ||
|
|
||
| ## LICENSE | ||
| # Installation | ||
| ## Requirements | ||
| - [Python 3.6 or higher](https://www.python.org/) | ||
| - [discord.py 0.16.12](https://github.com/Rapptz/discord.py) | ||
|
|
||
| ## Instructions | ||
| 1. If not installed, download [Python 3.6 or higher](https://www.python.org) | ||
| 2. Once installed, open a command prompt window or terminal window and type the following to install [discord.py 0.16.12](https://github.com/Rapptz/discord.py): | ||
| ``` | ||
| python -m pip install discord.py==0.16.12 | ||
| ``` | ||
| 3. Go to the [DiscordApp developers application site](https://discordapp.com/developers/applications) and create a New Application | ||
| 4. Name the application anything you'd like | ||
| 5. Note down the Client ID, you can copy this and save it for now | ||
| 6. Select Bot on the left hand side, and create a new bot | ||
| 7. Visit the following URL, replacing the CLIENT_ID in it with the client id you copied down: https://discordapp.com/oauth2/authorize?client_id=CLIENT_IDscope=bot | ||
| 8. Select the server you want the bot to appear in | ||
| 9. Copy the token from the bot page | ||
| 10. Set the TOKEN parameter in the config_example.py file that you copied from the previous stip into the file | ||
| 11. Change the name of the config_example.py -> config.py | ||
| 12. Run the bot using the following command in the command prompt or terminal | ||
| ``` | ||
| python main.py | ||
| ``` | ||
|
|
||
| # Issues | ||
| For any issues please submit the <b>command entered along with the output from the command prompt or terminal</b>. This will give the full stack trace exception and the command will allow for debugging any particular issues. | ||
|
|
||
| # LICENSE | ||
| This project is licensed under the [MIT License](https://github.com/eesandoval/NefBot/blob/master/LICENSE). |