Using the Official Mantaro Bot

Just one click and you can add Mantaro to your own server and enjoy its full feature set!

You can see more information about the bot itself by reading the summary on here. This is the file we use to publish our bots on bot lists, too. You're welcome to use it as a guide for your own. Our webpage is hosted in Github Pages and outlines most features of the bot, alongside some useful links.

Building your own Mantaro

⚠ Read before attempting

The owners of Mantaro do not recommend compiling Mantaro as it is not documented, and most builds you make from pulling the main branch will be extremely unstable and (definitely) untested, probably including unfinished features. There's no stable branch, all the features are immediately added to upstream. Yes, really.
You will however sometimes see a legacy branch, a branch we create before publishing larger update containing working code, it is highly recommended basing your building process from the legacy branch, as the master branch will very likely contain broken and non-working code, at least in a case where a legacy branch exist. The current legacy branch contains the pre-mongodb migration update (7.0.0) code.

We will not provide any support whatsoever in selfhosting or building the bot by yourself. The reason for this is not only that the builds in here are highly unstable and untested, and also the fact that there are very few people (two) who could actually help with questions regarding this, most of which are busy and not available to answer said questions. Most of the build process is pretty straightforward and outlined below, though.

Building the Bot

Prerequisite:

You will need the following to utilize all of Mantaro's features when building your own instance (items marked with a star are optional):

MongoDB, at least version 6
Java Development Kit, version 16 (not lower!)
Redis, at least version 6
Wolke's Weeb API (For most of the action commands)*

We will not provide any support whatsoever in obtaining any of the above.

_{Note: The bot does not necessarily need the Weeb API key to function, but some functionality might be limited by the lack of them (no action commands). Due to the closed nature of that API, we encourage you to submit a patch that would allow custom images to be used on self-hosted instances if you'd like (ex. by pushing your own -local- API server), but keep them in line with the rest of the code.}

Editing Code:

Mantaro isn't a modular bot (sadly), but removing features is fairly easy. You can just remove the respective command or the Module file on the commands directory and everything should still work. The exception are some Modules that are required by other Modules. Make sure you pay close attention to the license as you will be required to disclose your source as well as state any changes made.

Large Language Model (LLM) or AI Training

DO NOT use our code to train any form of Artificial Intelligence, LLM or anything of the like. Our licence technically covers that (if not used for free and open software purposes), however we would like to be absolutely sure you understand that we are not ok with this.

Steps for building:

_{Please do note that you will not receive any help whatsoever while trying to make your own Mantaro build (see above).}

Make sure you have the prerequisites installed and running.
Clone this repository (you can also fork this repo and clone your fork).
Open a terminal (cmd.exe or any linux/macOS terminal) in the folder where you cloned this on.
Run gradlew shadowJar
Grab the jar from build/libs
Install mongodb and redis
Run it, wait a little for the bot to generate a file called config.json
Prepare yourself to start filling in some config values. You don't need to fill all values, though. The token and the user id are necessary to start up, you wanna set the owner IDs aswell to be able to use owner commands. Values you need to fill: token clientId, values you need to change: "bucketFactor" : 1 "isSelfHost" : true.
In config.json, you might want set the value needApi to false, or clone and run the API)

Extra runtime options:

This are java arguments that Mantaro parses outside of config.json at startup and that can be dynamically adjusted using a script, a systemd service or similar:

-Dmantaro.node-number=x - Specify the number of this node (important if you use more than once instance)
-Dmantaro.shard-count=x - Specify the amount of shards Mantaro will be starting up. (for all nodes, see below for subsets)
-Dmantaro.from-shard=x - Start Shard Manager from shard X. (inclusive)
-Dmantaro.to-shard=y- Start Shard Manager up to shard Y. (exclusive)
-Dmantaro.verbose - Log all the things.
-Dmantaro.verbose_shard_logs - Show all shard status changes.
-Dmantaro.debug - Start Mantaro with two shards and some extra logging, regardless of the settings above.
-Dmantaro.debug_logs - Use debug logs.
-Dmantaro.trace_logs - Spam your logs.
-Dmantaro.log_db_access - Log all db access. (spams your logs aswell)
-Dmantaro.disable-non-allocating-buffer - Disable LP's non-allocating buffer.

The above options can also be used as environment variables by removing -D, and replacing . with _, for example, -Dmantaro.node-number=x becomes environment variable MANTARO_NODE_NUMBER=x

Migrating data from RethinkDB to MongoDB

If you have a self-hosted Mantaro instance and want to use the master branch, run this program with both MongoDB and RethinkDB on. You can either build it or run the main function on an IDE.

Make sure to set the MIGRATOR_MONGO_URI, MIGRATOR_RETHINK_HOST, MIGRATOR_RETHINK_USER and MIGRATOR_RETHINK_PW (last two can be omitted to use defaults) environment variables. It should do the job by itself and let you know when it's done, assuming you set the database hosts/uri correctly.

Tools and Contributors

Tools Mantaro uses

Important Contributors

Many thanks to

@natanbc - A lot of backend improvements and developing. Active.
@haxiz - Responsible for maintaining user-facing documentation.
@mrlar - Wrote most of the user-facing documentation (no longer maintaining it). Responsible for maintaining/running the Support-Server.
@adriantodt - Backend development on the early stages of the bot. Was crucial to the development and thanks to him this bot is what it is now. Inactive.

And a lot more people. Check the Contributors tab!

Want to contribute? Join our server and ask in the support channel for what we need help with (you may need to wait with receiving an answer.).
Alternatively send us a Pull Request with what you see fit/think we need. However, this process may end in a rejected PR more easily.

Thanks to Crowdin for providing our project with a free OSS license to continue our localization efforts.

Legal Stuff

Using our code

Give credit where credit is due. If you wish to use our code in a project, please credit us, and take your time to read our full license. We don't mind you using Mantaro code, as it is open-source for a reason, as long as you don't blatantly copy it or refrain from crediting us. Take special care of following the license aswell.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/

The full license can be found here.

Uh oh!

License

Mantaro/MantaroBot

ErrorLooks like something went wrong!

About

Topics

Resources

License

Code of conduct

Uh oh!

Stars

Watchers

Forks

Sponsor this project

Uh oh!

Contributors 36

Uh oh!

Languages

Error
Looks like something went wrong!