{"id":16636146,"url":"https://github.com/pyxelcodes/aetherial","last_synced_at":"2025-03-21T15:31:42.160Z","repository":{"id":246415606,"uuid":"821040657","full_name":"PyxelCodes/Aetherial","owner":"PyxelCodes","description":"The Discord Bot Library that doesn't change everything every update","archived":false,"fork":false,"pushed_at":"2024-12-29T02:27:41.000Z","size":2648,"stargazers_count":5,"open_issues_count":6,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-14T04:46:41.351Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PyxelCodes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-27T17:29:30.000Z","updated_at":"2024-12-29T02:27:44.000Z","dependencies_parsed_at":"2024-06-27T21:51:40.872Z","dependency_job_id":"e1fbd3f6-7a08-4316-93b3-7ff9d1ba6ac6","html_url":"https://github.com/PyxelCodes/Aetherial","commit_stats":null,"previous_names":["pyxelcodes/aetherial"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyxelCodes%2FAetherial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyxelCodes%2FAetherial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyxelCodes%2FAetherial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyxelCodes%2FAetherial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PyxelCodes","download_url":"https://codeload.github.com/PyxelCodes/Aetherial/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244146316,"owners_count":20405808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-12T06:05:56.971Z","updated_at":"2025-03-21T15:31:41.749Z","avatar_url":"https://github.com/PyxelCodes.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003cbr /\u003e\n    \u003ch1\u003e Aetherial \u003c/h1\u003e\n    \u003cbr /\u003e\n    \u003cp\u003e\n      \u003ca href=\"https://npmjs.com/package/aetherial\"\u003e \u003cimg src=\"https://img.shields.io/npm/v/aetherial.svg?maxAge=3600\" alt=\"npm version\" /\u003e \u003c/a\u003e\n      \u003ca href=\"https://www.npmjs.com/package/aetherial\"\u003e\u003cimg src=\"https://img.shields.io/npm/dt/aetherial.svg?maxAge=3600\" alt=\"npm downloads\" /\u003e\u003c/a\u003e\n      \u003ca href=\"https://www.npmjs.com/package/aetherial\"\u003e\u003cimg src=\"https://img.shields.io/npm/unpacked-size/aetherial\" alt=\"npm unpacked size\" /\u003e\u003c/a\u003e\n      \u003ca href=\"https://github.com/pyxelcodes/aetherial/actions\"\u003e\u003cimg src=\"https://github.com/Pyxelcodes/aetherial/actions/workflows/eslint.yml/badge.svg\" alt=\"Tests status\" /\u003e\u003c/a\u003e\n      \u003ca href=\"https://codecov.io/gh/PyxelCodes/Aetherial\" \u003e\u003cimg src=\"https://img.shields.io/codecov/c/github/pyxelcodes/aetherial\" alt=\"Code coverage\" /\u003e\u003c/a\u003e\n    \u003c/p\u003e\n\u003c/div\u003e\n\n## Usage\n\nYou will need a token and a public key from the discord developer platform\n\n```js\n  const Aetherial = require('aetherial');\n\n  const client = new Aetherial.Client(token, publicKey);\n\n  client.on('ready', () =\u003e console.log('Bot is online!'))\n\n  client.on('interactionCreate', (interaction) =\u003e {\n      interaction.reply({\n          content: \"Hello, World!\";\n      })\n  })\n```\n\nThis also works with Components\n\n```js\n  client.on('interactionCreate', (interaction) =\u003e {\n    if(interaction.isButton()) {\n      interaction.reply({\n          content: \"Hello, World!\";\n      })\n    }\n  })\n```\n\n### Using Commands\n\nIndividual Command file located in `./commands/COMMAND_NAME.js`\n\n```js\nmodule.exports = {\n    name: \"hello\",\n    run: ({ interaction }) =\u003e {\n        interaction.reply({ content: \"Hello, World!\" });\n    },\n};\n```\n\nUsing the in-built command loader which loads every command file in a subdirectory\n\n-   index.js\n-   commands\n    -   info\n        -   ping.js\n\n```js\nAetherial.loadCommands(client.commands);\n```\n\nUsing the in-built command registering function automatically registers the slash commands with discords API.\n\nThis function should only be called when there is a change to the command name list\nCalling this once every bot start is okay but not ideal.\n\n```js\nAetherial.loadCommands(client.commands);\nAetherial.registerCommands(client.commands, client.token);\n```\n\nRunning the bot locally requires a Software called ngrok.\nngrok tunnels local http requests to a static url you can enter on the discord developer page under \"INTERACTIONS ENDPOINT URL\"\n\nmake sure to add the /interactions at the end of the URL.\n\nfor example: https://name.ngrok-free.app/interactions\n\n### Using Embeds\n\n```js\ninteraction.reply({\n    embeds: [\n        new Aetherial.MessageEmbed()\n            .setDescription(`This is an Embed!`)\n            .setColor(0xff0000),\n    ],\n});\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyxelcodes%2Faetherial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyxelcodes%2Faetherial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyxelcodes%2Faetherial/lists"}