The bot for Almaren
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Sapein 5e01c4575e Fix path error 5 months ago
almaren_bot Have a bit better stuff for working as a system 5 months ago
docs Create some documentation on creating a Plugin. 6 months ago
tests Update Tests and add in Jenkins things 5 months ago
.gitignore update gitignore 6 months ago
AUTHORS First Commit 6 months ago
Jenkinsfile Fix path error 5 months ago
LICENSE First Commit 6 months ago
Makefile Make things probably work, hopefully 5 months ago
Pipfile Add in requirements.txt and Pipfiles 6 months ago
Pipfile.lock Add in requirements.txt and Pipfiles 6 months ago
README.md Update documentation 5 months ago
TODO Update TODO 5 months ago
dev_requirements.txt Add in requirements.txt and Pipfiles 6 months ago
ns_requirements.txt Add in requirements.txt and Pipfiles 6 months ago
requirements.txt Add in requirements.txt and Pipfiles 6 months ago
setup.py Add in setup.py 5 months ago

README.md

PotatoBot

A simple, useful, and extensible Discord Bot.

Features

  • Powerful plugin system to create commands

Requirements

Development

[TO BE WRITTEN]

Copyright and License

All copyrights of the bot belongs to the individual authors.

Source code is provided under the MIT License, see LICENSE for more information

QnA (New)

What is PotatoBot?

It’s a basic Discord Bot written for the region of Almaren on NationStates, however I have since rewritten it as a generic base for other Discord Bots, which is able to be used for other bots (and is used for Almaren).

Why should I use this?

There are better bots out there, the bot you get straight from this is VERY bare-bones, but the plugin-API is rather powerful (albeit it doesn’t have all features implemented yet). Therefore you can do a log with plugins.

What is a Pipefile?/What is the Pipefile.lock file?

These are a new kind of file being used for tracking dependencies and the like for Python programs, although it’s rather unstable. It is an option though, and one that will likely gain popularity as time goes on, I use it along with requirements.txt files (and eventually a setup.py) though so you don’t have to use Pipenv. The Pipfile.lock file merely allows for reproducable builds.

Why is the bot so small and simple?

Well, it’s because I wanted something small, simple, and easy to maintain. Additionally I wanted to move as much out of the bot as possible, so that I can customize it and work on it easier.

What is NSV?

NSV is something for NationStates, the NS code is going to be moved to a new repo at some point, I just haven’t gotten to doing so yet.

How can I be sure things won’t change?

You can’t, however I do generally try to not remove the old-way of doing things suddenly. Generally you can expect that any massive changes will be done in a branch and then merged back into the master branch later on. Afterwards it will get merged in at some point. The only somewhat stable API in this for now is the bot in almaren.py and the plugin api.