Sakamoto

A Discord Bot with no particular aim, currently has a handful of neat features, with more being added regularly.

Invite
---------------------------------------
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

A Discord Bot with no particular aim, currently has a handful of neat features, with more being added regularly. Has a strong focus on end user UX thanks to Discord's Interactions.

Use /help to get started!

(back to top)

Keep an eye on this space for updates!

Getting Started

To use the live version of this bot on your server, invite Sakamoto from This Invite Link, If you wish to customise this bot, or contribute to it, you'll need to fork this project, please see below for instructions on installation and running a local version of this bot.

Prerequisites

REQUIRES PYTHON 3.9+ TO RUN

I literally cannot stress this enough.

If you need to update or install Python, go to https://www.python.org/downloads/

Quickstart

Install Requirements:

$ git clone https://github.com/Nekurone/Sakamoto.git
$ cd Sakamoto
$ pip3 install -r requirements.txt

This should install all requirements.
Next, we need our Bot's token. See here for how to get your Bot Token We will place this within secrets.env which sits in src/core. (alternatively, use your favourite text editor to do this step)

$ cd src
$ nano core/secrets.env
# Remember, Nano is Ctrl+O to save and Ctrl+X to quit

The format we're looking for here is export TOKEN=[YOUR-TOKEN-HERE]

Usage

Now, we can run the bot.

$ python3 main.py

To edit the prefix, go into core/config.py and edit PREFIX = "!"

main.py Has a number of arguments that can be used from the terminal, which are useful for debugging and running the bot.

Args

Arg	Long	Example	Result	Options	Default
-p	--prefix	--prefix "?"	Bot runs with ? as a prefix, overriding config	Any valid prefix	Whatever is set in core/config
-l	--logging	--logging DEBUG	Sets the level of logging	Options are: CRITICAL, ERROR, WARNING, INFO, and DEBUG	WARNING

(back to top)

Roadmap

Features

Feature	Description	Started	Finished	Contributors
Admin	Owner only commands	✅	✅	Nekurone
Info	Information About the Bot	✅	✅	Nekurone
Games	Small Games to Play	✅	❌	Nekurone, timoreo22
Economhy	A currency system :)	❌	❌	N/A
Help	A Help Interactive Menu	❌	❌	N/A

See Here For all proposed Features.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

For any queries pertaining to the code, running the bot, or anything of the sorts, add me on Discord: Xorhash#4727

Alternatively, join my Programming Discord

(back to top)

Acknowledgments

• timoreo22 - Tweaks and Features
• The Great Folks of Lazy Devs - Emotional Support
• Nichijou Discord - Image Sourcing

(back to top)