[pull] main from andrewthederp:main

README.md

@@ -1,20 +1,15 @@
-<p align="center">
- <img src="./docs/src/disgames.png" height="125px" width="125px" />
-</p>
-
-<h1 align="center">Disgames</h1>
 A python module made to make creating games easier and adds a bunch of game commands to your discord python bot
 
 ---
-Note: The logo has been designed by using resources from [flaticon.com](https://www.flaticon.com/)
-
-
 ## Contents
 
 - [Disgames](#disgames)
   - [Contents](#contents)
   - [Installation](#installation)
   - [Usage](#usage)
+  - [Configuration](#configuration)
+  - [Winnings](#winnings)
+  - [Example](#example)
   - [Extra](#extra)
 
 ## Installation
@@ -33,31 +28,36 @@ pip install git+https://github.com/andrewthederp/Disgames
 
 ## Usage
 
-You can either load it as an extension by doing
-
-```py
-from discord.ext import commands
-
-bot = commands.Bot("YOUR_PREFIX_HERE")
-
-bot.load_extension("disgames")
-```
-
-or call the `register_commands` function manually by doing
-
-```py
-from disgames import register_commands
-from discord.ext import commands
-
-bot = commands.Bot("YOUR_PREFIX_HERE")
-register_commands(bot)
-```
-
-More examples on customizing the commands added to your bot can be seen in [`examples/`](./examples/)
-
-And that's it! now your bot has the games implemented in [`disgames/mixins/`](./disgames/mixins/)
+- Import the class of the game you want from the controls type you want
+  - E.g. `from disgames.button_games import Chess`
+- Create an instance of the class while providing the necessary args/kwargs
+  - E.g. `game = Chess(ctx, white=ctx.author, black=member)`
+- Start the game by running the start function and providing the necessary args/kwargs
+  - E.g. `game.start(end_game_option=True)`
+
+More examples can be seen in [`examples/`](./examples/)
+
+## Configuration
+You can configure some variables that are used throughout the module
+- `disgames.ongoing_game_color` The color of the embed while the game is still running
+- `disgames.lost_game_color` The color of the embed when the player looses (only used in singleplayer games)
+- `disgames.won_game_color` The color of the embed when the player wins
+- `isgames.drawn_game_color` The color of the embed when the game draws
+- `disgames.resend_embed_list` A list of strings, if the player sends a message which is in the list. The game embed will be re-sent (only used in message games)
+- `disgames.end_game_list` A list of strings, if the player sends a message which is in the list. The game will end (only used in message games)
+
+Example of changing a variable: `disgames.drawn_game_color = 0x000000`
+
+## Winnings
+The start function will return any of `discord.Member`/`True`/`False`/`None`/`list`/`0`
+- `True`/`False` will only be returned if the game is a single player game and it means the author has won/lost
+- `None` means the game has ended in a draw
+- `discord.Member` means that that person has won the game
+- `list` would be a list of bools, this is only returned by `Soko`. A `True` will be added into the list for every game the user wins. And the last item in the list will always be `False` if `play_forever` is set to `True`
+- `0` means that the game timed out
+
+## Examples
+Coming soon!
 
 ## Extra
-
-Note that this works with the now discontinued module [discord.py](https://pypi.org/project/discord.py) and we
-will make it compatible with other modules as soon as possible
+Note that this package only works with [discord.py](https://pypi.org/project/discord.py) and other modules that use the `discord` namespace

disgames/__init__.py

@@ -1,47 +1,42 @@
-from .cog import *
-from .constants import *
-from discord.ext import commands
-from .errors import PathNotFound
-from .mixins import TicTacToe, TicTacToeReactions
 from typing import NamedTuple
-buttons = False
-try:
-    from discord.ui import Button
-    from discord.ui import View
-    buttons = True
-except ImportError:
-    pass
+import discord
 
+resend_embed_list = ['re-send','resend']
+end_game_list = ['end','stop','quit']
+
+ongoing_game_color = discord.Color.blurple()
+lost_game_color = discord.Color.red()
+won_game_color = discord.Color.green()
+drawn_game_color = discord.Color.red()
 
 __title__ = 'disgames'
 __author__ = 'andrewthederp'
 __license__ = 'Apache License 2.0'
 __copyright__ = 'Copyright 2021-2022 Andrewthederp and MarzaElise'
-__version__ = '2.3.0'
-
-def register_commands(
-    bot, *, ignore: list = [], stockfish_path=None, ttt_reactions=False, button_commands=True
-):
-    if button_commands:
-        ignore.extend(BUTTON_GAMES if not buttons else NON_BUTTON_GAMES)
-    else:
-        ignore.extend(BUTTON_GAMES)
-    games = []
-    if ttt_reactions:
-        ignore.append(TicTacToe)
-        ignore.append(TicTacToeButtons)
-        games.append(TicTacToeReactions)
-    games += [game for game in ALL_GAMES if game not in ignore]
-
-    class Games(*games):
-        def __init__(self, bot):
-            for cls in games:
-                cls.__init__(self, bot)
-
-    g = Games(bot)
-    if stockfish_path:
-        g.stockfish_path = stockfish_path
-    bot.add_cog(g)
+__version__ = '3.0.0'
+
+def enable_better_formatting():
+    import os
+    os.system('pip install git+https://github.com/andrewthederp/FormatGame')
+    try:
+        import format_game
+        return 1
+    except ImportError:
+        return 0
+
+class FormatType:
+    plain = 0
+    plain_codeblock = 1
+
+    listed = 2
+    listed_codeblock = 3
+
+    emojis = 4
+    emojis_codeblock = 5
+
+    image = 6
+
+    text = 7
 
 class VersionInfo(NamedTuple):
     major: int

disgames/__main__.py

@@ -1,33 +1,20 @@
 import aiohttp
 import argparse
-import chess
-import disgames
 import platform
-import sys
+from __init__ import VersionInfo
 from typing import Tuple
-import chess
-import akinator
-import sys
-
-VersionInfo = disgames.VersionInfo
 
 def version() -> None:
-    entries = [
-        '- Python v{0.major}.{0.minor}.{0.micro}-{0.releaselevel}'.format(
-            sys.version_info
-        )
-    ]
-
+    entries = []
 
-    version_info: VersionInfo = VersionInfo(major=2, minor=0, micro=1)
+    entries.append('- Python v{0.major}.{0.minor}.{0.micro}-{0.releaselevel}'.format(sys.version_info))
+    version_info: VersionInfo = VersionInfo(major=3, minor=0, micro=0)
     entries.append('- Disgames v{0.major}.{0.minor}.{0.micro}'.format(version_info))
-    entries.append(f'- aiohttp v{aiohttp.__version__}')
+    entries.append(f'- aiohttp v{aiohttp.__version__}') 
     entries.append(f'- Chess v{chess.__version__}')
-    entries.append(f'- Akinator v{akinator.__version__}')
 
     uname = platform.uname()
     entries.append('- System Info: {0.system} {0.release} {0.version}'.format(uname))
-    print('\n'.join(entries))
 
 def show_version(parser, args) -> None:
     if args.version: