https://github.com/cliffano/mineflayer-chatgpt

Mineflayer plugin for sending message to OpenAI's ChatGPT
https://github.com/cliffano/mineflayer-chatgpt

chatgpt minecraft mineflayer nodejs

Last synced: about 1 month ago
JSON representation

Mineflayer plugin for sending message to OpenAI's ChatGPT

• Host: GitHub
• URL: https://github.com/cliffano/mineflayer-chatgpt
• Owner: cliffano
• License: mit
• Created: 2023-02-10T02:54:57.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-08T22:59:54.000Z (2 months ago)
• Last Synced: 2024-11-19T01:53:46.966Z (about 2 months ago)
• Topics: chatgpt, minecraft, mineflayer, nodejs
• Language: JavaScript
• Homepage:
• Size: 9.77 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Build Status](https://github.com/cliffano/mineflayer-chatgpt/workflows/CI/badge.svg)](https://github.com/cliffano/mineflayer-chatgpt/actions?query=workflow%3ACI)

[![Security Status](https://snyk.io/test/github/cliffano/mineflayer-chatgpt/badge.svg)](https://snyk.io/test/github/cliffano/mineflayer-chatgpt)

[![Dependencies Status](https://img.shields.io/librariesio/release/npm/mineflayer-chatgpt)](https://libraries.io/github/cliffano/mineflayer-chatgpt)

[![Coverage Status](https://img.shields.io/coveralls/cliffano/mineflayer-chatgpt.svg)](https://coveralls.io/r/cliffano/mineflayer-chatgpt?branch=master)

[![Published Version](https://img.shields.io/npm/v/mineflayer-chatgpt.svg)](http://www.npmjs.com/package/mineflayer-chatgpt)




Mineflayer ChatGPT

------------------

Mineflayer ChatGPT is a [Mineflayer](https://github.com/PrismarineJS/mineflayer) plugin for sending messages to OpenAI's [ChatGPT](https://chat.openai.com/).

Installation

------------

    npm install mineflayer-chatgpt

or as a dependency in package.json file:

    "dependencies": {

      "mineflayer-chatgpt": "x.y.z"

    }

Usage

-----

Load the plugin:

    import mineflayerChatgpt from 'mineflayer-chatgpt';

    ...

    bot.loadPlugin(mineflayerChatgpt.chatgpt);

Set the configuration:

    const chatGptApiKey = 'sk-1234567890abcdef';

    bot.chatgpt.setConfig(chatGptApiKey, {

      model: 'gpt-3.5-turbo'

    });

Send a message to ChatGPT:

    bot.chatgpt.sendMessage('player', 'How to craft a diamond sword in Minecraft?');

Colophon

--------

[Developer's Guide](https://cliffano.github.io/developers_guide.html#nodejs)

Build reports:

* [Code complexity report](https://cliffano.github.io/mineflayer-chatgpt/complexity/plato/index.html)

* [Unit tests report](https://cliffano.github.io/mineflayer-chatgpt/test/mocha.txt)

* [Test coverage report](https://cliffano.github.io/mineflayer-chatgpt/coverage/c8/index.html)

* [Integration tests report](https://cliffano.github.io/mineflayer-chatgpt/test-integration/cmdt.txt)

* [API Documentation](https://cliffano.github.io/mineflayer-chatgpt/doc/jsdoc/index.html)