An open API service indexing awesome lists of open source software.

https://github.com/favware/xiveventbuddy

A user friendly first discord bot to host your XIV events
https://github.com/favware/xiveventbuddy

bot discord events ffxiv xiv

Last synced: about 2 months ago
JSON representation

A user friendly first discord bot to host your XIV events

Awesome Lists containing this project

README

          

XIVEventBuddy

# XIVEventBuddy

**A user friendly first discord bot to host your XIV events.**

---

## About

XIVEventBuddy is a Discord bot that lets you host your FFXIV events on your Discord server. This bot aims to be user
friendly and it will never lock any features behind a paywall.

## Translating XIVEventBuddy

We use **Crowdin** to translate XIVEventBuddy's messages into different languages. If you'd like to help by contributing
new translations (or improving existing ones), [**click here**](https://crowdin.com/project/xiveventbuddy). Thank you in
advance for any contributions!

### Changing language for a server

To change the language of a server you need to enable the "Community" feature on your Discord server. Once you have done
that, you can change the "Server Primary Language" under "Community Overview"

## Developing on XIVEventBuddy

### Requirements

- [`Node.js`]: To run the project.
- [`Postgres`]: A persistent storage database database.
- [`Redis`]: Scheduling tasks.

### [Set-Up - Refer to CONTRIBUTING.md]

## A note to aspiring developers who want to self host XIVEventBuddy

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

In addition, XIVEventBuddy 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,

- [`Postgres`]: A persistent storage database database
- [`Redis`]: Caching of queries and scheduling tasks.

With this in mind, it is also worth noting that XIVEventBuddy 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.

## Links

**XIVEventBuddy links**

- [Support Server][]
- [Patreon]

**Framework links**

- [Sapphire's Website][]

## Buy us some doughnuts

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

We accept donations through Ko-fi, Paypal, Patreon, GitHub Sponsorships, and various crypto currencies. You can use the
buttons below to donate through your method of choice.

| Donate With | Address |
| :-------------: | :-----------------------------------------------: |
| Ko-fi | [Click Here](https://donate.favware.tech/kofi) |
| Patreon | [Click Here](https://donate.favware.tech/patreon) |
| PayPal | [Click Here](https://donate.favware.tech/paypal) |
| GitHub Sponsors | [Click Here](https://github.com/sponsors/Favna) |
| Bitcoin | `1E643TNif2MTh75rugepmXuq35Tck4TnE5` |
| Ethereum | `0xF653F666903cd8739030D2721bF01095896F5D6E` |
| LiteCoin | `LZHvBkaJqKJRa8N7Dyu41Jd1PDBAofCik6` |

[`postgres`]: https://postgresql.org
[`node.js`]: https://nodejs.org/en/download/current/
[`redis`]: https://redis.io
[glitch]: https://glitch.com/
[heroku]: https://www.heroku.com/
[patreon]: https://donate.favware.tech/patreon
[sapphire's website]: https://sapphirejs.dev
[set-up - refer to contributing.md]: /.github/CONTRIBUTING.md
[support server]: https://join.favware.tech