74 lines
2.7 KiB
Markdown
74 lines
2.7 KiB
Markdown
<h1 align="center">
|
|
<br>
|
|
Xyter
|
|
<br>
|
|
</h1>
|
|
|
|
<h3 align=center>An multi-purpose bot built with <a href=https://github.com/discordjs/discord.js>discord.js</a></h3>
|
|
|
|
<div align=center>
|
|
|
|
[](https://sonarcloud.io/dashboard?id=ZynerOrg_xyter)
|
|
[](https://www.codefactor.io/repository/github/ZynerOrg/xyter/overview/main)
|
|
|
|
</div>
|
|
|
|
<p align="center">
|
|
<a href="#about">About</a>
|
|
•
|
|
<a href="#Features">Features</a>
|
|
•
|
|
<a href="https://github.com/ZynerOrg/xyter/blob/master/docs/INSTALLATION.md">Installation</a>
|
|
•
|
|
<a href="#license">License</a>
|
|
•
|
|
<a href="#credits">Credits</a>
|
|
</p>
|
|
|
|
## ❓ About
|
|
|
|
Xyter is an open source, multi-purpose Discord bot that is develoepd by students. You can invite it to your Discord server using [this](https://bot.zyner.org) link! It comes packaged with a variety of commands and a multitude of settings that can be tailored to your server's specific needs.
|
|
|
|
**To run this on Pterodactyl** please set startup command to `./node_modules/.bin/ts-node src/index.ts`!
|
|
|
|
If you liked this repository, feel free to leave a star ⭐ to help promote Xyter!
|
|
|
|
**For a more updated documentation visit [this site](https://xyter.zyner.org/)!**
|
|
|
|
## ❗ Features
|
|
|
|
**10+** commands and counting across **13** different categories!
|
|
|
|
- 💰 **Credits**: `balance`, `gift`, `top`, `work`, `give`, `take`, `set` and `transfer`!
|
|
- 💬 **Counters**: `view`, `add`, `remove`!
|
|
- 🔨 **Settings**: `guild credits`, `guild pterodactyl`, `guild points` and `user appearence`!
|
|
- 👑 **Profile**: `view`!
|
|
- 🖼 **Reputation**: `give`!
|
|
- 💰 **Shop**: `roles buy`, `roles cancel` and `pterodactyl`!
|
|
- ❔ **Utilities**: `lookup`, `about` and `stats`!
|
|
- **Full list** of commands: [here](https://github.com/ZynerOrg/xyter/blob/master/docs/COMMANDS.md).
|
|
|
|
Xyter also comes packed with a variety of features, such as:
|
|
|
|
- **Slash Commands**
|
|
- **Multi-language support**.
|
|
- And much more! There are over **5+** settings to tweak!
|
|
|
|
## 📝 To-Do
|
|
|
|
- Bug fixes
|
|
- Code optimisation
|
|
- New discord features
|
|
- Suggestions we deem very good.
|
|
|
|
Some more is available in issues
|
|
|
|
## 📖 License
|
|
|
|
Released under the [GPL-3.0 License](https://github.com/ZynerOrg/xyter/blob/master/LICENSE) license.
|
|
|
|
## 📜 Credits
|
|
|
|
- **[Vermium#9649](https://github.com/VermiumSifell)** - Founder, creator, hoster.
|
|
- **[Mastergamer433#5762](https://github.com/Mastergamer433)** - Work command for credits.
|
|
- Want to be on this list, aswell? - Check out the [Contributing page](https://github.com/ZynerOrg/xyter/blob/master/docs/CONTRIBUTING.md).
|