diff --git a/README.md b/README.md index 3939d77..ca206b5 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,109 @@ # Fluxer Reaper -Fluxer Reaper is a simple tool to help you move your Discord server content over to a Fluxer community. It handles channels, roles, emojis, and even your message history. +Fluxer Reaper is a simple tool to help you move an entire Discord server over to a Fluxer community. It handles channels, roles, emojis, and even your message history. ![Fluxer Reaper](fluxer-reaper.jpg) ## Features -* **Clone Server Structure**: Automatically creates all your Discord categories and channels in Fluxer. -* **Copy Roles**: Copies your roles and their basic permissions. -* **Copy Emojis & Stickers**: Copies your custom emojis and stickers over. -* **Message History**: Select a specific channel and migrate messages starting from the oldest or a custom point. -* **Server Identity**: Syncs your server name, icon, and banner. -* **Danger Zone**: Option to wipe existing channels, roles, and content in the fluxer community. + +### 1. Clone Server Template +* **Structure Sync**: Automatically creates all your Discord categories and channels in Fluxer. +* **Property Migration**: Copies channel topics, NSFW status, and slowmode settings. +* **Deduplication**: Reads Fluxer for existing channels to prevent duplicates. +* **Category Linking**: Ensures channels are automatically placed within their correct categories. + +### 2. Copy Roles & Permissions +* **Role Migration**: Copies roles, colors, and basic permissions. +* **Permission Sync**: Mirrors category and channel-specific role overwrites. + +### 3. Copy Emojis & Stickers +* **Asset Migration**: Downloads and uploads custom emojis and stickers. +* **Flexible Sync**: Options to sync emojis only, stickers only, or both. + +### 4. Sync Server Identity +* **Metadata Sync**: Syncs your server name, icon, and banner. +* **Component Selection**: Options to sync only specific components. + +### 5. Migrate Message History +* **Masquerade User**: Uses webhooks to mirror original user avatars and nicknames for a seamless transition. +* **Contextual Pairing**: Easily map Discord channels to their Fluxer counterparts. +* **Flexible Start Points**: Start from the oldest message or a specific custom message ID/link. +* **Rich History**: Migrates message content, author markers, and attachments. +* **Thread Support**: Handles threads with dedicated markers in the target channel. + +### 6. Configuration & Validation +* **Real-time Validation**: Audits bot tokens and IDs for validity. +* **Permission Checks**: Checks if bots have the required Intents and Permissions. + +### 7. Danger Zone +* **Wipe Options**: Irreversibly delete channels, roles, or assets to clear a community. +* **Permission Reset**: Batch-wipe all channel permission overwrites. + +## Notes: +- The Discord bot has read-only access to the source server. Hence no changes will be made to the source server. +- Currently Fluxer is unstable probably due to high traffic, migrating servers now will only add to that problem. Only use this for testing purposes for now. [Check status here](https://uptime.reallyaweso.me/status/fluxer) + + +# Bot Setup + +# 1) Fluxer Bot + +Go to your **user settings** in Fluxer (**Ctrl** + **,**) and **Create Application** +![Fluxer Step 1](images/fluxer-bot-1.png) + +**Name your bot** +![Fluxer Step 2](images/fluxer-bot-2.png) + +**Regenerate** & copy the **Bot Token**. Save it somewhere safe, you will need it later for the tool +![Fluxer Step 3](images/fluxer-bot-3.png) + +Scroll down to **Scopes** and select **bot**. Enable **Administrator** under Bot Permissions +![Fluxer Step 4](images/fluxer-bot-4.png) + +Choose your **Fluxer Community** (Preferably create and use a new one) +![Fluxer Step 5](images/fluxer-bot-5.png) + +**Authorize** & Add the bot to your community +![Fluxer Step 6](images/fluxer-bot-6.png) + + +## 2) Discord Bot + +Go to https://discord.com/developers/applications & create **New Application** +![Discord Step 1](images/discord-bot-1.png) + +**Name your bot** +![Discord Step 2](images/discord-bot-2.png) + +In the bot Settings, enable **Message Content Intent** +![Discord Step 3](images/discord-bot-3.png) + +**Regenerate** & copy the **Bot Token**. Save it somewhere safe, you will need it later for the tool +![Discord Step 4](images/discord-bot-4.png) + +Under **Installation** section, enable these: +- Scopes: **bot** +- Permissions: **Read Message History** , **View Channels** + +![Discord Step 5](images/discord-bot-5.png) + +Finally open the **Install link** and add the bot to your Discord server +![Discord Step 6](images/discord-bot-6.png) ## Getting Started ### 1. Download -Download the latest executable from the [Releases](https://github.com/rambros3d/fluxer-reaper/releases) page. +Download the latest executable from the [Releases](https://github.com/rambros3d/fluxer-reaper/releases) page & unzip it. ### 2. Run Simply run the downloaded file to start the tool. No Python installation is required. - - -## Build tool -To create a standalone executable: - -### Linux / Mac -```bash -chmod +x build.sh -./build.sh -``` - -### Windows -1. Make sure you have [Python](https://www.python.org/) installed and added to your PATH. -2. Double-click `build.bat`. - -The scripts will automatically set up a virtual environment, install dependencies, and generate the binary in the `dist/` folder. +- **linux**: run the **fluxer-reaper** file (bash **./fluxer-reaper** if terminal doesnt open automatically) +- **windows**: run the **fluxer-reaper.exe** file ## Vibe Code Notice -Code is provided as is; This tool was developed largely by AI. - -Take it, use it, modify it, feel free to do whatever you wish. \ No newline at end of file +- Code is provided as is; This tool was developed with AI. +- Take it, use it, modify it, feel free to do whatever you wish. \ No newline at end of file diff --git a/images/discord-bot-1.png b/images/discord-bot-1.png new file mode 100644 index 0000000..832fa77 Binary files /dev/null and b/images/discord-bot-1.png differ diff --git a/images/discord-bot-2.png b/images/discord-bot-2.png new file mode 100644 index 0000000..87f8581 Binary files /dev/null and b/images/discord-bot-2.png differ diff --git a/images/discord-bot-3.png b/images/discord-bot-3.png new file mode 100644 index 0000000..2883f8e Binary files /dev/null and b/images/discord-bot-3.png differ diff --git a/images/discord-bot-4.png b/images/discord-bot-4.png new file mode 100644 index 0000000..021ac46 Binary files /dev/null and b/images/discord-bot-4.png differ diff --git a/images/discord-bot-5.png b/images/discord-bot-5.png new file mode 100644 index 0000000..6ef2883 Binary files /dev/null and b/images/discord-bot-5.png differ diff --git a/images/discord-bot-6.png b/images/discord-bot-6.png new file mode 100644 index 0000000..b076d73 Binary files /dev/null and b/images/discord-bot-6.png differ diff --git a/images/fluxer-bot-1.png b/images/fluxer-bot-1.png new file mode 100644 index 0000000..709ba0d Binary files /dev/null and b/images/fluxer-bot-1.png differ diff --git a/images/fluxer-bot-2.png b/images/fluxer-bot-2.png new file mode 100644 index 0000000..29b89c3 Binary files /dev/null and b/images/fluxer-bot-2.png differ diff --git a/images/fluxer-bot-3.png b/images/fluxer-bot-3.png new file mode 100644 index 0000000..26cc735 Binary files /dev/null and b/images/fluxer-bot-3.png differ diff --git a/images/fluxer-bot-4.png b/images/fluxer-bot-4.png new file mode 100644 index 0000000..eb9d4cd Binary files /dev/null and b/images/fluxer-bot-4.png differ diff --git a/images/fluxer-bot-5.png b/images/fluxer-bot-5.png new file mode 100644 index 0000000..1531d7b Binary files /dev/null and b/images/fluxer-bot-5.png differ diff --git a/images/fluxer-bot-6.png b/images/fluxer-bot-6.png new file mode 100644 index 0000000..53672e8 Binary files /dev/null and b/images/fluxer-bot-6.png differ