KillovSky / Plugins

Este repositório contém uma coleção de plugins desenvolvidos pela comunidade, destinados a enriquecer projetos de BOTs, como Íris, Ísis, Ceres, Nyx e/ou outros criados por KillovSky.
MIT License
1 stars 1 forks source link

[✔️ FEATURE] -> Documentation #3

Open KillovSky opened 1 month ago

KillovSky commented 1 month ago

Roadmap (Markdown): https://github.com/KillovSky/Plugins/issues/1

Realizar a documentação do uso dessa feature, como produzir sistemas e demais tarefas similares.

KillovSky commented 1 month ago

README.md Base:

### **Descrição:**
*Preencha aqui com uma breve descrição do jogo, incluindo objetivos, mecânicas e quaisquer regras especiais que os jogadores devem conhecer.*

### **Instalação:**
*Forneça um tutorial passo a passo sobre como instalar o jogo, incluindo qualquer configuração necessária, como a extração do arquivo ZIP e onde colocar as pastas ou arquivos.*

### **Desenvolvedor:**
*Mencione seu perfil no GitHub, redes sociais ou qualquer URL relevante que você queira incluir.*

### **Licença:**
*Insira a licença do seu comando, se desejar fazer sublicenciamento. Se preferir, mantenha como MIT para operar sob a licença oficial do projeto (recomendado!).*

### **Requisitos:**
*Liste aqui os requisitos necessários, como programas adicionais, bibliotecas, arquivos ou pastas que precisam ser criadas ou modificadas, e quaisquer dependências que o projeto possa ter.*

### **Tipo:**
*Indique o tipo de função que você criou. As opções incluem:*
- *Functions* (Funções)
- *Commands* (Comandos)
- *Others* (Outros)

### **Créditos:**
*Se você utilizou códigos de outras pessoas, mencione-as aqui e inclua a licença do local de onde você obteve o código.*

### **Notas Adicionais:**
*Qualquer informação extra que possa ser relevante para o usuário, como dicas de jogabilidade, links para tutoriais ou FAQs.*

### **Contato:**
*Informações sobre como os usuários podem entrar em contato com você para suporte ou sugestões, como e-mail ou links para comunidades.*

### **TAGs:**
*Adicione TAGs relevantes para destacar seu comando e facilitar a busca. Use o símbolo `#` antes de cada TAG para garantir um formato universalmente aceitável. Por exemplo:*

> *#Function* *#Game* *#Plugin* *#Command*

*Escolha APENAS TAGs que reflitam a natureza do seu comando e ajudem outros usuários a encontrá-lo com mais facilidade, use `>` no início da linha de TAGs.*
KillovSky commented 1 month ago

Instruct.json Base:

{
  "location": {
    "value": ".",
    "description": "Caminho absoluto ou relativo onde a pasta do comando será inserida. Ex: '.' (Raiz do Projeto)."
  },
  "installed": {
    "value": "none",
    "description": "Caminho absoluto ou relativo onde a pasta do comando estará após instalar. Ex: '/lib/Commands/21'."
  },
  "alias": {
    "value": ["none"],
    "description": "Nomes alternativos para referenciar este comando na lista de comandos disponíveis. Separe múltiplos aliases com vírgulas."
  },
  "install": {
    "description": "Comandos necessários para instalar dependências ou programas requisitados. Utilize &, |, && ou || para múltiplos comandos, conforme o sistema operacional.",
    "value": {
      "help": "Ex Command: 'choco install pacote', 'npm install pacote', etc; Runtime é o programa que executará o 'command', como 'apt', 'choco' ou 'npm'.",
      "windows": {
        "runtime": "none",
        "command": "none"
      },
      "linux": {
        "runtime": "none",
        "command": "none"
      },
      "macos": {
        "runtime": "none",
        "command": "none"
      },
      "other": {
        "runtime": "none",
        "command": "none"
      }
    }
  },
  "configuration": {
    "description": "Comandos a serem executados após a instalação, usados para configurar o ambiente ou software. Utilize &, |, && ou || para múltiplos comandos.",
    "value": {
      "help": "Ex: 'sed -i \"s/#PLACEHOLDER_USERNAME/$(whoami)/g\" settings.json' para substituir um placeholder no arquivo de configuração. 'runtime' é o programa que executará o 'command'.",
      "windows": {
        "runtime": "none",
        "command": "none"
      },
      "linux": {
        "runtime": "none",
        "command": "none"
      },
      "macos": {
        "runtime": "none",
        "command": "none"
      },
      "other": {
        "runtime": "none",
        "command": "none"
      }
    }
  },
  "dependencies": {
    "description": "Lista de bibliotecas ou pacotes necessários para o funcionamento do comando, se houver.",
    "help": "Formato: 'NOME_BIBLIOTECA: URL_DO_DOWNLOAD'. Ex: { 'Ruby': 'https://rubyinstaller.org/download' }",
    "value": {}
  },
  "status": {
    "value": "none",
    "description": "Indica se o projeto está ativo, em desenvolvimento, ou se foi descontinuado; none, active, outdated"
  },
  "platform": {
    "value": "Any",
    "description": "Sistemas operacionais compatíveis com o código, informando onde o comando pode ser executado; Ex: Windows, MacOS, Linux, Termux, Solaris..."
  },
  "notes": {
    "value": "none",
    "description": "Detalhes adicionais que devem ser citados, como guias, vídeos ou outras informações relevantes."
  }
}