Soon

Below is a list of recommended first steps to do when setting up a project and a wipe for a server:

1. Add a Pterodactyl® API Key for your project.
2. Start adding servers from a selected panel.
3. From the server list, select the server you want to make changes to.
4. Via Maps & Seeds add as many maps to the server as you'd like.
5. In Wipes Wipes add wipes according to your schedule.

It is recommended to browse through all the settings to unleash rust-wipes.com's full potential.

Any interaction with dates or times is calculated according to the timezone you have set in your profile settings. If you have an active subscription you might have noticed the Project Timezone setting here, this setting is only used to set a specific timezone for your public wipe page in case a user is not logged in. Leave it default or set it to the majority of your players timezone.

Each Pterodactyl® Panel does come with an API that allows for managing files, settings and more. rust-wipes.com utilizes that feature by sending specific requests at user specified times. All tasks that would make up for a RUST wipe by hand are automated by us, scheduled on time and processed by multiple job workers to ensure the fastest possible wipe times.

This entirely depends on the settings you are using for your server. If you happen to remove a lot of files on each wipe for example, it takes time to send and execute each removal. If you just started using rust-wipes.com and have the Purge .sav files option enabled your first wipe might run much longer if you have a huge pile of old files collected already. You might also see multiple tries on Shutdown and Restart checks in the servers logs, that is due to Pterodactyl Panel caching the power state for 20s and is intended behaviour, this however increases the logged runtime duration but in real-life a server might already be starting even if the panel responds that it is offline.

To enable the rustmaps.com integration for your server simply add the API key found here under API > Api key to your projects RUSTMAPS.COM settings. Once the API key is added, there is no further action required from your side. The map generation, if needed, will now be automated. The information gathered from the map will primarily be used for displaying preview images for upcoming wipes and map votes.
Depending on the size of your project we recommend upgrading to a paid plan.

Generation Threshold

To prevent exhausting the map generation limit on RustMaps.com, only the first N maps in your server's map list are requested and generated. If you move a map to one of the first N positions, it will automatically trigger a map request. Additionally, you have the option to manually request a map by clicking the "Request" button. This ensures that only a limited number of maps are processed to avoid exceeding the map generation limit.

Regenerate on Staging

After a scheduled RUST update, already generated maps on RustMaps.com may become invalid and outdated. To address this, RustMaps.com typically enables staging maps before the update goes live.
If you prefer not to manually regenerate maps by clicking the Regenerate button, you can enable an option that will automatically trigger regeneration requests for all previously generated maps. This ensures that your maps are updated automatically without requiring manual intervention.

If you need to grant access to other users for your project, you can add as many as you want in the SUB-USERS setting of your project. However, please note that all added sub-users will have access to all of the project's servers. They will not have access to the servers that you may have access to as a sub-user nor the projects settings.

If a server has no maps in its map list remaining, the failover mode is activated automatically. If a server should wipe within the next 60 minutes and no maps have been added yet, a map, using a random seed will be added to the map list to use for that wipe.

You most likely failed to adjust the server Server Identity field in settings. If you fail to do so, rust-wipes.com may search for files at the wrong directory.

Rust-Wipes.com requires a specific type of API key called a Client API Key, which should not be confused with the Application API Key. To generate a Client API key, please follow these steps:

1. Go to the "Account" section of your Pterodactyl® Panel instance.
2. Look for the "API Credentials" option.
3. Generate a new API key.

Please note that we currently do not support the "ALLOWED IPS" option, we recommend to match the "DESCRIPTION" field with the description you want to use on Rust-Wipes.com.

By default, all hosts that utilize Pterodactyl® Panel as their control panel of choice are supported. Below is a list of confirmed and approved hosts. If you're still unsure, simply open a support ticket.

• tempest.net
• icedhost.com*

* This host is known to use a custom RUST egg/config. Please review the servers Advanced Settings
Please not that we do not support WISP.gg even thought it is built upon Pterodactyl™. WISP.gg was built using an older version of the panel, including the old v0.7 API and is therefore incompatible

There's no limit on how many Pterodactyl® API keys you can add. However, depending on your plan, you might be limited by the number of servers you can add.

Pterodactyl® Panel has a default API rate limit of 720 requests per minute. We regularly calculate the average number of requests made to a single key if all servers were to wipe at the same time. If that number exceeds the default rate limit of 720, we send out a warning as there would be a possibility of delayed wipes. To mitigate this limit, you can add multiple Pterodactyl® API keys for the same control panel instance and distribute your servers across those keys.

We run checks for all added Pterodactyl® Panel API Keys every 4 to 6 hours to confirm your key is still valid and working. If we happen to find a key where we can no longer validate it being working, all servers using this key will automatically have auto-wiping disabled until you fix the issue. Potential issues could be the user account that created the key was deleted or the key itself was removed and expired SSL certificates. Remember to re-enable auto-wiping after fixing the issues!

To set up the rust-wipes.com Discord bot, you first need to invite it. An invite link is conviniently located on your projects Discord settings here or directly via Discord by checking our bots profile and clicking the + Add App button.

Once the bot is part of your Discord server you will need to connect it to your project by running /connect-bot , to obtain the token that is required, visit your projects Discord settings.

Now that you're set-up you may configure the Server Status Channel and/or Map Vote Channel by executing /set-status-channel or /set-vote-channel respectively. Please be aware that for both features to work, the bot is required to have the permission to send messages in these channels, optially it is recommended that users should only be allowed to add ro existing reactions and not adding new ones.

Good to know:
Only servers that have Show on Public Page enabled will be listed on server stats.
Map votes via the Discord bot need to be enabled in a servers' Map Votes settings.

If you're using Cloudflare to secure your Pterodactyl® Panel, chances are high that CF is blocking rust-wipes.com. Please review your CF settings in that case, whitelist rust-wipes.com and disable the Bot Fight Mode. IPs to whitelist: 116.202.12.19 144.76.116.76