Git Product home page Git Product logo

skyra-project / skyra Goto Github PK

View Code? Open in Web Editor NEW
278.0 9.0 72.0 56.34 MB

A multipurpose Discord Bot designed to carry out most of your server's needs with great performance and stability.

Home Page: https://skyra.pw

License: Apache License 2.0

TypeScript 99.52% PowerShell 0.04% JavaScript 0.36% Dockerfile 0.07%
discordjs skyra discord-bots discord bot sapphire moderation levelling hacktoberfest

skyra's Introduction

Skyra Logo

Skyra Discord

codecov Status Servers Upvotes

Developing on Skyra

Requirements

Optional additions

Translating Skyra

We use Crowdin to translate Skyra's messages into different languages. If you'd like to help by contributing new translations (or improving existing ones), click here. Thanks for any contributions!

A note to aspiring developers who want to self host Skyra

The developer team does not support the idea of other self-hosted instances of Skyra. The team prides itself on providing the best experience and support for the end-users. As such, an offshoot or unaffiliated mirror of Skyra may cause ill effects on the reputation and image of Skyra. If you wish to see new features implemented, please refer to the developing guidelines linked above.

In addition, Skyra was built with a dependence on many services which need consistent maintenance and oversight in order to function and behave properly. These include, but are not limited to,

  • InfluxDB in order to keep anonymous metrics on bot usage
  • PostgreSQL as database
  • Other external APIs, each requiring their own individual API keys.

With this in mind, it is also worth noting that Skyra will in no way be capable of running on services such as Glitch or Heroku. A dedicated VPS (Virtual Private Server) is required in order to maintain the proper production environment.

Story

A bit of story: Skyra, formerly known as kyraBOT (renamed in the middle of March of 2017), is a multipurpose Discord Bot that was born out of curiosity in a SoloLearn guild. With help from other developers, due to my lack of experience (I made websites and templates for After Effects, but never a backend application). Skyra was born. Skyra's name comes from a comment made by a user, joining "kyra" with "SkyNET", creating "SkyraNET", I liked the name and later, she got renamed to "Skyra". Originally, it was going to be renamed as "Shiny" (name taken for the currency) or "Shyy" (original name from the lore) however I decided "Skyra" would be a better name.

Skyra does not only feature almost every feature that is needed in the majority of guilds (discord servers) while being completely configurable, she also has a backstory, inherited from the lore I have been creating since I was a child.

There have been over 14 rewrites with an active development of over two years, I have met many developers and friends in Discord, and in February 2017, I met the Dirigeants team, upon which I started to contribute to Komada, and later, for Klasa. Later in September 2020 I split from Dirigeants along with many of these developers and friends and started Sapphire, which is what Skyra is currently using, specifically Sapphire Framework

Who knows, I might write a book someday for Skyra's lore.

Links

Skyra links

Framework links

Buy us some doughnuts

Skyra Project is open source and always will be, even if we don't get donations. That said, we know there are amazing people who may still want to donate just to show their appreciation. Thanks you very much in advance!

We accept donations through Patreon, BitCoin, Ethereum, and Litecoin. You can use the buttons below to donate through your method of choice.

Donate With QR Address
Patreon PatreonImage Click Here
PayPal PayPalImage Click Here
BitCoin BitcoinImage 3JNzCHMTFtxYFWBnVtDM9Tt34zFbKvdwco
Ethereum EthereumImage 0xcB5EDB76Bc9E389514F905D9680589004C00190c
Litecoin LitecoinImage MNVT1keYGMfGp7vWmcYjCS8ntU8LNvjnqM

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Skyra Project!

skyra's People

Contributors

adiologydev avatar allcontributors[bot] avatar cfanoulis avatar darqam avatar dependabot-preview[bot] avatar dependabot[bot] avatar depfu[bot] avatar devramsean0 avatar favna avatar gc avatar github-actions[bot] avatar kunoichiz avatar kyranet avatar lioness100 avatar mrjacz avatar nm-eea-y avatar nytelife26 avatar officialsirh avatar pistasjis avatar pyrotechniac avatar quantumlyy avatar renovate[bot] avatar rexogamer avatar skillz4killz avatar soumil-07 avatar stitch07 avatar tech6hutch avatar tylertron1998 avatar vladfrangu avatar yorkaargh avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

skyra's Issues

Sharding: Implement Kurasuta

It's time we shard, Skyra can't realistically handle an identify, and this will most likely improve the uptime.

Only problem are shared caches like the one used for the usernames... #335 would definitely make this transition much easier.

Core(TypeScript): Augment Settings#get to accept an interface overload

Technically, it's completely possible to overload it so it takes a special interface, as used by Node.js's util.promisify:

CustomPromisify definition:
https://github.com/DefinitelyTyped/DefinitelyTyped/blob/3ef1069095013311df0fc6df1cb1ba92c220be19/types/node/util.d.ts#L57-L59

CustomPromisify overload usage:
https://github.com/DefinitelyTyped/DefinitelyTyped/blob/3ef1069095013311df0fc6df1cb1ba92c220be19/types/node/util.d.ts#L86

Usage examples:
https://github.com/DefinitelyTyped/DefinitelyTyped/blob/3ef1069095013311df0fc6df1cb1ba92c220be19/types/node/fs.d.ts#L864-L892

This would allow us to do message.guild.settings.get(GuildSettings.Prefix); and get string as return type, likewise message.guild.settings.get(GuildSettings.Roles.Public); would get readonly string[] as return type.

So essentially we can forget about the headache of having to do message.guild.settings.get(GuildSettings.Roles.Public) as GuildSettings.Roles.Public; which I often declare as an argument to improve code readability.

Bug(SetColor): Cannot update out of sync.

Stack Trace:

Error: Cannot update out of sync.
    at Map._save (/home/kyra/Skyra/node_modules/klasa/src/lib/settings/SettingsFolder.js:354:30)
    at Map.update (/home/kyra/Skyra/node_modules/klasa/src/lib/settings/SettingsFolder.js:300:34)
    at runMicrotasks (<anonymous>)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at default_1.run (/home/kyra/Skyra/src/commands/Social/setcolor.ts:25:3)
    at module.exports.runCommand (/home/kyra/Skyra/node_modules/klasa/src/monitors/commandHandler.js:35:23)
    at module.exports._run (/home/kyra/Skyra/node_modules/klasa/src/lib/structures/Monitor.js:99:4)

Remove Excessive @

The bot @ every time a song is played. This can get annoying if you want to repeat or listen to a queue and get @ every 2-4 minutes based on song length.

image

Curious: How do big bots like Rythm handle stuff like this?

Bug(Moderation): Property `title` of `undefined`.

Stack Trace:

TypeError: Cannot read property 'title' of undefined
    at ModerationManagerEntry.prepareEmbed (/home/kyra/Skyra/src/lib/structures/ModerationManagerEntry.ts:159:27)
    at runMicrotasks (<anonymous>)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at default_1.run (/home/kyra/Skyra/src/commands/Moderation/Utilities/case.ts:19:40)
    at module.exports.runCommand (/home/kyra/Skyra/node_modules/klasa/src/monitors/commandHandler.js:35:23)
    at module.exports._run (/home/kyra/Skyra/node_modules/klasa/src/lib/structures/Monitor.js:99:4)

Bug(StickyRoles): Property `raw` of `null`.

Stack Trace:

TypeError: Cannot read property 'raw' of null
    at default_1.add (/home/kyra/Skyra/src/commands/Management/Members/stickyRoles.ts:78:77)
    at runMicrotasks (<anonymous>)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at module.exports.runCommand (/home/kyra/Skyra/node_modules/klasa/src/monitors/commandHandler.js:35:23)
    at module.exports._run (/home/kyra/Skyra/node_modules/klasa/src/lib/structures/Monitor.js:99:4)

Bug(Music): Property `track` of `undefined`.

Stack Trace:

TypeError: Cannot read property 'track' of undefined
    at new Song (/home/kyra/Skyra/src/lib/structures/music/Song.ts:33:21)
    at Queue.add (/home/kyra/Skyra/src/lib/structures/music/Queue.ts:100:22)
    at default_1.run (/home/kyra/Skyra/src/commands/Music/add.ts:18:69)
    at module.exports.runCommand (/home/kyra/Skyra/node_modules/klasa/src/monitors/commandHandler.js:33:109)
    at runMicrotasks (<anonymous>)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at module.exports._run (/home/kyra/Skyra/node_modules/klasa/src/lib/structures/Monitor.js:99:4)

i18n: Give language files more personality

  • Use GREENTICK and REDCROSS where possible. Also add an INFORMATION emoji for messages made for prompts.
  • Use first person when talking about Skyra, she's the one saying it, no need to make her talk about herself in third person.
  • Make language less aggressive.
  • Make dates be formatted in languages, that way en-US formats MM/DD/YYYY and en-GB, es-ES, etc formats DD/MM/YYYY.
  • Use ECMA 402 (ECMAScript's Internationalization Standard) Intl features.
  • Improve wording of everything.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.