Initial commit

Author: zhudotexe

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,116 @@
+# 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/
+*.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
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+.idea/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Andrew Zhu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,3 @@
+# discord-buttons-menu
+
+This project is a scratchpad for creating a menu using Discord interactions.

menu/__init__.py

@@ -0,0 +1,3 @@
+import os
+
+DISCORD_BOT_TOKEN = os.getenv("DISCORD_BOT_TOKEN")

menu/config.py

@@ -0,0 +1,44 @@
+import discord
+from discord.ext import commands
+
+import config
+import ui
+
+
+class MenuTestBot(commands.Bot):
+    def __init__(self):
+        super().__init__(command_prefix=commands.when_mentioned_or(']'))
+
+    async def on_ready(self):
+        print(f'Logged in as {self.user} (ID: {self.user.id})')
+        print('------')
+
+
+bot = MenuTestBot()
+
+
+@bot.command()
+async def counter(ctx: commands.Context):
+    """Starts a counter for pressing."""
+    await ctx.send('Press!', view=ui.counter.EphemeralCounter())
+
+
+@bot.command()
+async def servsettings(ctx: commands.Context):
+    """Change your server settings."""
+    view = ui.servsettings.ServerSettingsUI.new(
+        owner=ctx.author,
+        settings=ui.servsettings.ServerSettings(),
+        guild_name=ctx.guild.name
+    )
+    await view.send_to(ctx)
+
+
+@bot.command()
+async def csettings(ctx: commands.Context):
+    """Change your character's settings (NYI)."""
+    await ctx.send('NYI')
+
+
+if __name__ == '__main__':
+    bot.run(config.DISCORD_BOT_TOKEN)

menu/main.py

@@ -0,0 +1 @@
+from . import counter, servsettings

menu/ui/__init__.py

@@ -0,0 +1,31 @@
+"""Counter example given at https://github.com/Rapptz/discord.py/blob/master/examples/views/ephemeral.py"""
+import discord
+
+
+# Define a simple View that gives us a counter button
+class Counter(discord.ui.View):
+
+    # Define the actual button
+    # When pressed, this increments the number displayed until it hits 5.
+    # When it hits 5, the counter button is disabled and it turns green.
+    # note: The name of the function does not matter to the library
+    @discord.ui.button(label='0', style=discord.ButtonStyle.red)
+    async def count(self, button: discord.ui.Button, interaction: discord.Interaction):
+        number = int(button.label) if button.label else 0
+        if number + 1 >= 5:
+            button.style = discord.ButtonStyle.green
+            button.disabled = True
+        button.label = str(number + 1)
+
+        # Make sure to update the message with our updated selves
+        await interaction.response.edit_message(view=self)
+
+
+# Define a View that will give us our own personal counter button
+class EphemeralCounter(discord.ui.View):
+    # When this button is pressed, it will respond with a Counter view_type that will
+    # give the button presser their own personal button they can press 5 times.
+    @discord.ui.button(label='Click', style=discord.ButtonStyle.blurple)
+    async def receive(self, button: discord.ui.Button, interaction: discord.Interaction):
+        # ephemeral=True makes the message hidden from everyone except the button presser
+        await interaction.response.send_message('Enjoy!', view=Counter(), ephemeral=True)

menu/ui/counter.py

@@ -0,0 +1,60 @@
+from typing import Mapping, Optional, Type
+
+import discord
+
+
+class MenuBase(discord.ui.View):
+    __menu_copy_attrs__ = ()
+
+    def __init__(self, owner: discord.User, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.owner = owner
+        self.message = None  # type: Optional[discord.Message]
+
+    @classmethod
+    def from_menu(cls, other: 'MenuBase', cancel_other=True):
+        inst = cls(owner=other.owner)
+        inst.message = other.message
+        if cancel_other:
+            other.stop()
+        for attr in cls.__menu_copy_attrs__:
+            # copy the instance attr to the new instance if available, or fall back to the class default
+            sentinel = object()
+            value = getattr(other, attr, sentinel)
+            if value is sentinel:
+                value = getattr(cls, attr, None)
+            setattr(inst, attr, value)
+        return inst
+
+    # ==== d.py overrides ====
+    async def interaction_check(self, interaction: discord.Interaction) -> bool:
+        if interaction.user.id == self.owner.id:
+            return True
+        await interaction.response.send_message("You are not the owner of this menu.", ephemeral=True)
+        return False
+
+    async def on_timeout(self):
+        if self.message is None:
+            return
+        await self.message.edit(view=None)
+
+    # ==== content ====
+    def get_content(self) -> Mapping:
+        """Return a mapping of kwargs to send when sending the view."""
+        return {}
+
+    # ==== helpers ====
+    async def send_to(self, destination: discord.abc.Messageable, *args, **kwargs):
+        """Sends this menu to a given destination."""
+        message = await destination.send(*args, view=self, **self.get_content(), **kwargs)
+        self.message = message
+        return message
+
+    async def defer_to(self, view_type: Type['MenuBase'], interaction: discord.Interaction):
+        """Defers control to another menu item."""
+        view = view_type.from_menu(self, cancel_other=True)
+        await interaction.response.edit_message(view=view, **view.get_content())
+
+    async def refresh_content(self, interaction: discord.Interaction):
+        """Refresh the interaction's message with the current state of the menu."""
+        await interaction.response.edit_message(view=self, **self.get_content())