Skip to content

MidSpike/iris-utilities

Repository files navigation

Hello world, this is iris-utilities!

Information

What is I.R.I.S. Utilities?

I.R.I.S Utilities is a multi-purpose discord bot that allows you to play, have fun, and perform various other utility-related tasks.

What does I.R.I.S. stand for?

I.R.I.S. is the Interactive Reconnaissance Information Service and she's here to help!

Why is I.R.I.S. Utilities a "she"?

I.R.I.S. originally did not have a gender until a growing number of users started calling I.R.I.S. by feminine pronouns.

Does I.R.I.S. Utilities have a website?

Yes, check out iris-utilities.com!

Who was I.R.I.S. Utilities created by?

I.R.I.S. Utilities was created by Tyler S. Resch (aka MidSpike) from MidSpike.Com.

Why is I.R.I.S. Utilities on GitHub?

There are a few reasons for this:

  1. I.R.I.S. Utilities is a Discord Bot for the people; therefore, it's source-code should be viewable by the public.

  2. Open-source is beneficial: bug fixes, security patches, and general improvements can be made faster.

  3. By having public source-code, people can scrutinize the I.R.I.S. Utilities codebase to make it even better.

  4. This repository provides new Discord bot developers with an educational resource to reference.


Open-Source F.A.Q.

Am I allowed to use I.R.I.S. Utilities source-code?

To contribute, yes, you are allowed to fork I.R.I.S. Utilities.

To re-brand I.R.I.S. Utilities, no, you are not allowed.

To take credit for or claim ownership of I.R.I.S. Utilities, no, you are not allowed.

Remember to check up on the restrictions below for more information.

Am I allowed to self-host I.R.I.S. Utilities?

Yes, but there are restrictions on the usage of I.R.I.S. Utilities source-code. (see restrictions below).

Always be kind and never be malicious, your self-hosted instance must reflect that.

Users expect integrity and honesty from all Discord bots on the platform.


Installation and Usage

0. Prerequisites

  • Docker (recommended)
  • Enable Privileged Intents on the Discord Developer Portal:
    • Server Members
    • Message Content

1. Environment Variables

Copy and rename any .env.example file to .env and fill in the required fields.

2. MongoDB

Copy and rename the mongod.conf.example file to mongod.conf and configure it to your needs.

3.a Running with Docker (Recommended)

Make sure that Docker is installed and running on your system.

The following platforms are supported via Docker:

  • Windows: .\start.cmd
  • Linux: ./start.sh (you may have to chmod +x ./start.sh first)
  • MacOS: not tested, but that's what Docker is for!

3.b Running without Docker (Not Recommended)

Running without Docker is considered as unsupported.


Contributing

See guidelines for contributing.


Code of Conduct

See code of conduct.


Legal

Restrictions for created/modified bots:

Any Discord Bot created/modified from this source-code by anyone (other than the copyright holders) is not permitted to go through Discord's Bot Verification Program.

Any Discord Bot created/modified from this source-code by anyone (including the copyright holders) is required to use the included privacy policy located in the Privacy Notice section below.

Any Discord Bot created/modified from this source-code by anyone (other than the copyright holders) is not permitted to modify the included privacy policy and/or corresponding information.

Any Discord Bot created/modified from this source-code by anyone (including the copyright holders) must attribute the copyright holder(s) listed in the Copyright Notice below.

Any Discord Bot created/modified from this source-code by anyone (other than the copyright holders) is not permitted to modify the included copyright notice and/or corresponding information.

The restrictions above, are meant to protect users from potentially malicious copies/modifications of this source-code and uphold the authenticity of I.R.I.S. Utilities.

License Notice

We have a license for the creators and end-users of any Discord Bot created from this source-code:

Notice: The included license can and will be updated in the future!

Linked copy of the License Policy

Privacy Notice

We have a privacy policy for the creators and end-users of any Discord Bot created from this source-code:

Notice: The included Privacy Policy can and will be updated in the future!

Linked copy of the Privacy Policy

Copyright Notice

This repository is copyrighted and protected under law.

Linked copy of the Copyright Policy

About

I.R.I.S Utilities is a multi-purpose discord bot that allows you to play music, have fun, and perform various other utility-related things.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

44 stars

Watchers

2 watching

Forks

Sponsor this project

  •  

Contributors

Languages