https://github.com/eludris-community/evangeline

An API wrapper for Eludris.
https://github.com/eludris-community/evangeline

eludris eludris-api eludris-wrapper typescript

Last synced: 7 days ago
JSON representation

An API wrapper for Eludris.

• Host: GitHub
• URL: https://github.com/eludris-community/evangeline
• Owner: eludris-community
• License: mit
• Created: 2022-11-29T20:20:12.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-21T15:20:21.000Z (about 1 year ago)
• Last Synced: 2024-08-01T10:16:57.123Z (3 months ago)
• Topics: eludris, eludris-api, eludris-wrapper, typescript
• Language: TypeScript
• Homepage: https://evangeline.pages.dev
• Size: 88.9 KB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# evangeline

An API wrapper for [Eludris](https://elusite.pages.dev) written in TypeScript

(works with JavaScript as well).

## Installation

```

npm install evangeline

```

or

```

yarn add evangeline

```

## Basic Usage

```ts

import { Bot } from 'evangeline'; // ES modules

// const { Bot } = require('evangeline'); // CommonJS modules

const bot = new Bot('new bot name');

bot.on("messageCreate", async (msg) => {

    switch(msg.content) {

        case "!ping":

            await bot.send("pong!");

        case "!speed":

            await bot.send("Am I fast?");

  }

});

bot.connect();

```

## Notice

It is worth noting that Evangeline is currently in development, and likely does

not work properly as of yet. If you would like to contribute, please feel free to

do so, by making a Pull Request, or giving me some tips in the Eludris guild 💜.

## License

MIT License

Copyright (c) 2022-present Sham