A high-level package for easily creating bots for the Minecraft network GrieferGames.net.
Built upon mineflayer.
Important: I've reneamed the library from griefergames to griefergames-bot. If you previously installed it from GitHub you have to reinstall it under this new name and update your imports.
- Supports Promises/Async-Await
- Expressive API (type definitions)
- Easily connect on every "CityBuild" server using a single method
- Optimized chat queue - adapts to chat mode and other factors
- Session caching and refreshing
- Fake money filtering
- Useful events - react to private messages, money transfers etc.
- Make use of the complete feature set of Mineflayer - this package only adds functionality
npm install griefergames-bot
# or the latest beta from gitHub
npm install https://github.com/Neocraftr/griefergames-bot.gitImporting the package:
const gg = require('griefergames-bot');
// or (using destructuring)
const { createBot } = require('griefergames-bot');
// or (using ES6 import)
import { createBot } from 'griefergames-bot';Creating a bot:
const bot = createBot({
// Authentication with Mojang account
username: '[email protected]',
password: 'password',
// or Microsoft account
username: '[email protected]',
password: 'password',
auth: 'microsoft',
// or MCLeaks.net
password: 'token',
auth: 'mcleaks',
logMessages: true
});
// This is async (returns a promise)
// We will ignore that for demonstration purposes.
bot.init();
bot.on('ready', () => {
// You should wait for the 'ready' event
// for most actions.
console.log('Bot is now ready for use!');
// For example, now would be a good time
// to connect on our chosen "CityBuild" server.
bot
.connectCityBuild('cb2')
.then(() => {
console.log('Connected on CityBuild 2!');
// Do things on the server...
})
.catch(e => {
console.error(e);
});
});You could get banned by using this bot.
You will probably have some questions at some point of using this package.
The type definitions give away most of the functionality of the package. You can check these manually, or, if you are using an IDE with code suggestion functionality, such as IntelliSense, it will also list all available methods for you. If you end up stuck though, don't hesitate to open a new issue directly on GitHub!