https://github.com/kevinnovak/msl-bumper

Browser automation - Auto-bump your Minecraft server on minecraft-server-list.com.
https://github.com/kevinnovak/msl-bumper

automation browser-automation bump bumper minecraft minecraft-server puppeteer

Last synced: 19 days ago
JSON representation

Browser automation - Auto-bump your Minecraft server on minecraft-server-list.com.

• Host: GitHub
• URL: https://github.com/kevinnovak/msl-bumper
• Owner: KevinNovak
• License: mit
• Created: 2018-04-25T04:07:37.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-09-26T18:54:07.000Z (about 2 years ago)
• Last Synced: 2024-10-11T11:49:20.388Z (about 1 month ago)
• Topics: automation, browser-automation, bump, bumper, minecraft, minecraft-server, puppeteer
• Language: JavaScript
• Homepage:
• Size: 300 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MSL Bumper

Auto-bump your Minecraft server on [minecraft-server-list.com](http://minecraft-server-list.com/).

Running this script will automatically put your server at the top of the [Recently Updated](https://minecraft-server-list.com/updated/) servers list, which will help your server attract more players. Includes a built-in scheduler which can be set on any schedule you'd like.

## Requirements

* Node.js

  * [Install files can be found here](https://nodejs.org/en/download/).

## Getting Started

1. [Download the latest release here](https://github.com/KevinNovak/MSL-Bumper/releases/latest)

    * Click one of the ```Source code``` links to download.

2. Extract the download and navigate to the extracted files.

3. Install the required packages.

    * Run ```npm install```.

4. Modify ```config.json```.

    * See the [Configuration](https://github.com/KevinNovak/MSL-Bumper#configuration) section.

    * ***Important***: Remember to modify at least ```username```, ```password```, and ```serverId```.

5. Start with ```npm start```.

## Running on a Schedule

There are 2 main ways you can run this script on a schedule:

1. Built-in scheduler:

    * Simply run ```npm run scheduler```.

    * The **recommended** and probably easiest method.

    * Commands:

        * View logs with ```pm2 logs msl-bumper```.

        * Restart with ```pm2 restart msl-bumper```.

        * Stop with ```pm2 stop msl-bumper```.

        * Remove with ```pm2 delete msl-bumper```.

2. Custom scheduler:

    * Setup a custom scheduler of your choice to run ```node app.js``` or ```npm start```.

    * Run directly with Node:

        * Windows: [Run a Node script with Windows task scheduler](https://eddyerburgh.me/run-a-node-script-with-windows-task-scheduler)

        * Mac & Linux: [How to Run Node.js Scripts from a Cron Job](https://askmacgyver.com/blog/tutorial/how-to-run-node-scripts-from-a-cron-job)

    * Run from a shell script:

        * Windows: [Execute Bash Script (Using Git Bash) from Windows Task Scheduler](https://gist.github.com/damc-dev/eb5e1aef001eef78c0f4)

        * Mac: [How to Run a Shell Script Every Day on a Mac](https://www.dssw.co.uk/blog/2011-05-22-how-to-run-a-shell-script-every-day-on-a-mac/)

        * Mac & Linux: [Schedule Tasks on Linux Using Crontab](https://kvz.io/blog/2007/07/29/schedule-tasks-on-linux-using-crontab/)

## Configuration

* **account**:

  * **username**:

    * Your **minecraft-server-list.com** username.

  * **password**:

    * Your **minecraft-server-list.com** password.

  * **serverId**:

    * Your **minecraft-server-list.com** server ID.

    * This can be found in the URL of your servers page on **minecraft-server-list.com**.

      * For example, your servers page URL might be ```http://minecraft-server-list.com/server/123456/```.

        * In this example ```"123456"``` is the server ID.

* **bump**:

  * **enabled**:

    * Actually bump the server?

    * If ```false```, will run all actions except the actual bump, useful for testing.

  * **descriptions**:

    * **enabled**:

      * Whether or not to type in a random description for the server.

      * ***Important***: If enabling, remember to modify the list of descriptions. Don't use the default.

    * **list**:

      * A list of possible descriptions to use.

        * You can add as many as you want.

      * If enabled, one will be chosen at random each time the script is run.

* **browser**:

  * **hide**:

    * Should the browser window be hidden?

    * ***NOTE***: Set to ```true``` if running from SSH or a non-GUI OS like Debian or Raspbian Lite.

  * **custom**:

    * **enabled**:

      * Whether or not to use your own custom browser from the provided path.

      * ***NOTE***: Supports most newer versions of Chrome or Chromium.

      * If ```false``` will use the default version of Chromium bundled with this package.

    * **path**:

      * The path to the Chrome or Chromium executable to use (if enabled above).

      * See [this page](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions) for more details.

* **timings**

  * **delays**:

    * **enabled**:

      * Whether or not this script should wait a random amount of time between actions.

      * Recommended to leave enabled.

    * **min**:

      * Minimum time to wait between actions in seconds.

    * **max**:

      * Maximum time to wait between actions in seconds.

  * **typingDelays**:

    * **enabled**:

      * Whether or not to type with delays (rather than instantaneously).

    * **delay**:

      * Time to wait between key presses in milliseconds.

  * **scheduler**:

    * **expression**:

      * Defines when the bump script should be ran using a cron expression.

      * [You can read about cron expressions here](http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/crontrigger.html)

      * [Here are some examples and a cron generator](https://www.freeformatter.com/cron-expression-generator-quartz.html).

      * ***NOTE***: Does not support every format. See [this page](https://github.com/harrisiirak/cron-parser#supported-format) for details.

      * Defaults to every day at 9am, 3pm, and 9pm.

        * With a 0 to 2 hour offset, see ```offset``` below.

    * **offset**:

      * **enabled**:

        * Whether or not to wait a random amount of time after the scheduled time comes.

        * Recommended to leave enabled.

      * **min**:

        * Minimum time to wait after the scheduled time in seconds.

      * **max**:

        * Maximum time to wait after the scheduled time in seconds.

        * ***NOTE***: Should be less than how often the script is running according to the ```cronExpression```.

## Disclaimer

Running automated scripts like this one is often against a websites terms and conditions. Ultimately you are the one responsible for knowing the terms and conditions, and for what you do with this script. Run at your own risk.

## References

* [Puppeteer](https://developers.google.com/web/tools/puppeteer/) by [Google](https://developers.google.com/) - Automate browser tasks in Chrome or Chromium.

* [Node Schedule](https://github.com/node-schedule/node-schedule) by [Tejas Manohar](https://tejas.io/) & [Santiago Gimeno](https://github.com/santigimeno) - Schedule jobs to run with Node.js.