Merge branch 'main' of https://github.com/Descended/MaplestoryDiscBot into main

Author: Descended

.gitignore

@@ -1,4 +1,62 @@
-
-*.pyc
+# Desc:
+#*.pyc
 src/command_logs
 .idea/
+
+# KOOKIIE:
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot

LICENSE

@@ -4,8 +4,8 @@ you agree to retain the names of the authors and contributors (hereafter referre
 to as "the list") laid out as part of the "!credits" command (hereafter referred
 to as "the command"), as well as the command itself. You may append new
 contributors to the list, following addition of new features. You may append new
-authours to the list, following transformative changes to the software.
-You may neither remove existing names from the list, nor the command.
+authors to the list, following transformative changes to the software.
+You may neither remove existing names from the list, nor the command itself.
 You may not restrict users' access to the command.
 
                     GNU AFFERO GENERAL PUBLIC LICENSE

README.md

@@ -5,87 +5,38 @@
   MaplestoryDiscBot is a Python-based Discord Bot designed for MapleStory private servers.
 
   This bot allows direct access to and/or manipulation of data via the database, as well as through web-requests (proprietary API).
+  
+  #### Current Version: v0.2.0 Alpha [(Change Log)](changelog.md)  
 
 ## SETUP
-### Generate Token  
-#### Creating a New Discord Application/Bot:  
-  - Visit the [Discord Developer Portal](https://discord.com/developers/applications).
-    - Login (if applicable).
-  - Click on the `New Application` button, at the top right of the page.
-    - Enter your desired application name.
-  - Make sure the new application that you've just created is currently selected (which should automatically be the case)
-    - Select `Bot` in the left side-panel.
-  - Click on the `Add Bot` button (under the `Build-A-Bot` section), at the top right of the page. 
-  - Under `Token`, click on the `Copy` button to have it added to your clipboard. :octocat:
-### Configure Bot
-Configuration file path: `src/settings/Config.py`  
-  - The config file has all the required fields marked out as `REQUIRED`.  
-  - The config file has all its fields explained with comments.   
+For the set-up guide refer to the project [wiki](https://github.com/Descended/MaplestoryDiscBot/wiki/Setup)
 
-**NOTE:** This bot assumes that it is run on the same machine as the private server & its database.
-  - This behaviour may be altered in the config file as well.  
 ## Features
+For full list of commands and how to use them, refer to the project [wiki](commands)
 ### General Commands
   - Display help page
-    - `!help` or `!commands`
   - Display character info
-    - `!character` or `!char` or `!player`
   - Display guild info
-    - `!guild` or `!guildinfo`
   - Display ranking
-    - `!rankings` or `!ranking` or `!ranktop`
   - Display online players
-    - `!online`
   - Display credits
-    - `!credits` or `!credit`
+  - Display server info
 
 ### Admin Commands  
-  - Transfer items
-    - `!duey` or `!giveitem`
   - Disconnect player
-    - `!dc`
   - Whisper to player in-game
-    - `!whisper` or `!msg`
   - Post in-game notice
-    - `!notice`
   - Unban player in-game
-    - `!unban` or `!pardon`
   - Promote player to GM in-game
-    - `!setgmlevel` or `!makegm`
 
 ## Gallery
 *Images pending. To be appended when RC1 is ready.*
-## Miscellaneous
-### Technical Details
-##### Current Version: v0.0.15 Alpha  
-Changelog: [changelog.md](changelog.md)
-
-|  | Targeted | Tested |
-|---|---|---|
-| Python | 3.6 | ? |  
-
-### Auto-launch:
-Run the batch file `start.bat`
-
----
-### Manual launch:
-#### Option A: Using the virtual environment
-The virtual environment is part of the repository (as of time of writing).  
-You may use it after cloning without needing to set it up yourself.
-##### Command Prompt route:
-  - Activate the virtual environment using `call venv\scripts\activate.bat`
-    - Note: You can deactivate the venv by using the command deactivate
-  - Use the command `venv\scripts\python src/Main.py` to run
-##### PowerShell route: 
-  - Activate the virtual environment using `venv\scripts\activate`
-    - Note: You can deactivate the venv by using the command deactivate
-  - Use the command `venv\scripts\python src/Main.py` to run  
-    
-  
-#### Option B: Using the global environment
-  - `python src/Main.py`
 
 ---
 
 ### Notes prior to use
-Please read the license agreement prior to use, since the act of using this software implies agreement to the license. Note in particular the opening statement, as well as Section 13 of the AGPL license.
+Please read the license agreement prior to use, since the act of using this software implies agreement to the license. Note in particular the opening statement, as well as Section 13 of the AGPL license.
+
+---
+## CREDITS
+**BIG BIG BIG THANKS TO ASURA! (@Asura#6332 on Discord)**

changelog.md

@@ -58,4 +58,24 @@
   - Added change log
 ## v0.0.15 Alpha  
   - Updated batch file to allow venv
-  - Added details to `features` segment of README
+  - Added details to `features` segment of README
+## v0.0.16 Alpha  
+  - Added `get_gm_level(name)` utility function
+  - Fixed `set_gm_level(name, level)` utility function
+  - Added command for awarding vote points
+  - Migrated repository (Raise **Minor** version number to "1")
+    - Old commit links (from before this point) are officially dead
+## v0.1.0 Alpha
+[More code documentation, and removed desc's weird use of for loops](https://github.com/Descended/MaplestoryDiscBot/commit/e26b3bc86523085be9c1a07ec3651f18dd8ac68e)  
+  - Documentation refactoring (shifted some contents of the README to the Wiki)
+  - Code optimisation (by removing unnecessary `for` loops)
+## v0.2.0 Alpha
+[some bot updates](https://github.com/Descended/MaplestoryDiscBot/commit/f079569dd8b16cd079fe48c60d78f954c974155e)  
+[added the ability for the bot to restart on crash](https://github.com/Descended/MaplestoryDiscBot/commit/ab77c8a53a21acf40572139550b7806ad6bff267)  
+[Bot updates](https://github.com/Descended/MaplestoryDiscBot/commit/ba38ffc0e6d6abeb81362d397d022cd17707bf65)  
+[set add_role to False as default](https://github.com/Descended/MaplestoryDiscBot/commit/59805a7a9e8a03a50879245d1f9736e59840f151)  
+[added info command to list of commands to log](https://github.com/Descended/MaplestoryDiscBot/commit/c53f374f9ee79115303f2e8cb591229ba758b1fc)  
+  - Added logic for `!info` command
+  - Added logic for auto-restart (turned off by default)
+  - Added logic for role-assignment (gateway intents MUST be enabled as of discord.py v1.5 and later)
+  - Documentation updates

src/ApiHandler.py

@@ -3,6 +3,9 @@
 
 
 class API:
+    """
+        Static class that handles all requests to API server
+    """
 
     @staticmethod
     def get_server_info():

src/DatabaseHandler.py

@@ -1,10 +1,12 @@
 import mysql.connector
-import requests
 
 from src.settings import Config
 
 
 class DatabaseHandler:
+    """
+        Static class that handles all requests/calls to Database
+    """
 
     @staticmethod
     def get_character_stats(character_name):
@@ -128,6 +130,11 @@ def unban_account(name):
 
     @staticmethod
     def get_rankings(category):
+        """
+        Given a SQL Column (i.e. mesos, nx), order it Descending (Greatest to Least) and return the list
+        category: string
+        Return: dict, boolean
+        """
         try:
             con = mysql.connector.connect(host=Config.DATABASE_HOST, user=Config.DATABASE_USER,
                                           password=Config.DATABASE_PASS, database=Config.DATABASE_NAME)
@@ -181,7 +188,8 @@ def get_gm_level(name):
                                           password=Config.DATABASE_PASS, database=Config.DATABASE_NAME)
             cursor = con.cursor(dictionary=True)
             cursor.execute(
-                f"SELECT gm from characters WHERE name = '{name}'")  # selects gm level, most sources only have it so the characters are gm and not the accounts change this if ur source has account wide gm
+                f"SELECT gm from characters WHERE name = '{name}'")
+            # selects gm level, most sources only have it so the characters are gm and not the accounts change this if ur source has account wide gm
             rows = cursor.fetchall()
             if len(rows) == 0:  # checks if character exists
                 return False
@@ -202,7 +210,8 @@ def set_gm_level(name, level):
             con = mysql.connector.connect(host=Config.DATABASE_HOST, user=Config.DATABASE_USER,
                                           password=Config.DATABASE_PASS, database=Config.DATABASE_NAME)
             cursor = con.cursor(dictionary=True)
-            cursor.execute(f"UPDATE characters SET gm = {level} where name = '{name}'")  # updates gm level, most sources only have it so the characters are gm and not the accounts change this if ur source has account wide gm
+            cursor.execute(f"UPDATE characters SET gm = {level} where name = '{name}'")
+            # updates gm level, most sources only have it so the characters are gm and not the accounts change this if ur source has account wide gm
             con.commit()  # commits all changes to the database
             con.disconnect()
             return f"Successfully gave GM level {level} to: {name}"

src/Main.py

@@ -1,5 +1,6 @@
 import sys
 from os import path
+
 # Necessary to run from a batch file unfortunately
 sys.path.append(path.dirname(path.dirname(path.abspath(__file__))))
 
@@ -12,7 +13,10 @@
 
 start_time = time.time()
 
-client = commands.Bot(command_prefix=Config.PREFIX)
+intents = discord.Intents.default()
+intents.members = True
+
+client = commands.Bot(command_prefix=Config.PREFIX, intents=intents)
 
 
 @client.event
@@ -23,6 +27,14 @@ async def on_ready():  # method that is called when bot is online
     await client.change_presence(activity=discord.Game(name=Config.BOT_STATUS))
 
 
+@client.event
+async def on_member_join(member):  # method that is called when a member joins the discord server
+    if Config.ADD_ROLE:
+        role = discord.utils.get(member.guild.roles, name=Config.ROLE_TO_GIVE)
+        print(member.name + " has joined the discord server")
+        await member.add_roles(role)
+
+
 @client.event
 async def on_message(ctx):  # method that is called whenever a message is sent into discord server
     await CommandHandler.handle_commands(client, ctx)

src/Utils.py

@@ -32,6 +32,12 @@ def get_giveaway_info():
 
     @staticmethod
     def is_command(cmd):
+        """
+            Checks if a given string is a command the bot has.
+            Is used to check whether to log a command in command_log.txt
+            cmd: string
+            Return: boolean
+        """
         for command in Config.COMMANDS:
             if cmd == Config.PREFIX + command:
                 return True