Skip to content

Latest commit

 

History

History
137 lines (101 loc) · 5.21 KB

README.md

File metadata and controls

137 lines (101 loc) · 5.21 KB

This is the open-source version of InHouseQueue using TrueSkill as MMR. Feel free to clone this and use it as a base for a personal non-commercial project.

We've been working hard and developing a custom MMR system, with many other improvements. This is also free, please take a look and invite it:

Invite

Pull requests are STILL welcome

In-House Queue

A Discord Bot designed to organise In-House Custom games for competitive 5v5 games.

Discord Servers

  • Discord Support server - Raise bugs or get help
  • Discord Queue server - Try the Bot out yourself!
  • Bot Invite link - Invite the Bot to your server

Discord Server setup

https://docs.inhousequeue.xyz/documentation/quick-start

Documentation

https://docs.inhousequeue.xyz/

All Commands

https://www.inhousequeue.xyz/commands

Installation

Running locally

Prerequisites

Python 3.9.X - Download python here

pip - https://pypi.org/project/pip/

  1. Clone or Download this repository:
git clone [email protected]:HenrySpartGlobal/InHouseQueue.git

  1. Rename a .env.example to .env.

  2. Fill in all the details Check out https://github.com/InHouseQueue/generate-emoji-ids to automatically print emoji Ids without doing these 1 by 1. Make sure you have emojis uploaded to your server. Only fill in emoji IDs for the games you are playing.

# Discord Bot Token
TOKEN=

# Emoji ID's for Roles in League of Legends
# Example <:MID:1066065288862380033>
# To get this, In discord Enter the emoji and add \ to the start of it. Then press enter.
TOP=""
JUNGLE=""
MID=""
SUPPORT=""
ADC=""

# Emoji ID's for Roles in Valorant
CONTROLLER=""
DUELIST=""
INITIATOR=""
SENTINEL=""

# Emoji ID's for Roles in Overwatch
TANK=""
DPS=""
SUPPORT_OW=""

# Discord ID of Owners. Use the SAME ID for BOTH values if there is only 1 owner.
DEV_1=
DEV_2=

# Guild/Server ID of where the bot is running. Use the SAME ID for BOTH values if there is only 1 server.
GUILD_1=
GUILD_2=

# Discord ID of the Bot
BOT_ID=

# Discord ID of the Error Log channel. Use the SAME ID for BOTH values if there is only 1 error log channel.
ERROR_LOG_CHANNEL_ID_1=
ERROR_LOG_CHANNEL_ID_2=

  1. Install requirements.

    1. pip install -r requirements.txt

  2. Run the Bot

python3 main.py
  1. Now set up the Bot with the steps in Discord server setup

Running locally with Docker

Guide

Self-hosting

I encourage you to Invite the Bot to your server, but if you want to make some changes and host it yourself feel free. Here is my Hosting guide

More details on the MMR algorithm used

https://docs.inhousequeue.xyz/documentation/reference/sbmm

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE - see the LICENSE.md file for details

The Affero General Public License v3.0 (AGPL-3.0) is the license for this project, which offers the following key features:

  • Based on the GNU General Public License v3.0 (GPL-3.0), it includes an additional clause addressing network interaction.
  • Mandates that the entire source code be accessible to users interacting with the software over a network.
  • Ensures that modified versions and derivative works of the software also remain open-source by requiring them to adopt the AGPL-3.0 license.
  • Grants end users the freedom to use, study, share, and modify the software.
  • Preserves copyright notices, disclaimers, and license information within the source code.
  • Excludes the granting of patent rights; contributors with patents covering their contributions must license those patents to users.
  • Relieves original authors and contributors of liability for damages or warranty claims.

Acknowledgments

Aarno

Copyright © 2023 HenrySpartGlobal