% Granota

Granota é o bot de IRC do canal ```##transit```. Tem várias funcionalidades, desde pequenos brinquedos (```.hug```, ```.cake```)
a comandos úteis e educativos (```.transit```, ```.wiki```).

# Permissões de Utilização

Granota possui quatro tipos de utilizadores: donx, administradorxs, operadorxs e utilizadores normais.
Por razões técnicas, apenas a pessoa que possui estatuto de donx pode ter acesso a todas as funcionalidades
do bot. De momemnto a pessoa que retém esta posição é NeoNamo.

Xs administradorxs podem controlar quase todas as funcionalidades do bot.
De momento há 2 administradorxs: leah (e todos os nomes de utilizador de IRC associados)
e polemic. O único comando que não lhes é autorizado é o comando ```.quit```.
Podem, no entanto, fazer o bot sair do canal. Administradorxs do Transit
tem que ter uma conta NickServ com um cloak (para esconder informação como
endereço IP).

Xs operadorxs do canal de IRC podem controlar todas as funções relacionadas
com administração (banir, remover utlizadores, etc...). No entanto, estes
comandos apenas funcionam se o bot também for operador. Este não é atualmente
o caso, por isso todos estes comandos estão desativados, de momento.

Por fim, todxs xs utilizadorxs podem usar os comandos restantes,

# Comandos
O prefixo do Granota é um ponto (```.```). Isto significa que todos os comandos
devem ser escritos com um ponto à frente. Para ver a lista de comandos, escreva ```.commands```
e o bot irá enviar-lhe a lista completa numa mensagem privada.

Para ver a documentação em relação a um comando, escreva ```.help <comando>```,
substituindo ```<comando>``` pelo comando com o qual você precisa de ajuda.

Todos os comandos normais podem ser usados tanto num canal público como numa mensagem
privada. Comandos de administração, no entanto, têm que ser utilizados numa
mensagem privada.


# Contribuir

O bot está licensiado sob a Eiffel Forum License version 2, disponível no
repositório [transit/Granota](https://notabug.org/transit/Granota). Todas
as contribuições são bem-vindas, quer sejam através de um pull request ou
como através de relatos de erros (bugs), no registo de problemas a resolver
(issue tracker).

Se você está a escrever um módulo novo que pode potencialmente a privacidade
de outrxs utilizadorxs, por favor peça autorização para o fazer.

# Privacidade
**Por razões de manutenção, todas as mensagens enviadas ao bot e aos canais onde
o bot está ligado são registadas num ficheiro de texto não encriptado.
Este ficheiro não será partilhado publicamente, no entanto NeoNamo e
a pessoa dona do servidor podem lê-lo.Por favor evite enviar informação
privada ao bot.**

**Todos os perfis gerados com os comandos ```.addifo``` e ```.profile``` 
são registados num ficheiro de texto não encriptado. Este ficheiro não será
partilhado publicamente, no entanto NeoNamo e a pessoa dona do servidor podem lê-lo.
Por razões de privacidade, estes comandos podem ser usados apenas nos
canais do ```##transit```. Recomendamos vivamente que use o comando
```.addifo``` a partir de uma conta registada e segura do NickServ para evitar
impostorxs.**
