From 3bef6da1be404afa5f8d6dca1a7da7c2462ed53d Mon Sep 17 00:00:00 2001 From: Vermium Sifell Date: Tue, 22 Mar 2022 12:13:43 +0100 Subject: [PATCH 1/3] Update config.json.example --- config.json.example | 6 ------ 1 file changed, 6 deletions(-) diff --git a/config.json.example b/config.json.example index 59e82b3..7afe0f0 100644 --- a/config.json.example +++ b/config.json.example @@ -3,12 +3,6 @@ "token": "required", "clientId": "required", "guildId": "required", - "clientSecret": "required" - }, - "dashboard": { - "url": "https://xyter.zyner.org", - "port": 80, - "licenseKey": "required" }, "colors": { "success": "0x22bb33", From 527a20534f5da6ec9e2e8169479d597914d4496e Mon Sep 17 00:00:00 2001 From: Vermium Sifell Date: Wed, 23 Mar 2022 10:26:25 +0100 Subject: [PATCH 2/3] Redesigned readme I based it upon https://github.com/Spiderjockey02/Discord-Bot/blob/master/README.md --- README.md | 74 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 60 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1b537dc..b92ccf4 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,73 @@ -# Xyter +

+
+ Xyter +
+

-## Installation +

An multi-purpose bot built with discord.js

-Rename config.json.example to config.json and fill in the fields. -_Please note that mongodb.url needs to be inside of double quotes ("YourURL")._ +
-You can leave any of the **footer** fields empty, it will not impact the bot. +[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=ZynerOrg_xyter&metric=ncloc)](https://sonarcloud.io/dashboard?id=ZynerOrg_xyter) +[![CodeFactor](https://www.codefactor.io/repository/github/ZynerOrg/xyter/badge/main)](https://www.codefactor.io/repository/github/ZynerOrg/xyter/overview/main) + +
-Then run **node deploy-commands.js** the first time then you can start the bot by **node src/index.js** +

+ About + • + Features + • + Installation + • + License + • + Credits +

-**Free MongoDB hosting** +## ❓ About -- https://atlas.mongodb.com/ +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. -## Credits +If you liked this repository, feel free to leave a star ⭐ to help promote Xyter! -**Please leave of some credits or if anyone ask about the bot, give them a link to the repository. Thanks!** +## ❗ Features -## Add it to your server +**10+** commands and counting across **13** different categories! -We have a official bot for this repository. [Invite bot!](https://discord.com/api/oauth2/authorize?client_id=949998000401436673&permissions=8&scope=bot%20applications.commands) +* 💰 **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). -## Contribute +Xyter also comes packed with a variety of features, such as: -We require developers to sign their work with a GPG key. [How do I sign my work?](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key) + * **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. + * Rewrite to TypeScript + * Make it API-driven + +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). From d1592f1122cebcd020353bbee2b8dfd09bce3a39 Mon Sep 17 00:00:00 2001 From: "Restyled.io" Date: Wed, 23 Mar 2022 09:27:18 +0000 Subject: [PATCH 3/3] Restyled by prettier-markdown --- README.md | 47 +++++++++++++++++++++++------------------------ 1 file changed, 23 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index b92ccf4..d8773e9 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,11 @@

An multi-purpose bot built with discord.js

-
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=ZynerOrg_xyter&metric=ncloc)](https://sonarcloud.io/dashboard?id=ZynerOrg_xyter) [![CodeFactor](https://www.codefactor.io/repository/github/ZynerOrg/xyter/badge/main)](https://www.codefactor.io/repository/github/ZynerOrg/xyter/overview/main) - +

@@ -36,30 +35,29 @@ If you liked this repository, feel free to leave a star ⭐ to help promote Xyte **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). +- 💰 **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! - +- **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. - * Rewrite to TypeScript - * Make it API-driven + +- Bug fixes +- Code optimisation +- New discord features +- Suggestions we deem very good. +- Rewrite to TypeScript +- Make it API-driven Some more is available in issues @@ -68,6 +66,7 @@ Some more is available in issues 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). + +- **[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).