hosfad / discord-backup

a module for backing up and restoring discord servers.

@outwalk/discord-backup

Discord Backup is a module for backing up and restoring discord servers.

This package is heavily inspired by discord-backup which has become unmaintained. This package has been updated to support discord.js v14 and aims to maintain API compatibility with discord-backup.

---

Installation

You can install @outwalk/discord-backup using npm:

npm install @outwalk/discord-backup

---

Create

Create a backup for the specified server.

import backup from "@outwalk/discord-backup";

const backupData = await backup.create(guild, options);

Load

Allows you to load a backup on a Discord server!

import backup from "@outwalk/discord-backup";

await backup.load(backupId, guild);
await backup.remove(backupId);

Fetch

Fetches information from a backup. The backup info provides a data, id, and size property.

import backup from "@outwalk/discord-backup";

const backupInfo = await backup.fetch(backupId);

Remove

Warn: once the backup is removed, it is impossible to recover it!

import backup from "@outwalk/discord-backup";

backup.remove(backupID);

List

Note: backup.list() simply returns an array of IDs, you must fetch the ID to get complete information.

import backup from "@outwalk/discord-backup";

const backups = backup.list();

SetStorageFolder

Updates the storage folder to another

import backup from "@outwalk/discord-backup";
import path from "path";

backup.setStorageFolder(path.join(process.cwd(), "backups"));

---

Advanced usage

Create [advanced]

You can use more options for backup creation:

import backup from "@outwalk/discord-backup";

await backup.create(guild, {
    backupId: "mybackup",
    maxMessagesPerChannel: 10,
    jsonSave: false,
    jsonBeautify: true,
    doNotBackup: ["roles", "channels", "emojis", "bans"],
    backupMembers: false,
    saveImages: "base64",
    speed: 250
});

backupId: Specify an Id to be used for the backup, if not provided a random one will be generated.
maxMessagesPerChannel: Maximum of messages to save in each channel. "0" won't save any messages.
jsonSave: Whether to save the backup into a json file. You will have to save the backup data in your own db to load it later.
jsonBeautify: Whether you want your json backup pretty formatted.
doNotBackup: Things you don't want to backup. Available items are: roles, channels, emojis, bans.
backupMembers: Wether or not to save information on the members of the server.
saveImages: How to save images like guild icon and emojis. Set to "url" by default, restoration may not work if the old server is deleted. So, url is recommended if you want to clone a server (or if you need very light backups), and base64 if you want to backup a server. Save images as base64 creates heavier backups.
speed: What speed to run at, default is 250 (measured in ms)
verbose: Derermines if the output should be verbose or not.

Load [advanced]

As you can see, you're able to load a backup from your own data instead of from an ID:

import backup from "@outwalk/discord-backup";

await backup.load(backupData, guild, {
    clearGuildBeforeRestore: true,
    maxMessagesPerChannel: 10,
    speed: 250,
    doNotLoad: ["roleAssignments", "emojis"]
});

clearGuildBeforeRestore: Whether to clear the guild (roles, channels, etc... will be deleted) before the backup restoration (recommended).
maxMessagesPerChannel: Maximum of messages to restore in each channel. "0" won't restore any messages.
speed: What speed to run at, default is 250 (measured in ms)
verbose: Determines if the output should be verbose or not.
doNotLoad: Things you dont want to restore. Available items are: main, roleAssignments, emojis. main will prevent loading the main backup, roleAssignments will prevent reassigning roles to members, and emojis will prevent restoring emojis.

---

Reporting Issues

If you are having trouble getting something to work or run into any problems, you can create a new issue.

---

License

@outwalk/discord-backup is licensed under the terms of the MIT license.