Ito mkworld

.gitignore

@@ -3,3 +3,6 @@
 /.venv*
 /config.json
 /credentials.json
+.idea/*
+/example_configs/test/*
+staff_settings.pkl

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "python.formatting.provider": "autopep8",
+  "python.formatting.autopep8Args": ["--aggressive", "--max-line-length=79"],
+  "editor.formatOnSave": true
+}

README.md

@@ -0,0 +1 @@
+This branch lets the bot recyle using existing text channels rather than creating threads for each room.

common.py

@@ -0,0 +1,50 @@
+import json
+from enum import Enum, auto
+from typing import TypeVar, Type, List
+import config_checker
+
+_T = TypeVar('_T')
+
+with open('./config.json', 'r') as cjson:
+    CONFIG = json.load(cjson)
+
+
+class Server(Enum):
+    MKW = auto()
+    MK8DX = auto()
+    MKWorld = auto()
+
+
+if CONFIG["lounge"] == "MKW":
+    SERVER = Server.MKW
+elif CONFIG["lounge"] == "MK8DX":
+    SERVER = Server.MK8DX
+elif CONFIG["lounge"] == "MKWorld":
+    SERVER = Server.MKWorld
+else:
+    raise ValueError(
+        f"{CONFIG['lounge']} is not a valid option for the 'lounge' attribute in the config.")
+
+
+def divide_chunks(list_: list, chunk_size: int):
+    # looping till length l
+    for i in range(0, len(list_), chunk_size):
+        yield list_[i:i + chunk_size]
+
+
+def flatten(matrix: List[List[_T]]) -> List[_T]:
+    flat_list = []
+    for row in matrix:
+        flat_list.extend(row)
+    return flat_list
+
+
+def is_int(var: str) -> bool:
+    try:
+        int(var)
+        return True
+    except ValueError:
+        return False
+
+
+config_checker.check(CONFIG)

config_checker.py

@@ -0,0 +1,103 @@
+
+STRONGLY_REQUIRED_FIELDS = [
+    ("token", str),
+    ("is_production", bool),
+    ("lounge", str),
+    ("lounge_description", str),
+    ("guild_id", int),
+    ("queue_join_channel", int),
+    ("queue_sub_channel", int),
+    ("queue_list_channel", int),
+    ("queue_history_channel", int),
+    ("queue_general_channel", int),
+    ("queue_schedule_channel", (int, type(None))),
+    ("admin_roles", list),
+    ("admin_roles.list_items", int),
+    ("helper_staff_roles", list),
+    ("helper_staff_roles.list_items", int),
+    ("members_for_channels", list),
+    ("members_for_channels.list_items", (int, bool)),
+    ("roles_for_channels", list),
+    ("roles_for_channels.list_items", int),
+    ("PLACEMENT_PLAYER_MMR", int),
+    ("placement_role_id", int),
+    ("frequently_tagged_role_id", int),
+    ("restricted_role_id", int),
+    ("muted_role_id", int),
+    ("queue_messages", bool),
+    ("sec_between_queue_msgs", int),
+    ("username", str),
+    ("password", str),
+    ("url", str),
+    ("track_type", str),
+    ("FIRST_EVENT_TIME", int),
+    ("FIRST_EVENT_TIME_DESCRIPTION", str),
+    ("FORCED_FORMAT_ORDER", list),
+    ("FORCED_FORMAT_ORDER_OFFSET", int),
+    ("FORCED_FORMAT_HOURLY_OFFSET", int),
+    ("FORCED_FORMAT_AUTOSCHEDULE_AMOUNT", int),
+    ("QUEUES_BETWEEN_FORCED_FORMAT_QUEUE", (int, type(None))),
+    ("JOINING_TIME", int),
+    ("QUEUE_OPEN_TIME", int),
+    ("DISPLAY_OFFSET_MINUTES", int),
+    ("EXTENSION_TIME", int),
+    ("ROOM_JOIN_PENALTY_TIME", int),
+    ("MOGI_LIFETIME", int),
+    ("SUB_RANGE_MMR_ALLOWANCE", int),
+    ("SUB_MESSAGE_LIFETIME_SECONDS", int),
+    ("ROOM_MMR_THRESHOLD", int),
+    ("MATCHMAKING_BOTTOM_MMR", (int, type(None))),
+    ("MATCHMAKING_TOP_MMR", (int, type(None))),
+    ("USE_THREADS", bool)
+]
+
+
+def check(config: dict):
+    for required_field_name, required_field_type in STRONGLY_REQUIRED_FIELDS:
+        check_list_items = required_field_name.endswith(".list_items")
+        if check_list_items:
+            required_field_name = required_field_name[:-len(".list_items")]
+
+        if required_field_name not in config:
+            raise ValueError(
+                f"Did not find field '{required_field_name}' in config. Your config appears to be out of date.")
+        field_data = config[required_field_name]
+        if not isinstance(required_field_type, tuple):
+            required_field_type = (required_field_type,)
+        if check_list_items:
+            for item in field_data:
+                if type(item) not in required_field_type:
+                    raise TypeError(
+                        f"""For field '{required_field_name}', expected items to be of type {" or ".join([str(t) for t in required_field_type])}, but items in config were of type {type(item)}""")
+        else:
+
+            if type(field_data) not in required_field_type:
+                raise TypeError(
+                    f"""For field '{required_field_name}', expected type {" or ".join([str(t) for t in required_field_type])}, but config type is {type(field_data)}""")
+
+    # Validate tier channels data if needed
+    if not config["USE_THREADS"]:
+        required_field_name = "TIER_CHANNELS"
+        if required_field_name not in config:
+            raise ValueError(
+                f"Did not find field '{required_field_name}' in config. Your config appears to be out of date.")
+        tier_channel_data = config[required_field_name]
+        if not isinstance(tier_channel_data, dict):
+            raise TypeError(
+                f"""For field '{required_field_name}', expected type dict, but config type is {type(tier_channel_data)}""")
+        for k, v in tier_channel_data.items():
+            if not isinstance(k, str):
+                raise TypeError(
+                    f"""For field '{required_field_name}', the keys must all be of type str, but a key of type {type(k)} was found.""")
+            needed_keys = [("tier_role_id", int), ("channel_ids",
+                                                   list), ("role_ids_can_see_already", list)]
+            for sub_k, sub_type in needed_keys:
+                if sub_k not in v:
+                    raise ValueError(
+                        f"Did not find field '{sub_k}' in each item of TIER_CHANNELS in the config. Your config appears to be out of date.")
+                sub_data = v[sub_k]
+                if not isinstance(sub_data, sub_type):
+                    raise TypeError(
+                        f"""For field '{sub_k}' in TIER_CHANNELS data, found type {type(sub_data)}, expected {sub_type}.""")
+
+    print("Config file validated.")

example_configs/prod/mk8dx_prod_config.json

@@ -0,0 +1,56 @@
+{
+    "token": "",
+    "is_production": true,
+    "lounge": "MK8DX",
+    "lounge_description": "Valid options are MKW, MKWorld, or MK8DX",
+    "guild_id": 445404006177570829,
+    "queue_join_channel": 1186158671525318719,
+    "queue_sub_channel": 1186158767029620766,
+	"queue_list_channel": 1221665101904478340,
+	"queue_history_channel": 1194440106266865684,
+    "queue_general_channel": 1186158671525318719,
+    "queue_schedule_channel": 1274492585917812807,
+    "admin_roles": [
+        464610815299944448,
+        910528103225389107
+    ],
+    "helper_staff_roles": [
+        910528103225389107
+    ],
+    "members_for_channels": [
+        934740707934081035, 
+        743532508343304242, 
+        735910635082219570
+    ],
+    "roles_for_channels": [],
+    "PLACEMENT_PLAYER_MMR": 1500,
+    "placement_role_id": 730980761322389504,
+    "frequently_tagged_role_id": 682445864400453739,
+    "restricted_role_id": 600495108999086090,
+    "muted_role_id": 600495108999086090,
+    "queue_messages": true,
+    "sec_between_queue_msgs": 2,
+    "username": "username",
+    "password": "password",
+    "url": "https://lounge.mkcentral.com/",
+    "track_type": "rt",
+    "FIRST_EVENT_TIME": 0,
+    "FIRST_EVENT_TIME_DESCRIPTION": "First event time is the number of minutes from 0:00 UTC that the bot would run the first event of the day. As an example, if this were set to 5, and the QUEUE_OPEN_TIME were set to 70, and the bot were to reboot at 2:00 UTC, the next event would immediately start and create rooms at 2:25 UTC.",
+    "FORCED_FORMAT_ORDER": ["FFA", "3v3", "FFA", "4v4"],
+    "FORCED_FORMAT_ORDER_OFFSET": 3,
+    "FORCED_FORMAT_HOURLY_OFFSET": 0,
+    "FORCED_FORMAT_AUTOSCHEDULE_AMOUNT": 1,
+    "QUEUES_BETWEEN_FORCED_FORMAT_QUEUE": 9,
+    "QUEUE_OPEN_TIME": 60,
+    "JOINING_TIME": 55,
+    "DISPLAY_OFFSET_MINUTES": 5,
+    "EXTENSION_TIME": 3,
+    "ROOM_JOIN_PENALTY_TIME": 6,
+    "MOGI_LIFETIME": 180,
+    "SUB_RANGE_MMR_ALLOWANCE": 500, 
+    "SUB_MESSAGE_LIFETIME_SECONDS": 1200,
+    "ROOM_MMR_THRESHOLD": 9999999,
+    "MATCHMAKING_BOTTOM_MMR": null,
+    "MATCHMAKING_TOP_MMR": null,
+    "USE_THREADS": true
+}

example_configs/prod/mkw_ct_prod_config.json

@@ -0,0 +1,67 @@
+{
+    "token": "",
+    "is_production": true,
+    "lounge": "MKW",
+    "lounge_description": "Valid options are MKW, MKWorld, or MK8DX",
+    "guild_id": 387347467332485122,
+    "queue_join_channel": 1253109700107567155,
+    "queue_sub_channel": 1253109752418930779,
+    "queue_list_channel": 1253109466027655338,
+    "queue_history_channel": 1253109800196243618,
+    "queue_general_channel": 1253109398193045534,
+    "queue_schedule_channel": null,
+    "admin_roles": [
+        387347888935534593,
+        877629421811540016
+    ],
+    "helper_staff_roles": [
+        520808674411937792,
+        792891432301625364,
+        521149807994208295
+    ],
+    "members_for_channels": [
+        235148962103951360,
+        155149108183695360,
+        815483289515196416,
+        892420397570592768,
+        775415990238314518,
+        774812906830299136,
+        745443073202323586,
+        774866940950872095,
+        1019051989734273054
+    ],
+    "roles_for_channels":  [
+        520808645252874240,
+        520808674411937792
+    ],
+    "PLACEMENT_PLAYER_MMR": 750,
+    "placement_role_id": 723753340063842345,
+    "frequently_tagged_role_id": 1167985222533533817,
+    "restricted_role_id": 797208908153618452,
+    "muted_role_id": 434887701662007296,
+    "queue_messages": true,
+    "sec_between_queue_msgs": 2,
+    "username": "username",
+    "password": "password",
+    "url": "https://www.mkwlounge.gg",
+    "track_type": "ct",
+    "FIRST_EVENT_TIME": 5,
+    "FIRST_EVENT_TIME_DESCRIPTION": "First event time is the number of minutes from 0:00 UTC that the bot would run the first event of the day. As an example, if this were set to 5, and the QUEUE_OPEN_TIME were set to 70, and the bot were to reboot at 2:00 UTC, the next event would immediately start and create rooms at 2:25 UTC.",
+    "FORCED_FORMAT_ORDER": [],
+    "FORCED_FORMAT_ORDER_OFFSET": 0,
+    "FORCED_FORMAT_HOURLY_OFFSET": 0,
+    "FORCED_FORMAT_AUTOSCHEDULE_AMOUNT": 1,
+    "QUEUES_BETWEEN_FORCED_FORMAT_QUEUE": null,
+    "QUEUE_OPEN_TIME": 80,
+    "JOINING_TIME": 75,
+    "DISPLAY_OFFSET_MINUTES": 0,
+    "EXTENSION_TIME": 5,
+    "ROOM_JOIN_PENALTY_TIME": 8,
+    "MOGI_LIFETIME": 150,
+    "SUB_RANGE_MMR_ALLOWANCE": 700, 
+    "SUB_MESSAGE_LIFETIME_SECONDS": 1200,
+    "ROOM_MMR_THRESHOLD": 9000,
+    "MATCHMAKING_BOTTOM_MMR": null,
+    "MATCHMAKING_TOP_MMR": null,
+    "USE_THREADS": true
+}