Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 2.22 KB

README.md

File metadata and controls

40 lines (26 loc) · 2.22 KB
Raw

node-autotip

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.

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
  2. Clone or download the project
  3. Run npm install command in the project directory
  4. Create a credentials.json file following this example
    • 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

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.

Code style

We use the airbnb style on node-autotip.

Run npm run lint to automatically fix the style, or use npm run lintnofix to see a list of inconsistencies.