sum117 / moniqueta-discord

Moniqueta is a QOL and Roleplaying application made with discord.js with a website integration written in react.

❤️ Moniqueta (X-Platform Roleplaying Tool)

📖 Sumário

---

• 🫶 Contribuidores
• ⚠️ Requerimentos
  • 🤖 Bot
  • 🌐 Web App
• 🚀 Começando
  • ⚙️ Configuração
    • Usando config.json
    • Usando Variáveis de Ambiente (Recomendado)
      • Windows
      • Linux (Feito em Ubuntu)
• 📝 Recursos e Comandos
• 🤝 Contribuindo
• 🚩Em breve

🫶 Contribuidores

---

⚠️ Requerimentos

---

🤖 Bot

1. Token de Bot do Discord
   • Guia
2. Node.js 16+
3. Se estiver utilizando Windows, você deve instalar o Visual Studio Build Tools com a extensão para C++ (Por conta do banco de dados padrão da Moniqueta).

🌐 Web App

1. Vite Framework para React - Guia

🚀 Começando

---

Para começar a desenvolver a moniqueta, é relativamente simples:

⚠️ Importante: Se você estiver usando Windows para instalar a Moniqueta com o banco de dados padrão é possível que você tenha que fazer algumas configurações adicionais .

git clone https://github.com/sum117/Moniqueta-Discord.js
cd Moniqueta-Discord.js
npm install

Após a instalação, você pode tentar rodar o bot com o comando npm run moniqueta ou npm run devMoniqueta para atualização automática.

⚙️ Configuração

Usando config.json

Crie um arquivo config.json e preencha os valores respectivos:

⚠️ Nunca dê commit no seu token de bot do Discord, adicione o config.json ao arquivo .gitignore do seu projeto!

{
  "TOKEN": "",
  "PREFIX": ""
}

Usando Variáveis de Ambiente (Recomendado)

Windows

1. Pressione + R
2. Copie e cole, ou digite: Variáveis de Ambiente no campo de pesquisa.
3. Pressione ENTER
4. Clique no botão Variáveis do Ambiente:
   
5. Clique no botão Novo, em Variáveis do Ambiente para o usuário:
   
6. Em Nome da Variável coloque TOKEN, e no valor, o seu BOT TOKEN do Discord.
7. Finalmente, faça o mesmo para o PREFIX, salve e reinicie o computador. A moniqueta já conseguirá ler seu Token!

Linux (Feito em Ubuntu)

1. No seu terminal linux, use o comando:

   echo 'export TOKEN="seu bot token"' >> ~/.profile
   echo 'export PREFIX="um prefixo qualquer"' >> ~/.profile
   cd $HOME/Moniqueta-Discord.js
   npm run moniqueta

2. Pronto, deve funcionar!

📝 Recursos e Comandos

---

No momento a Moniqueta está em desenvolvimento, e possui os seguintes comandos:

⚠️ Nota: O prefixo padrão é $, e Moniqueta tem alguns Comandos de Slash já prontos.

• ⌨️ Use as ferramentas do playcard!

  Considerando que você já criou um personagem

  /playcard send Olá! Envia uma mensagem com o cartão de encenação.

  /playcard edit Na verdade, quis dizer Olá! Edita a última mensagem enviada pelo usuário.

  /playcard remove Deleta a última mensagem enviada pelo usuário.

  /playcard remove <link de mensagem do Discord> Remove uma mensagem especificada com link caso ela pertença ao usuário.

• 📋 Copie e cole mensagens e todos os seus conteúdos com links!

  $copy <link de mensagem do Discord>

• ✂️ Corte imagens e as transforme em ícones com bordas estilo Discord!

  $icone <cor em hex> <url da imagem com extensão no final>

  Exemplo: $icone #0001 https://i.imgur.com/8WX8dkZ.jpeg

• ☢️ Apague as últimas 100 mensagens do canal com uma bomba nuclear com música e tudo!

  $nuclear

  nuclear.mp4

• 🪨✂️🧻 Jogue Pedra, Papel e Tesoura com a Moniqueta ou com seus amigos!

  $rps <menção do usuário>

🤝 Contribuindo

1. Faça um Fork da Moniqueta
2. Depois, clone-o: git clone https://github.com/seuUsuarioGit/Moniqueta-Discord.js.git
3. Crie a branch da sua feature: git checkout -b minha-feature
4. Adicione as suas mudanças git add .
5. Adicione suas mudanças: git commit -m "Sua mensagem"
6. Faça o push para sua branch: git push origin minha-feature
7. Depois, termine com um Pull Request dentro do repositório da Moniqueta

🚩Em breve

1. Aplicação Standalone React

moniqueta-discord's Issues

Adicionar opção de excluir playcards na classe `PlayCardBase.js` e adicioná-lo ao comando `slash.playcard.js`

Clique nos links abaixo para acessar os arquivos que precisam ser editados:

• Classe
• Comando Slash

Produzir Markdown do repositório

Linkar o projeto front com o github pages pra que ele possa ser acessado através de um domínio personalizado.

Adicionar opção de listar todos os playcards na classe `PlayCardBase.js` e usá-la no comando `slash.playcard.js`

Clique nos links abaixo para acessar os arquivos que precisam ser editados:

• Classe
• Comando Slash

Produzir Figma do projeto para que o Front comece a trabalhar.

Criar uma seção para comandos musicais na moniqueta.

Escritor de `config.json` para a guilda exclusiva do desenvolvedor.

A ideia é ter um config.json padrão para o usuário poder codificar, que será criado e adicionado ao .gitignore. Nós iremos usar isso ao invés de banco de dados nesta release em prol do aprendizado do colaborador @K4L1B3 .

Operações

⚠️ Esta seção indica tudo o que o bot precisa fazer para concluir o que foi proposto.

Primeira Milestone

🔦 O objetivo da primeira Milestone é fazer o bot reconhecer a existência dos objetos CATEGORIES e CHANNELS do JSON.

1. Checar se um arquivo config.json já existe, caso não, crie-o
2. Adicionar checagem para as propriedades TOKEN e PREFIX para que não haja interferência entre elas e as variáveis de ambiente (Isso é importante, pois se o usuário decidiu ativar a moniqueta através das variáveis de ambiente, criar um config.json utilizando o handler de credenciais atual gerará um bug de objeto nulo)
3. Checar a existencia de CHANNELS e CATEGORIES. Caso já existam, adicionar os hipotéticos novos valores, se não, crie-as dentro do arquivo.
4. Finalmente, exporte os objetos JSON CHANNELS, CATEGORIES, TOKEN E PREFIX para que possam ser usados no resto do projeto.

Eis um exemplo prático para você começar:
⚠️O exemplo não inclui nenhum tipo de checagem, e só exporta o que encontrar dentro de um arquivo pré-existente. Considere isso como uma template. Antes de tudo, também note que nenhum arquivo está sendo criado caso ele não exista, o que retornaria um erro, e é uma feature solicitada neste issue.

export const { TOKEN, PREFIX, CHANNELS, CATEGORIES } = await import(
  './config.json',
  { assert: { type: 'json' } }
).then((config) => {
  const objeto = {};
  for (propriedade of config.default) objeto[propriedade] = config.default[propriedade]
  return objeto;
});

Isso é relativamente fácil de fazer. Estou considerando este ISSUE como uma atividade de aprendizado para o nosso colaborador, cujo para qual estou servindo de tutor no momento.

Boa sorte, Luiz!

Fazer um comando Eval