Embed Templator

Embed Templator

Manajer Template Python untuk Bot Perselisihan Anda untuk Menjaga Embed Anda Sederhana & Konsisten

Instalasi

Gunakan perintah berikut untuk menginstal embed-templator ke lingkungan Python Anda:

pip install Embed-Templator

tidak berhasil?

Bergantung pada instalasi Python Anda, Anda mungkin perlu menggunakan salah satu dari yang berikut.

Pip tidak ada di jalan setapak tapi python

python -m pip install embed-templator

Python tidak ada di jalan

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

Menggunakan beberapa versi Python

py -m pip install embed-templator

Penggunaan

Paling sederhana

Cara paling sederhana untuk menggunakan templator embed dalam proyek Anda adalah sebagai berikut:

 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!' ))

Konteks Embeds

Namun, templator embed dapat memiliki penggunaan yang lebih maju, dan menggunakan embed konteks.

 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!' ))

Roda gigi

Jika Anda menggunakan sistem berbasis COG, jangan lupa untuk memasukkan embed dalam roda gigi Anda dengan yang berikut:

 class MyBeautifulCog ( commands . Cog ):

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

Maka Anda akan dapat menggunakannya seperti contoh sebelumnya:

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

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

Penggunaan lanjutan

Jika Anda menginginkan konfigurasi embed canggih, Anda dapat membuat kelas embed khusus yang akan mewarisi templator embed.

 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"
        )

---

Anda juga dapat menggunakan metode `update` untuk perubahan terakhir dalam embed, lebih baik akan dikirim.

❗	Contoh ini menggunakan CTX khusus yang memiliki pelacakan waktu!

 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

---

Terima kasih telah menggunakan embed-templator!

Lisensi

© 2020 copyright Edhyjox

Repositori ini dilisensikan di bawah lisensi MIT. Lihat lisensi untuk detailnya.