Modelos/Templates

Os modelos são usados para personalizar as mensagens que aparecem em raids e anúncios. Desta forma, você pode adicionar alguns dados que não são mostrados por padrão, como o CP máximo ou os tipos de Pokémon, ou você também pode alterar a disposição dos elementos existentes.

Plantillas de texto

Existem dois modelos completamente independentes: o modelo raid, que é alterado com /raidtemplate, e o modelo de anúncio, que é alterado com /announcetemplate. Além disso, as raids podem ter conteúdo após a lista de treinadores, que pode ser definida com /raidfootertemplate.

Colocando esses comandos sem argumentos, o código do modelo atual é exibido. Para alterar um modelo, você pode copiar e colar esse código com as modificações desejadas. Por exemplo:

 /raidtemplate <b>{Pokémon}</b> Raid  {{ em <b>{weekday_day_month}</b> }} às {timewarn_icon_} <b>{raidtime}</b> em {gym_icon} {gym}<br> {{ <em>Disponível de {opentime} a {endtime}</em><br> }} <em>Organizado por</em> {organizer} {_ edited_icon} {_ refloated_icon}

Para retornar ao modelo padrão, você deve colocar um hífen -, conforme a seguir:

/raidtemplate -

⚠️ ⚠️ Está tudo muito confuso? Comece colocando o comando /raidtemplate e olhe para o modelo raid atual. Copie, cole e faça algumas modificações. Aos poucos, experimente coisas novas.

Modelos predefinidos

Além do modelo padrão, existem alguns modelos predefinidos adicionais. Para usá-los, você deve especificar seus nomes em vez de colocar o modelo completo. Por exemplo:

/raidtemplate maxcp
/announcetemplate maxcp

Os modelos predefinidos disponíveis são:

Variáveis

Em qualquer template você encontrará texto entre colchetes {} que são variáveis que mais tarde serão substituídas pelos dados de raids e anúncios. Por exemplo, {gym} é substituído pelo nome do ginásio, com um link se a localização for conhecida.

Esta lista indica todas as variáveis disponíveis. Alguns já são usados no modelo padrão ou em um dos modelos predefinidos, mas outros não. Para maior clareza, os colchetes {} não aparecem na lista.

Formato com HTML

Os modelos podem ser formatados com HTML simples, com as restrições usuais do Telegram:

• As etiquetas válidas são <i></i> (itálico), <b></b>(negrito), <u></u>(sublinhado), <s></s>(riscado), <code></code>(texto de largura fixa) e <a href=""></a>(link).
• Se você quiser que os caracteres <, > e & sejam vistos, as entidades <, > e & devem ser usadas.
• Você pode colocar, por exemplo, texto em negrito e sublinhado ao mesmo tempo, utilizando os rótulos corretamente. <u><b>certo</b></u> está correto, mas <u><b>errado</u></b> é errado e não funcionará.
• As quebras de linha devem ser indicadas com <br>. Você pode separar os elementos colocando vários em uma linha, por exemplo <br><br>.

Lembre-se de que você está especificando o código para o modelo e o formato que você aplicar diretamente será ignorado. Ou seja, se você deseja que algo seja mostrado em negrito, deverá colocar <b>desta forma</b>, mas não deverá utilizar a opção negrito integrada no Telegram.

Variantes de variáveis

Para ajudar a construir mensagens melhores, existem versões das variáveis com espaços no início, com espaços no final, em letras maiúsculas … Estas são as variantes disponíveis:

• {VARIABLE}: contém {variable} em maiúsculas.
• {Variable}: contém {variable} forçando a primeira letra maiúscula.
• {_variable}: Contém {variable} com um espaço à esquerda.
• {variable_}: contém {variable} com um espaço no final.
• {_variable_}: contém {variable} com um espaço no início e no final.

Variantes de variáveis com links

Variáveis que colocam Link na coluna HTML contêm links. Ou seja, {pokemon_gameinfo} será exibido como o nome do Pokémon com um link para Gameinfo.

Este tipo de variável pode ser decomposto para exibir independentemente apenas o texto, adicionando _text no final, ou apenas a URL, adicionando _link no final.

Por exemplo, a variável {pokemon_gameinfo_text} conterá o texto com o nome do Pokémon e {pokemon_gameinfo_link} conterá a URL.

Blocos condicionais

Existem dois tipos de blocos condicionais, que permitem mostrar ou ocultar partes dos modelos, dependendo da situação.

Bloco condicional simples

Este bloco condicional mais simples é simplesmente escrito assim: ` {{texto {variables} e mais texto}}`.

Neste caso, o conteúdo entre colchetes será mostrado apenas se todas as variáveis ​​usadas dentro forem definidas ou verdadeiras.

Existem vários exemplos deste tipo de bloco no modelo padrão, onde apenas uma parte do texto é exibida se a variável weekday_day_month for definida e outra se opentime e endtime forem definidas.

Bloco condicional com condições

O outro tipo de bloco condicional permite que você use condições complexas e é escrito assim: [condiciones]{{texto {variables} e mais texto}}.

Nesse caso, o conteúdo entre colchetes será exibido apenas se as condições definidas entre [] forem verdadeiras. Não importa se as variáveis ​​dentro das chaves {{}} são indefinidas ou falsas, o conteúdo ainda é exibido.

As condições podem ser simplesmente variáveis ​​como opentime ou isegg. Eles também podem recusar, colocando um ! Na frente dele. Por exemplo:

[opentime]{{<em>Abre entre {opentime} e {endtime}</em><br>}}
[!isegg]{{🐒 Raid de <b>{pokemon_kingcasualbot} ({maxcp}/{maxcp_boosted})}}

Dentro das condições, você pode usar comparadores matemáticos comuns: menor que <, maior que >, igual a ==, diferente de !=, Menor ou igual a <= e maior ou igual a >=. Eles podem ser usados ​​para comparar valores de variáveis ​​com valores arbitrários, por exemplo:

[opentime>20:00]{{🌚 Cuidado, raid noturna!}}
[minutestoend<5]{{⛔️ Falta pouco tempo para fazer a raid, coloque um pouco mais cedo!!}}
[tier==ex]{{🎟' Lembre-se que você precisa de um passe especial para poder fazer a raid, não se inscreva se você não tiver!}}

Você também pode usar as conjunções lógicas: and && e or ||. Desta forma, várias condições podem ser unidas para tornar uma mais complexa, por exemplo:

[isegg && minutesfromstart<10]{{<em>🥚🚫 Vários Pokémon podem ser lançados e você definiu a hora muito próxima da hora de chocar. Se puder, altere a hora para um pouco mais tarde.}}
[raidispending && trainerscount_remote > 5]{{⛔️💌 <u>Proíbido convidar qualquer pessoa que não esteja registrada!</u> }}

No caso de usar mais de duas condições e misturar && e ||, observe que elas são sempre avaliadas da esquerda para a direita e esta ordem de avaliação não pode ser alterada.

Variáveis ​​específicas para usar em blocos condicionais

Todas as variáveis descritas na tabela acima podem ser usadas como condições. Caso tenham um valor definido, a condição será verdadeira. Caso não tenham valor definido, a condição será falsa.

Além disso, existem algumas variáveis especialmente indicadas para uso como condições, que não imprimem nada mesmo que sejam verdadeiras:

Modelos de imagem

Os modelos de imagem permitem que você adicione imagens às raids, que podem ser personalizadas com informações de cada raid. Eles são desativados por padrão. Para ativá-los ou alterá-los para outros, use o comando /imagetemplate. Por exemplo, para usar o modelo default:

/imagetemplate default

Para ver os modelos disponíveis ou baixar o modelo atual, use /imagetemplate sem parâmetros. Para parar de usar modelos de imagem, use o parâmetro -, que é:

/imagetemplate -

Os modelos de imagem também podem ser personalizados. Eles são arquivos SVG com um tamanho entre 600x300 pixels e 600x400 pixels. Dentro, eles contêm elementos de texto e imagem que são interpretados e substituídos pelo bot com os dados reais de raid ou anúncio. Recomenda-se usar o Inkscape para edição (requer um computador Linux, Windows ou Mac).

Para começar a usar um template customizado, envie o arquivo SVG do template para o grupo, colocando /imagetemplate na descrição.

Você pode iniciar um modelo do zero, mas a coisa mais fácil é começar pegando um modelo existente e modificando-o. Com o comando /imagetemplate você pode baixar o modelo de imagem atual e fazer modificações para usá-lo posteriormente como um modelo personalizado.

Se você abrir um modelo, as imagens vinculadas serão exibidas com um erro, pois o arquivo referenciado não existe (leia a seção sobre imagens abaixo). Para evitar isso, você pode baixar este pacote de imagens e descompactá-lo no mesmo diretório onde você tem o modelo, o que facilitará a edição ao ter uma ideia melhor de como as imagens olhe enquanto edita.

Para interpretar os elementos do template, são utilizadas as propriedades id, class e algumas propriedades que começam com data-, específicas para cada caso. Para visualizar e editar essas propriedades, você precisa ativar o editor Inkscape XML. Habilite-o no menu Edit »_ XML Viewer …_.

Substituições em elementos de texto

Os elementos de texto podem ser interpretados como se fossem modelos de texto normais. Você não pode usar condicionais de qualquer tipo. Para que um elemento de texto seja interpretado, ele deve ter um class chamada parsetext.

Observe que o HTML não pode ser usado em imagens, portanto, as variáveis ​​que contêm links exibirão o código HTML. Por exemplo, a variável {gym}. Para evitar que o HTML seja exibido, você pode usar a variante somente texto, ou seja, {gym_text}.

Condicionales

Elementos inteiros podem ser mostrados e ocultados usando condicionais. Para que as condicionais de um elemento sejam interpretadas, ele deve ter uma classe chamada parsconditions.

As condições devem ser definidas como o valor de um atributo chamado condições de dados. Todas as condições descritas na seção de modelos de texto podem ser usadas, como isegg && minutestoend <10.

Imagens

Em um arquivo SVG, você pode incorporar (embed) imagens ou vincular (link) imagens externas. Se você arrastar um arquivo de imagem para o Inkscape, deve informar qual dos dois deseja fazer. Se você quiser incluir sua própria imagem (por exemplo, uma imagem de fundo ou o logotipo do grupo), você vai querer incorporá-la. Pelo contrário, se quiser que a imagem seja substituída por uma das disponíveis no bot, você deve vinculá-la.

O bot pode substituir imagens vinculadas para mostrar Pokémon, tipos de Pokémon e algumas outras coisas. Para especificar qual imagem você deseja substituir, você deve especificar o identificador correto no atributo id, de acordo com a seguinte tabela:

Se uma imagem vinculada for definida com um desses id e a imagem não existir, ela será automaticamente ocultada. Por exemplo, se o Pokémon tem apenas um tipo, mas as imagens que se referem ao segundo tipo são usadas. Imagens vinculadas que não possuem nenhum desses ids serão ignoradas e mostrarão erros no modelo.

Posição e tamanho do texto

Os elementos de texto podem ser reposicionados verticalmente ou redimensionados com base no comprimento do texto, para ajudar a acomodar o texto nos modelos. É complicado acomodar texto de comprimento variável e, usando essas técnicas, é difícil obter resultados perfeitos ao usar fontes de largura variável, mas com um pouco de tentativa e erro você pode obter bons resultados.

Para alterar o tamanho da fonte com base no comprimento do texto, o elemento deve ter uma class chamada resizetext. Você pode especificar o comprimento de qual redimensionar, colocando o comprimento como o valor de um atributo chamado data-resizetext-length e o tamanho desejado em data-resizetext-size. O tamanho deve ser especificado em unidades e será aplicado na propriedade CSS font-size. Por exemplo:

class: resizetext
data-resizetext-length: 30
data-resizetext-size: 8px

Para alterar a posição vertical do texto com base em seu comprimento, o elemento deve ter uma class chamada movetext. Você pode especificar o comprimento do qual o texto deve ser reposicionado, colocando o comprimento como o valor de um atributo chamado data-movetext-length e o tamanho desejado em data-movetext-distance. A distância deve ser especificada sem unidades e será aplicada como o atributo y do elemento. Por exemplo:

class: movetext
data-movetext-length: 25
data-movetext-distance: -5

Imagens de ginásio

Para que as imagens de ginásios funcionem, o grupo precisa ter uma planilha definida e os ginásios carregadas. Feito isso, deve-se obter as imagens e enviá-las para o grupo dentro de um arquivo ZIP, colocando o comando /gymimages no comentário.

As imagens devem estar no formato JPEG e devem ser nomeadas conforme o nome do ginásio (primeira coluna) consta na planilha, com a extensão .jpg ou .jpeg ao final. Além disso, cada imagem não pode exceder 300 KB de tamanho e o arquivo ZIP não pode exceder 5 MB. O arquivo ZIP não deve conter subdiretórios: as imagens devem estar todas no diretório principal. Um máximo de 300 arquivos são processados, portanto, se você tiver mais ginásios em seu grupo, terá que se limitar a 300 delas.

As imagens recebidas só serão aceitas se houver um ginásio pré-carregado com esse nome. Depois de aceitos, eles são redimensionados e cortados em um quadrado de 250x250 pixels centralizado, independentemente do formato da imagem original.

Se você quiser fazer upload de mais imagens posteriormente, terá que reenviar todas, pois, cada vez que um novo arquivo ZIP é recebido, todos os anteriores são excluídos primeiro.

Limitações

Ao contrário dos modelos de texto, os modelos de imagem não são atualizados toda vez que a mensagem é atualizada, eles só são atualizados quando os dados básicos da raid mudam, como: o Pokémon, tempo, ginásio, etc. É por isso que variáveis ​​e condicionais que se referem ao número de treinadores cadastrados não devem ser usados ​​no template de imagem, uma vez que a imagem não será atualizada adequadamente.

As fontes que podem ser usadas são todas incluídas nesta coleção de fontes do Google. Se você usar fontes não suportadas, elas parecerão incorretas. Para resolver isso, você pode converter esses textos em paths. Isso não pode ser feito se você quiser que as variáveis ​​sejam interpretadas dentro do texto, pois ao convertê-las para paths elas param de se comportar como textos.

IDs de elemento não podem ser repetidos, portanto, ao usar o atributo id para especificar o tipo de imagem, você não pode colocar a mesma imagem vinculada duas vezes no mesmo modelo. Para corrigir isso, você pode adicionar barras baixas _ no final e o bot vai entender de qualquer maneira. Ou seja, pokemon_img_ e pokemon_img__ funcionam da mesma forma que pokemon_img.

As mensagens de imagem demoram mais para serem geradas e, dependendo da carga do servidor, isso pode causar problemas. Você deve tentar usar os modelos o mais simples possível e, se incorporar imagens, compactá-los para um tamanho adequado primeiro. Os modelos com mais de 400 itens ou 2 MB são rejeitados automaticamente.

As mensagens gráficas no Telegram têm no máximo 1024 caracteres, enquanto as mensagens normais têm no máximo 4096 caracteres. Com modelos de texto não excessivos e um máximo de 20 treinadores marcados por raid, não deve haver nenhum problema, mas se você não limitar o número de treinadores em seu grupo ou colocar textos muito longos nos modelos, você pode atingir esse limite e a pesquisa raid irá parar de funcionar. Você pode copiar e colar o texto de uma raid com muitos treinadores marcados em uma ferramenta como o charactercountonline.com para ver o número de caracteres que você costuma usar. Lembre-se de que, se você colocar informações na imagem, normalmente não deseja que sejam duplicadas no texto também, portanto, você pode remover informações duplicadas de modelos de texto para salvar caracteres.

Teste os modelos

Para tornar o desenvolvimento de modelos mais fácil, você pode enviar os arquivos SVG dos modelos junto com a descrição /testimagetemplate para testá-los de forma privada (não em um grupo). O bot renderizará o modelo em várias situações diferentes para que você possa verificar sua aparência e corrigir erros.