Skip to content

emberglazee/node-autotip

 
 

Repository files navigation

node-autotip

node-autotip v4.7.0

A fork of builder-247's node-autotip project, with updated packages and a refactored code base.

About

node-autotip is command-line based version of the Forge mod Autotip (by Semx11, 2Pi and Sk1er). It is useful for long afk sessions, e.g. overnight. You can even run it on Android with Termux.

Advantage of using node-autotip instead of the official mod is greatly smaller electricity costs, as it doesn't require any game rendering. This is achieved by communicating with the server directly using minecraft's protocol.

node-autotip also fixes the issue of "That player is not online, try another user!", making it more efficient than the original mod.

Getting started

  1. Install Node.js, atleast v18, but >=v22 is recommended;
    • Also tested to be working with Bun, you may chose it over Node.js if you wish.
  2. Clone or download the project;
  3. Run npm install command in the project directory;
  4. Create a credentials.json file following this example;
    • To track when you log into Hypixel and not try to reconnect while you're playing, please set the apiKey, you can get it here: https://developer.hypixel.net/; This way the bot will check your status every 5 minutes and only reconnect once you're offline.
    • OPTIONAL: Create .env file with config values in KEY=VALUE format (see config.js for full listing of options).
      • In order to track karma gain accurately, update the TIP_KARMA value, it is 100 for default rank, 200 for VIP etc. capped at 500 for MVP+.
  5. npm start to start node-autotip;
  6. npm run stats to display node-autotip statistics.

Contributing

We would love to have your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug (make a github issue)
  • Discussing the current state of the code
  • Submitting a fix (fork and pull as explained below)
  • Proposing new features (mention it on github or make a github issue)

Developing

In order to see debugging output, set the NODE_ENV variable to development in your .env file.

About

CLI-based autotip client for Hypixel using mineflayer

Topics

Resources

License

Stars

Watchers

Forks

Languages

  • JavaScript 100.0%