-
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
e16f310
commit 4432aa5
Showing
1 changed file
with
88 additions
and
1 deletion.
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 +1,88 @@ | ||
| # Kiriko | ||
|  | ||
| <p align="center"> | ||
| <img alt="Discord" src="https://img.shields.io/discord/396117030375522307?style=for-the-badge"> | ||
| <img alt="GitHub" src="https://img.shields.io/github/license/electrocute4u/tsumiki?style=for-the-badge"> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <img alt="GitHub File Count" src="https://img.shields.io/github/directory-file-count/electrocute4u/kiriko?style=for-the-badge"> | ||
| <img alt="GitHub Watchers" src="https://img.shields.io/github/watchers/Electrocute4u/Kiriko?style=for-the-badge"> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <img alt="npm" src="https://img.shields.io/npm/v/discord.js?color=lightblue&label=Discord.js&style=for-the-badge"> | ||
| <img alt="npm" src="https://img.shields.io/npm/v/npm?color=lightblue&label=NPM&style=for-the-badge"> | ||
| <img alt="npm" src="https://img.shields.io/npm/v/mongoose?color=lightgreen&label=Mongoose&style=for-the-badge"> | ||
| </p> | ||
|
|
||
| <p align="center"><a href="https://discord.js.org/#/docs/main/stable/general/welcome" target="_blank" rel="noopener">Discord.js Documentation</a> • <a href="https://www.javascript.com/" target="_blank" rel="noopener">Javascript Website</a></p> | ||
|
|
||
| ## [Table of contents](table-of-contents) | ||
|
|
||
| <details> | ||
|
|
||
| <summary>"Click to expand the Table of Contents" </summary> | ||
|
|
||
| - [About the bot](#about-the-discord-bot) | ||
| - [Who is it based on?](#who-is-it-based-on) | ||
| - [Features](#features) | ||
| - [F.A.Q](#faq) | ||
| - [Useful links](#useful-links) | ||
| - [Join the Official Server](#join-the-official-support-server) | ||
| - [License](#license) | ||
|
|
||
| </details> | ||
|
|
||
|
|
||
| # [About the Discord bot](#about-the-discord-bot) | ||
| The bot is running on **Discord.js Library** and was developed using **JavaScript** programming language. \ | ||
| It features `Player Search` and `Career Profiles`, and it covers all `heroes`, `maps` and `gamemodes` currently found in Overwatch 2. | ||
|
|
||
| ## [Who is it based on?](#who-is-it-based-on) | ||
| [Kiriko Kamori](https://overwatch.fandom.com/wiki/Kiriko) is a support hero in Overwatch 2, released during [Season 1](https://overwatch.fandom.com/wiki/Season#Season_1). | ||
|
|
||
| ## [Features](#features) | ||
| - Newest Discord.js version, with modals, dropdown menu, buttons, text/embed pagination and more! | ||
| - Covers all the `heroes`, `maps` and `gamemodes` found in Overwatch 2 | ||
| - Interacting with the unofficial [OverFast API](https://overfast-api.tekrop.fr/) for hero info, career profile and player search. | ||
| - Connecting your `Battletag` through `/link` for getting your own Career Profile faster (by using the `/career` slash command) | ||
| - `Player Search` (filter by `privacy`) and `Player Profile` (filter by `platform`, with a `hide-competitive` parameter) | ||
|
|
||
| ...And so much more! | ||
|
|
||
| ## [F.A.Q](#faq) | ||
| *Here is a short FAQ with the most common questions one mostly asks about.* | ||
|
|
||
| ### Are all maps and heroes covered? | ||
| Yes, all the maps and heroes found in Overwatch 2 are fully covered. Hero information is fetched from [OverFast API](https://overfast-api.tekrop.fr/) frequently, while maps are fully covered by myself. Feel free to contribute with map information by opening a new [issue](https://github.com/Electrocute4u/Kiriko/issues). | ||
|
|
||
| ### Player search? | ||
| You can use the `/player search` to search for any user matching a `username` (without #xxxxx discriminator) to obtain a list with all users matching that. Or you can directly get the Career profile of a user, by using their `Battletag` with the `/player profile` slash command. | ||
|
|
||
| ### I can't find my Career Profile? | ||
| First, the Battletag is __CAsE__ sensetive, meaning it has to match indentically with your actual Battletag. If you have any unique characters (i.e HƐRA#2109), make sure they are also correctly matching with your actual Battletag. If this isn't working, sign in and try your own [career page](https://overwatch.blizzard.com/en-us/career/). Should this page display "404 Not Found", the API might have issues trying to display your Career Page. You will sadly have to wait until Blizzard fixes the API sometime in the future. | ||
|
|
||
| ### What features does this bot have? | ||
| Everything is listed in the [Features](#features) section, please take a look there. | ||
|
|
||
| ### Do the bot have any premium content? Can I support the project? | ||
| The bot are currently 100% free to use and have no restrictions on commands as of now. But the system is in place and it may become active in the future. | ||
| As for supporting it, any donations are welcome. Feel free to PM **Kiriko#0001** on Discord and we can have a talk. | ||
|
|
||
| ### How often is there updates? | ||
| This is a hobby project and a JavaScript learning ground for me. Personally, I'm not doing coding as a job. So expect frequent updates whenever I have the time and resources. The project is pretty self sustainable as most of it is updated automatically, with occasions where I have to manually step in. | ||
|
|
||
| ## [Useful links](#useful-links) | ||
| - [Bot invite link](https://discord.com/api/oauth2/authorize?client_id=1038384075288875138&permissions=137439341632&scope=bot%20applications.commands) | ||
| - [Issues](https://github.com/Electrocute4u/Kiriko/issues) | ||
| - [Support server](https://discord.gg/BXN2F9PWSw) | ||
| - **Patreon:** -Coming soon- | ||
|
|
||
| ## Join the official Support server | ||
| <p><a href="http://www.discord.gg/BXN2F9PWSw"><img src="https://discordapp.com/api/guilds/396117030375522307/widget.png?style=banner2" alt="" width="342" height="81" /></a> | ||
| </p> | ||
|
|
||
| ## [License](#license) | ||
| Released under [MIT](https://opensource.org/licenses/MIT) license. | ||
|
|
||
| The bot is named after [Kiriko Kamori](https://overwatch.fandom.com/wiki/Kiriko), who is a support hero in Overwatch 2, released during [Season 1](https://overwatch.fandom.com/wiki/Season#Season_1). |