Embed Templator

Templator einbetten

Ein Python -Vorlagenmanager für Ihren Discord Bot, um Ihre Einbettungen einfach und konsistent zu halten

Installation

Verwenden Sie den folgenden Befehl, um den Einbetten-Templator in Ihrer Python-Umgebung zu installieren:

pip install Embed-Templator

Hat nicht funktioniert?

Abhängig von Ihrer Python -Installation müssen Sie möglicherweise eines der folgenden verwenden.

PIP ist nicht auf dem Weg, aber Python ist

python -m pip install embed-templator

Python ist nicht auf dem Weg

path/to/python.exe -m pip install embed-templator

Verwenden Sie mehrere Python -Versionen

py -m pip install embed-templator

Verwendung

Einfachste

Der einfachste Weg, den Einbettentemplator in Ihrem Projekt zu verwenden, ist Folgendes:

 from embed_templator import Embed

# Loading your client instance withing the embed templator.
Embed . load ( client )


@ client . command ()
async def ping ( ctx ):
    # Use it like a regular Embed.
    await ctx . send ( embed = Embed ( description = 'pong!' ))

Kontextbetts

Der Embett -Templator kann jedoch eine stärkere Verwendung aufweisen und Kontext -Einbettungen verwenden.

 from embed_templator import Embed

client = ...

# Note that auto_author requires the ctx to be passed at embeds init.
Embed . load ( client , auto_author = True )


@ client . command ()
async def ping ( ctx ):
    # Use it like a regular Embed.
    await ctx . send ( embed = Embed ( ctx )( description = 'pong!' ))

Zahnräder

Wenn Sie ein COG -basiertes System verwenden, vergessen Sie nicht, die Einbetten in Ihre Zahnräder mit Folgendem einzubetten:

 class MyBeautifulCog ( commands . Cog ):

    def __init__ ( self , client ):
        self . client = client
        
        Embed . load ( self . client )

Dann können Sie es wie die vorherigen Beispiele verwenden:

    @ commands . command ()
    async def my ( self , ctx ):

        await ctx . send (
            embed = Embed ( ctx )( description = "Cabbage" )
        )

Erweiterte Verwendung

Wenn Sie eine erweiterte Einbettungskonfiguration wünschen, können Sie eine benutzerdefinierte Einbettungsklasse erstellen, die den Einbetten -Templator erbt.

 from __future__ import annotations
import embed_templator


class Embed ( embed_templator . Embed ):
    
    def setup ( self ) -> Embed :
        return self . set_footer (
            text = f" { self . ctx . command } | more info @ { self . ctx . prefix } help"
        )

---

Sie können auch die "Update" -Methode für letzte Änderungen in der Einbettung verwenden, besser wird sie gesendet.

❗	In diesem Beispiel wird ein benutzerdefiniertes CTX verwendet, das Zeitverfolgung hat!

 from __future__ import annotations
import embed_templator


class Embed ( embed_templator . Embed ):

    def setup ( self ) -> Embed :
        return self . set_author (
            name = f"Requested by { self . ctx . author } " ,
            icon_url = self . ctx . author . avatar_url
        )

    def update ( self ) -> Embed :
        self . set_footer (
            icon_url = self . client . user . avatar_url ,
            text = '   ' . join (
                (
                    f" { self . ctx . time . elapsed () } " ,
                    f"⏳ { self . client . latency } " ,
                    f"? { self . ctx . prefix } help" ,
                )
            )
        )

        return self

---

Danke, dass du ein Einbetten-Templator verwendet hast!

Lizenz

© 2020 copyright Edhyjox

Dieses Repository ist unter der MIT -Lizenz lizenziert. Weitere Informationen finden Sie in Lizenz.