Skip to content

Commit

Permalink
added readme and some changes
Browse files Browse the repository at this point in the history
  • Loading branch information
imnaiyar committed Jun 3, 2024
1 parent a686751 commit 6181d61
Show file tree
Hide file tree
Showing 4 changed files with 6,344 additions and 7 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ node_modules
.env
logs/
src/commands/wip/
messageData.json
package-lock.json
.env.ex
test.js
errors.toml
Expand Down
74 changes: 72 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,72 @@
Converting to ESM as well as TS
# WIP

<h1 align="center">
<br>
<a href="https://github.com/imnaiyar/SkyHelper"><img src="https://skyhelper.xyz/assets/img/boticon.png" height="200" alt="SkyHelper"></a>
<br>
SkyHelper
<br>
</h1>

<p align="center">Shards, Next Shards, Seasonal Guides, Timestamp, Sky Times and more...</p>
<p align="center"><img src="https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E"/> <img src="https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white"/> <img src="https://img.shields.io/github/stars/imnaiyar/SkyHelper"/> <img alt="GitHub release (with filter)" src="https://img.shields.io/github/v/release/imnaiyar/SkyHelper"> <img alt="GitHub License" src="https://img.shields.io/github/license/imnaiyar/SkyHelper">
<img alt="GitHub package.json dependency version (subfolder of monorepo)" src="https://img.shields.io/github/package-json/dependency-version/imnaiyar/SkyHelper/discord.js">
</p>
<br>

<p align="center">
<a href="https://skyhelper.xyz">Website</a>
<a href="https://skyhelper.xyz/invite">Invite</a>
<a href="https://skyhelper.xyz/vote">Vote</a>
<a href="https://docs.skyhelper.xyz">Documentation</a>
<a href="https://discord.com/invite/u9zUjWbbQ4">Support Server</a>
</p>

<br>
<div align="center">
<a href="https://top.gg/bot/1121541967730450574">
<img src="https://top.gg/api/widget/1121541967730450574.svg" alt="Discord Bots">
</a>
</div>

## Building the bot
- Clone this repository by running
```js
git clone https://github.com/imnaiyar/SkyHelper
```
- Rename `example.env` to `.env` and fill all the required fields.
- Install the required deps by running `npm i`
- Run `npm run build` to build the project
- Run ```npm run commands``` to register the slash commands.
- [Prefix Commands](https://github.com/imnaiyar/SkyHelper/tree/main/src%2Fcommands%2Fprefix) is for my personal use and you can chose to delete the folder if you wish. Should you delete, `messageCreate.ts` event won't be needed either and you can remove that too.
- Run `npm start` to start the project
# Credits
This bot wouldn't be possible without these people and the work they do.

**__Shards Predictions__**
- Zhii (zhiiran4275)
- Christian (christiankingfu)
- Hucker (hucker_)
- Plutoy (plutoy)
- Kion (kion_anzu)
- LN (ln.cookie)
- Gale (galerowfylery)
- Stoat (.stoat.)

**__Seosanal Guides__**
- Clement (clement8978)
- Mimi (mimi4117)
- Sam (sam6917)
- Zed (zedlocked_)
- Art (lovecry)
**and all others who do the awesome job of creating guides.**

**__Special Mentions__**
- Big thanks to Xander (_a.l._) and Christian (christiankingfu) for testing the early version of this bot.
- Thanks to Plutoy (plutoy) for creating the [Sky Shards website](https://sky-shards.pages.dev/), which was the initial inspiration for the bot.
- Emotes icon, traveling spirits descriptions and some aspects of guides have been taken from [Sky Wiki](https://sky-children-of-the-light.fandom.com/wiki/Sky:_Children_of_the_Light_Wiki).

<h6 align="center">This bot is not affiliated with Sky: Children of the Light or thatgamecompany<h6>
Loading

0 comments on commit 6181d61

Please sign in to comment.