Pomoc do El

Komendy

Komendy to akcje wywoływane przez wysłanie wiadomości zaczynającej się prefiksem.

Składnia

Wiadomość wywołującą komendę można podzielić na dwie części:

prefiks
   _
  / \
  el!info user 368475654662127616
     \__________________________/

            część komendy

Prefiks

Krótki ciąg znaków rozpoczynający wywołanie komendy.

Domyślny prefix to el!.

Część komendy można podzielić na kolejne dwie części:

                 argumenty
              ________________
             /                \
   info user 368475654662127616
   \_______/

ścieżka komendy

Jest ona dzielona na słowa przez spacje. Słowa są jednostką używaną zarówno w ścieżce komendy, jak i w argumentach.

Możesz nieco zmienić sposób dzielenia na słowa przy użyciu specjalnych sekwencji znaków:

• Znaki zamknięte w "" lub '' nie dzielą się na spacjach.
• \ przed:
  • \, ", ' lub spacją sprawi, że znak będzie traktowany dosłownie i nie będzie częścią specjalnej sekwencji.
  • n wstawi nową linię.

Ścieżka komendy

Jedno lub więcej słów wybierających komendę, która zostanie wywołana.

Najprostsza ścieżka to nazwa komendy podstawowej.

Komendy podstawowe to komendy, które są niezależne od innych. Komendę podstawową foo można by było wywołać jako:

foo

Komendy mogą jednak grupować (zawierać) inne komendy. W tym przykładzie komenda podstawowa foo grupuje komendy bar i baz, a baz grupuje test:

    foo
   /   \
 bar   baz
        |
       test

Można to pokazać też w ten sposób:

• foo
  • bar
  • baz
    • test

Wywołanie zgrupowanej komendy polega na podaniu najpierw jej komendy grupującej, a następnie niej samej.

W poprzednim przykładzie, jeśli chciałbyś wywołać bar, musiałbyś najpierw podać foo, a potem bar.

foo bar

Jeśli chciałbyś wywołać test, na początku podałbyś foo, następnie baz i na końcu test:

foo baz test

Argumenty

Dodatkowe opcje, które może przyjmować komenda. Komendy mogą przyjmować zero lub więcej argumentów.

Argumenty:

• Mają wartości

  Wartości to informacje o argumentach przekazywane komendzie.

  Typy wartości:

  • String

    Dowolny tekst, przekazywany tak, jak jest podany.

  • None

    Brak wartości, umożliwia tylko zliczenie wystąpień argumentu.

  Argument ma wartość, jeśli jego wartość nie jest None.

• Są pozycyjne, krótkie lub długie

  Argumenty pozycyjne są podawane jako ich wartości w konkretnej kolejności.

  Przykład:

  11 42 69

  Przekaże trzy pierwsze argumenty pozycyjne z wartościami 11, 42 i 69.

  Argumenty krótkie mogą być podawane w dowolnej kolejności. Zaczynają się od - i są pojedyńczym znakiem.

  Przykład:

  -a -c

  Przekaże a i c.

  Jeśli ma wartość, musi ona być podana jako następne słowo.

  Przykład:

  -a -b wartość

  Przekaże a, oraz b z wartość.

  Krótkie argumenty mogą być grupowane w jedno słowo, ale tylko ostatni w takim układzie może mieć wartość.

  Przykład:

  -ac -db wartość

  Przekaże a, c, d, oraz b z wartość.

  Argumenty długie, podobnie do krótkich, są podawane w dowolnej kolejności. Zaczynają się od -- i są ciągiem znaków.

  Przykład:

  --długi-argument

  Przekaże długi-argument.

  Jeśli ma wartość, musi ona być podana jako następne słowo lub po =.

  Przykład:

  --foo=bar --test wartość

  Przekaże foo z bar, oraz test z wartość.

  ---

  Słowo -- sprawia, że wszystkie argumenty po nim są traktowane jako pozycyjne.

  Przykład:

  --foo=bar -- --to-nie-jest-długi-argument-mimo-że-tak-wygląda

  Przekaże foo z bar, oraz pierwszy argument pozycyjny z --to-nie-jest-długi-argument-mimo-że-tak-wygląda.

• Są opcjonalne lub wymagane

  Możesz podawać opcjonalne argumenty lub tego nie robić, ale musisz podać argumenty wymagane aby komenda zadziałała.

• Mogą mieć wartości domyślne

  Argumenty z wartościami domyślnymi użyją ich, jeśli nie są podane.

• Mogą się powtarzać lub łączyć

  Argument powtarzający może być podany więcej niż raz.

  Przykład:

  -vvv -a wart1 -a wart2

  Przekaże v trzy razy, oraz a dwa razy z wart1 i wart2.

  Argument łączący, podobnie do powtarzającego, może być podany więcej niż raz. Połączy on wszystkie swoje wartości w jedną wartość rozdzieloną spacjami.

  Przykład:

  to jest tekst

  Przekaże pozycyjny argument łączący z to jest tekst.

  Nie-powtarzające, nie-łączące argumenty mogą być podane maksymalnie raz.

Lista komend

Lista wszystkich obecnie dostępnych komend El.

Konwencje

Komendy są pokazane jako lista wypunktowana. Każdy poziom na liście to grupa komend.

Pierwsza linia każdego punktu to składnia komendy:

• komenda - nazwa komendy

• (komenda) - nazwa komendy tylko grupującej

  Komendy tylko grupujące nie mogą być wywoływane, służą tylko do grupowania innych komend.

• [arg] - opcjonalny argument

• arg - wymagany argument

• … - argument jest powtarzający

• <…> - argument jest łączący

• komenda -> inna komenda - alias

  komenda wywołuje inną komendę.

Reszta linii to opis komendy.

Lista

• (info)

  Komendy wyświetlające informacje z Discorda.

  • user [id]

    Podaje informacje o użytkowniku z danym id lub, domyślnie, obecnym użytkowniku.

  • guild

    Podaje informacje o obecnym serwerze.

  • server -> info guild

• ping

  Wysyła Pong!.

• poll tytuł opcja…

  Tworzy ankietę z podanym tytułem i opcjami.

• random od do

  Generuje liczbę całkowitą w zakresie od-do.

  • choice opcja…

    Losowo wybiera jedną z opcji.

  • coin

    Rzuca monetą.

• say tekst<…>

  Wysyła wiadomość z tekstem.

• emotize tekst<…>

  Formatuje tekst za pomocą tzw. “regional indicators”.

• typing [tekst]…

  Formatuje tekst podobnie do komunikatu o pisaniu z Discorda.

Inne funkcje

• Proste ankiety z +poll

  Wysłanie wiadomości zaczynającej się od +poll tworzy prostą ankietę przez dodanie reakcji: 👍, 🤷‍♀️, 👎.

Stara lista

Lista komend dla starej wersji El. Ta funkcjonalność zostanie wkrótce™ przeniesiona do obecnej wersji.

Prefiks dla starej wersji El to el..

• lvl [id]
  • leaderboard [strona]
• weather miejsce
• xkcd komiks