Description

NOTE: This software is no longer maintained actively and may contain bugs moving forward, if you are interested in maintaining this project you can contact me on Discord @Reheight

NOTE: Force wipe will always occur at 2 PM EST on the first Thursday of every month. It will use the Cron (0 14 * * 4#1) which is the First Thursday of every month at 14:000 (2 PM) and it operates on EST. Note this will not affect your own Wipe Schedules, as they can have their own Timezones.

IMPORTANT: You will need to have NPM and Node.js installed on the server/device you will be running this script on. Install instructions normally vary depending on your operating system but normally information can be found on Node.js (nodejs.org) you will need specifically version 16+

SETUP

You are going to need to run npm install in the root directory of the software to install the required dependencies. Once you finally setup the configuration, you can then run npm run start to start the application. There are files inside to do this for you though.

INFORMATION

Pterodactyl Autowipe allows you to keep your servers up to date with maps and/or random procedural maps. You can support multiple servers on multiple wipe cycles and so on.

All you have to do is install the required packages by running “npm install” in command prompt when in the directory for the utility.

You then will run “npm run start” in command prompt or whichever command execution prompt you use.

The file contains an array of “INSTANCES” which are used to define different instances of servers that will be wiped on different schedules.

Each instance contains information on the Pterodactyl panel being used, the API key needed to access it, and the server IDs of the servers that will be wiped.

The “EXTRAS” field will contain another field called “IGNORE_WIPE_WHEN_DAYS_WITHIN_FORCE” which will cancel any wipes within x amount of days from last/next force wipe. This will allow you to prevent a wipe on the following Friday for example which would just end up being a 1 day wipe.

The “WIPES” field within the instance is an array of wipe schedules. Each schedule is defined by a “CRON” field which specifies the schedule using the standard cron format, a “BLUEPRINTS” field that specify if the blueprints should be wiped or not and a “MAP” field that contains information on how the map should be wiped, if enabled with the following subfields:

• ENABLED: a boolean field that specify if the map should be wiped or not.
• MODE: a string that specify the mode of wipe, it can be “procedural” or “custom”
• PROCEDURAL: an object that contain fields that applies only if the mode is “procedural”
• RANDOMSEED: a boolean field that specify if the map should be wiped with a random seed or not.
• SEED: a string that contain the seed of the map to be wipe, if RANDOMSEED is false.
• SIZE: a number that contain the size of the map to be wipe.
• CUSTOM: an object that contain fields that applies only if the mode is “custom”
• TIMEZONE: the time zone you wish to operate on.
• URL_LIST: an array of strings that contain the URLs of the custom maps to be wiped.

Additionally, the instance contains a “FORCE_WIPE” field, that allows to wipe the map, extra files, using the same subfields as the “MAP” field. This field allows to set a different wipe schedule for maps and extra files.

The EXTRA_FILES field is an array of objects that specify extra files that should be wiped on the server along with the map. Each object in the array contains the following fields:

• PATH: a string representing the file path of the files that need to be wiped.
• FILES: an array of strings containing the names of the files that need to be wiped.

This field allows to specify a list of extra files that need to be wiped on the server in addition to the map wipe schedule. The EXTRA_FILES field is included in the WIPES and FORCE_WIPE fields, this allows to set a different wipe schedule for extra files than the one set in the WIPES field.

EXAMPLE CONFIGURATION

{
  "PTERODACTYL": {
    "ADDRESS": "https://panel.example.com",
    "API_KEY": "PTERODACTYL API KEY"
  },

  "EXTRAS": {
    "FORCE_WIPE_CRON": "0 14 * * 4#1",
    "FORCE_WIPE_TIMEZONE": "America/New_York",
    "IGNORE_WIPE_WHEN_DAYS_WITHIN_FORCE": 2
  },

  "INSTANCES": [
    {
      "SERVERS": ["PTERODACTYL SERVER ID"],

      "WIPES": [
        {
          "CRON": "0 15 * * TUE,FRI",
          "TIMEZONE": "America/New_York",
          "BLUEPRINTS": false,
          "MAP": {
            "ENABLED": true,
            "MODE": "procedural",

            "PROCEDURAL": {
              "RANDOMSEED": true,
              "SEED": "123456",
              "SIZE": 3500
            },

            "CUSTOM": {
              "URL_LIST": ["MAP URL 1", "MAP URL 2"]
            }
          },
          "EXTRA_FILES": [
            {
              "PATH": "/oxide/data",
              "FILES": ["Economics.json"]
            }
          ]
        }
      ],

      "FORCE_WIPE": {
        "MAP": {
          "ENABLED": true,
          "MODE": "custom",

          "PROCEDURAL": {
            "RANDOMSEED": true,
            "SEED": "",
            "SIZE": 3500
          },

          "CUSTOM": {
            "URL_LIST": ["MAP URL 1", "MAP URL 2"]
          }
        },
        "EXTRA_FILES": [
          {
            "PATH": "/oxide/data",
            "FILES": ["Economics.json"]
          }
        ]
      }
    },

    {
      "SERVERS": ["PTERODACTYL SERVER ID"],

      "WIPES": [
        {
          "CRON": "0 15 * * TUE,FRI",
          "TIMEZONE": "Europe/Paris",
          "BLUEPRINTS": false,
          "MAP": {
            "ENABLED": true,
            "MODE": "custom",

            "PROCEDURAL": {
              "RANDOMSEED": true,
              "SEED": "123456",
              "SIZE": 3500
            },

            "CUSTOM": {
              "URL_LIST": [
                "MAP URL 1",
                "MAP URL 2",
                "MAP URL 3",
                "MAP URL 4",
                "MAP URL 5"
              ]
            }
          },
          "EXTRA_FILES": [
            {
              "PATH": "/oxide/data",
              "FILES": ["Economics.json"]
            }
          ]
        }
      ],

      "FORCE_WIPE": {
        "MAP": {
          "ENABLED": true,
          "MODE": "custom",

          "PROCEDURAL": {
            "RANDOMSEED": true,
            "SEED": "",
            "SIZE": 3500
          },

          "CUSTOM": {
            "URL_LIST": ["MAP URL 1", "MAP URL 2"]
          }
        },
        "EXTRA_FILES": [
          {
            "PATH": "/oxide/data",
            "FILES": ["Economics.json"]
          }
        ]
      }
    }
  ]
}

Overall, this configuration file allows you to set multiple instances of Rust servers with different schedules, while also allowing different wipe schedules for the map and extra files, and different ways of wiping (procedural or custom) the map.