{"id":29014651,"url":"https://github.com/raisess/jorginho-bot","last_synced_at":"2025-07-21T16:32:57.212Z","repository":{"id":40716214,"uuid":"271000047","full_name":"Raisess/jorginho-bot","owner":"Raisess","description":"🤖 - Bot for moderation and live interaction of twitch chat.","archived":false,"fork":false,"pushed_at":"2023-07-08T10:21:12.000Z","size":77,"stargazers_count":8,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-25T20:13:56.335Z","etag":null,"topics":["bot","chat","chatbot","open-source","twitch","twitch-bot"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Raisess.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-09T12:44:51.000Z","updated_at":"2022-05-21T07:01:10.000Z","dependencies_parsed_at":"2023-01-23T13:30:18.247Z","dependency_job_id":null,"html_url":"https://github.com/Raisess/jorginho-bot","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Raisess/jorginho-bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Raisess%2Fjorginho-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Raisess%2Fjorginho-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Raisess%2Fjorginho-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Raisess%2Fjorginho-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Raisess","download_url":"https://codeload.github.com/Raisess/jorginho-bot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Raisess%2Fjorginho-bot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266334501,"owners_count":23912988,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-21T11:47:31.412Z","response_time":64,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","chat","chatbot","open-source","twitch","twitch-bot"],"created_at":"2025-06-25T20:13:53.835Z","updated_at":"2025-07-21T16:32:57.160Z","avatar_url":"https://github.com/Raisess.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🤖 JORGINHOBOT DOCS\n\n## 🔮 Requisitos\n\n* [NodeJS versão LTS](https://nodejs.org/en/download/)\n\n## 💡 Instalando\n\nBaixe o bot no [repositório oficial](https://github.com/Raisess/jorginho-bot).\n\nExtraia os arquivos, entre na pasta do bot e em seguida use o comando:\n\n```shell\n  npm install\n```\n\n**ou** clique duas vezes sobre o arquivo **install.bat**.\n\n## ⚙ Configurando o bot\n\nO bot vem com um arquivo chamado **credencials.template.json** dentro da pasta **src**, você pode deve criar um arquivo chamado **credencials.json** no mesmo diretório baseado no arquivo template.\n\nA estrutura do arquivo de credenciais é esta:\n\n```json\n  {\n    \"USERNAME\": \"\u003cbot-account-username\u003e\",\n    \"PASSWORD\": \"\u003cbot-account-password-token | make this pass token here: https://twitchapps.com/tmi/\u003e\",\n    \"CHANNELS\": [\"...\u003cbot-channels-array\u003e\"],\n    \"STREAMER\": \"\u003cstreamer-account-username\u003e\",\n    \"SOCIALS\": [\"\u003cinstagram-user\u003e\", \"\u003ctwitter-user\u003e\"],\n    \"PREFIX\": \"\u003cbot-prefix-simbol | default: !\u003e\"\n  }\n```\n\n*O USERNAME é o nome da conta do bot que pode ser a sua própira conta se preferir.*\n\n*O PASSWORD do bot é um token que pode ser gerado [aqui](https://twitchapps.com/tmi/).*\n\n*O campo CHANNELS é um array que contém os canais do chat **use o nome do seu perfil na twitch por exemplo**.*\n\n## 🚀 Rodando\n\nPara rodar o bot use o comando:\n\n```shell\n  npm start\n```\n\n**ou** clique duas vezes sobre o arquivo **run.bat**.\n\n## 🕹 Comandos padrão\n\n* !help - Ver a lista de comandos do bot.\n* !hello - Dizer hello!\n* !color \u003c colorname | hex \u003e - Mudar a cor do bot.\n* !colorlist - Ver a lista de cores que o bot pode usar.\n* !dice - Girar um dado de seis lados.\n* **MOD** !ban \u003c username \u003e - Banir um úsuario do chat!\n* **MOD** !clear - Limpar as mensagens do chat!\n* !social - Redes sociais do streamer.\n* !git - Link do github do criador do bot (eu hehe).\n* !jorge - Link para baixar o bot jorginho.\n* !morreu - Aumentar o número de vezes que o streamer morreu no game.\n* !uptime - Tempo da live.\n* !followage - Ver a quanto tempo segue o streamer.\n\n## 🛠 Criando novos comandos\n\nOs comandos do Jorge nada são do que apenas modulos CommomJS, para criar um novo modulo é fácil.\nTodos os comandos do Jorge devem ficar na Pasta **commands**, onde fica o arquivo **list.js** que é o controlador do comandos.\n\nEstrutura de um comando:\n\n```javascript\n  // comando hello.js\n  module.exports = (client, channel, user) =\u003e client.say(\n    channel,\n    `hello @${user.username}!`\n  );\n```\n\nAgora veja como fica a estrutura no modulo **list** do arquivo **list.js**:\n```javascript\n  const hello = require('./hello');\n\n  module.exports = [\n    {\n      cmd: 'hello', // nome do comando | no chat fica: !hello (se o prefixo definido para \"!\")\n      description: 'Dizer hello!', // descrição do comando\n      // função de callback executada pelo comando\n      func: (client, channel, user) =\u003e hello(\n        client,\n        channel,\n        user\n      )\n    }\n  ]\n```\n\nA função de callback do comando recebe **quatro** parâmetros por padrão:\n\n```javascript\n  // ...\n\n  module.exports = [\n    {\n      cmd: '\u003cname\u003e',\n      description: '\u003cdescription\u003e',\n      // função de callback executada pelo comando\n      func: (client, channel, user, message) =\u003e command(\n        client,\n        channel,\n        user,\n        message\n      )\n    }\n  ]\n```\n\nSobre os parâmetros da função de callback:\n\n* client - É o parametro que executa as funções do cliente (bot), ou seja, enviar mensagens (client.say(canal\u003c string \u003e, mensagem\u003c string \u003e)).\n* channel - É a variável que armazena o canal onde o comando foi executado, um exemplo de uso dela é na função **client.say(channel, msg)**, onde ela deve ser o **primeiro parâmetro da função**.\n* user - armazena os dados do usuário que executou o comando, por exemplo **user.username** entrega o nome do usuário.\n* message - armazena a mensagem enviada pelo usuário.\n\n## 🤓 Expressions e Responses\n\nAs **expressions** podem ser qualquer palavra ou frase pré defina que tem uma respota pré definida, chamada de **response**, por exemplo:\n\n```\n  fulano: osh\n  jorginhobot: osh\n  fulano: oi\n  jorginhobot: oi, bom dia\n```\n\nEssas palavras ou frases são definidas nos respectivos arquivos **expressions.json** e **responses.json** que estão na pasta **data**.\n\nEsses dados estão salvos no formato de array, ex:\n\nArquivo expressions.json:\n```json\n  [\n    \"osh\",\n    \"oi\"\n  ]\n```\n\nArquivo responses.json:\n```json\n  [\n    \"osh\",\n    \"oi, bom dia\"\n  ]\n```\n\nOnde as **expressions** devem estar de acordo com as **responses** isso em relação ao indice de busca de um array, o primeiro indice, no exemplo *\"osh\"*, é o mesmo em ambos os arquivos o que significa que quando a palavra *\"osh\"* for dita no chat o bot irá responder também com *\"osh\"*.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraisess%2Fjorginho-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraisess%2Fjorginho-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraisess%2Fjorginho-bot/lists"}