https://github.com/pazuzu156/persephone

https://github.com/pazuzu156/persephone

bot lastfm

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/pazuzu156/persephone
• Owner: pazuzu156
• License: mit
• Created: 2019-08-06T21:57:23.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2021-01-02T16:55:18.000Z (over 5 years ago)
• Last Synced: 2024-06-20T16:35:08.380Z (about 2 years ago)
• Topics: bot, lastfm
• Language: Go
• Homepage: https://persephonebot.net
• Size: 4.63 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Persephone

![Go](https://github.com/pazuzu156/persephone/workflows/Go/badge.svg)

![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability-percentage/pazuzu156/Persephone?label=maintainability&style=flat-square)

![GitHub release](https://img.shields.io/github/release/pazuzu156/persephone?style=flat-square)

![GitHub last commit](https://img.shields.io/github/last-commit/pazuzu156/persephone?style=flat-square)

[![Snyk Vulnerabilities for GitHub Repo](https://api.kalebklein.com/persephone/vulns/)](https://app.snyk.io/org/pazuzu156/project/cf386f24-aa5b-4f69-b7ef-657e3f8d3c03)

Persephone is a Discord bot that's used to interface with Lastfm, and is built to be used with the Untrodden Corrodors of Hades Discord server.

## Used Libraries

Libraries used for the bot will be listed here (you can also see them listed in `go.mod`)

- [Disgord](https://github.com/andersfylling/disgord) The Discord library for Go

- [Atlas](https://github.com/pazuzu156/atlas) The command router for Disgord (fork of [Aurora](https://github.com/polaron/aurora))

- [Lastfm-Go](https://github.com/pazuzu156/lastfm-go) The Last.FM API library for Go (fork)

- [gg](https://github.com/fogleman/gg) 2D Image generation for Go

- [genmai](https://github.com/naoina/genmai) Database ORM for Go

-  MySQL driver used with database

- [Colly](https://github.com/gocolly/colly) For hex conversions for embed colors

## Building

Building is quite easy, just make sure you have [Go](https://golang.org/) installed, and run `go build` You should be able to run the compiled executable after making required changes to `config.json` for your bot

### Linux

On Linux, to build for distribution (or to install on your system) use the provided Makefile.

    $ make; make install

    ...

Do not run `make install` with sudo, it will run sudo when needed. Make sure you update your configuration in `~/persephone/config.json` so the bot will run

## Contributing

Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for more info

## Planned Features

Theres a fair bit I want to do with this bot, I'll add a list of features here when I think of them, and if I find them an obtainable goal

## Donations

Not everyone wants to do a whole lot. But, you can do a small ;) A donation helps keep the bot alive by paying for the server it and it's website run on. And of course, I could always use a beer.

If you want to help out with a small donation, the best ways are the following:

- [PayPal](https://paypal.me/pazuzu156/1)

- Bitcoin: 16vSYHE6Y1icSoFPdc76B32n552YvzZGh6

- Stellar: GCHEI6MJ3QTNEVMK3JB66YT7AHJ7UFTVUY7UDF7TXA3ZGZQOMHVT2AUL

- ZCash: t1eXVKCNwzVYUiT2QS97mr1yBGDbHG2kJfR