Did you ever want to create a copy of a guild? Now you can! There is no need to manually create roles, channels and permissions, which can take very long depending on the original guilds size. The script does everything for you. It backs up a guild into a single file and lets you create a new guild from it. You can share your file with others, too.
- Categories
- Text & Voice channels
- Roles (also managed ones)
- Role permissions for categories and text/voice channels (no user specific ones)
- Emojis
- Bans
- Chat history
- Invites
- Webhooks
- Audit Logs
- Third party integrations (Twitch/Youtube)
- Node.js any version >= 10.0.0 should work
- A Discord account with a bot user
- Discord Developer page link to create a bot
- (Optional) A preferably empty guild which can be overwritten
The script must be run with a bot user token. According to discords statement, any kind of user account botting including so called SelfBots are forbidden. The script will therefore block the execution with a user account token.
- Download the repository from github
- Unzip it
- Navigate into the extracted folder
- Edit the
settings.jsonand fill in all necessary data (see Settings for more information) - Open the console and run
npm install(on windows you can shift + right click inside the project folder and select 'open command prompt here'). You can also useyarn install - Run
node copy.jsin the console to print usage
To get the id of a guild open your client settings -> Appearance and then enable developer mode. If you now right click on a guild you can select 'Copy ID'.
| Variable | Explanation |
|---|---|
| originalGuildId | The id of the guild you want to clone. Can be left blank if a guildData.json file already exists. |
| newGuildId | The id of the new guild you want to clone to. |
| newGuildAdminRoleId | The id of a role with administrator permissions. The bot needs to have this role on the new guild! You can manually create a new role called 'guildcopy' and the script will automatically use it. If you do so, just leave this field empty. |
| copyEmojis | default: false - Set to true to copy emojis (see also Common Behaviour) |
| copyBans | default: false - set to true to copy banned users. The bot needs to have the BAN_MEMBERS permission on the original guild if you enable this! |
| language | default: en - Set this to any supported language from the translations folder |
| output | default: all - Possible values: all for everything, error for errors only, none for no output at all |
| djsVersionCheck | default: true - Checks the local discord.js version by its commit hash. If you periodically run this script, you might want to disable this |
| debug | default: false - Set to true for a more detailed general and error output e.g. when creating an issue |
| token | The bot token. The bot does not need any permissions on the original guild (only exception: copyBans=true). |
- New guild cleanup
- Emoji Creation/Deletion: This will take time, especially if there are lots of them. Expect a few rateLimits when 'debug' is on. If 'copyEmojis' is disabled, emojis on the new server won't be deleted or new ones added.
- Bans Creation/Deletion: see 'Emoji Creation/Deletion' above
- Channel Deletion: The client might still show deleted channels despite them already being deleted. To fix this, just restart your discord client. You can do this while the script is running.
- Region
- Some guilds have VIP regions which cannot be used by normal guilds. Therefore if you copy such a guild the region will be set to us-central.
- Nitro Boosted Guild
- If you backup a nitro boosted guild, this backup can still be loaded on any non or lower boosted guild. The script will automatically scale down the voice channel bitrates and the amount of possible emojis. The same goes for the guild splash and banner.
- The Tier 3 vanity URL will not be backed up or copied to a new guild!
This was developed when 11.2.1 was the latest version which wasn't able to provide all needed features (e.g. categories, permissions) to clone a whole guild. A port/rewrite to 11.3.X (or any version <12.0) and then to 12.0 again would just be unnecessary busywork. I will probably switch to the stable release as soon as 12.0 is stable.
I try to check new commits for changes which might break something but if I miss one, feel free to remind me ;D
Most of the common issues are displayed in the console while running the script. If you encounter crashes or any other weird behaviour not listed here feel free to create an issue. The script creates logs in the 'logs' folder. Feel free to upload those to something like pastebin and add them to the created issue to help me find the problem.
Of course, just create an issue or a pull request.
If you want to help translate the script, feel free do so so. Just create a copy of the en.json in the translation folder and create a pull request with the new translation. All [@@X@@] statements are dynamic parts of a sentence and need to be in the correct spot for each language numbered with 1,2,3,... Please test your translation at least once before submitting it and don't forget to change the langcode/language/author at the top of the file.
This software is licensed under the terms of the GPLv3. For more details see LICENSE.
- EmberVulpix for the command line arguments
- TheLightSpirit for the french README translation (not always up-to-date)
- Everybody who helps adding new features and finding bugs!