update readme
This commit is contained in:
parent
2a033018e7
commit
bfdd7b3411
3 changed files with 16 additions and 60 deletions
23
README.md
23
README.md
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
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 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.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
@ -94,13 +94,22 @@ Finally open the **Install link** and add the bot to your Discord server
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
### 1. Download
|
### Option 1: Using Pre-built Binaries (Easiest)
|
||||||
Download the latest executable from the [Releases](https://github.com/rambros3d/fluxer-reaper/releases) page & unzip it.
|
1. **Download**: 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.
|
||||||
|
- **Linux**: Run the **fluxer-reaper** file (or `./fluxer-reaper` in terminal).
|
||||||
|
- **Windows**: Run the **fluxer-reaper.exe** file.
|
||||||
|
|
||||||
### 2. Run
|
### Option 2: Running from Source
|
||||||
Simply run the downloaded file to start the tool. No Python installation is required.
|
1. **Clone**: Clone the repository to your local machine:
|
||||||
- **linux**: run the **fluxer-reaper** file (bash **./fluxer-reaper** if terminal doesnt open automatically)
|
```bash
|
||||||
- **windows**: run the **fluxer-reaper.exe** file
|
git clone https://github.com/rambros3d/fluxer-reaper.git
|
||||||
|
cd fluxer-reaper
|
||||||
|
```
|
||||||
|
2. **Launch**: Run the appropriate launcher script for your OS. It will automatically create a virtual environment and install dependencies:
|
||||||
|
- **Linux**: `./launch-reaper-LINUX.sh`
|
||||||
|
- **MacOS**: `./launch-reaper-MAC.sh`
|
||||||
|
- **Windows**: Double-click `launch-reaper-WIN.bat`
|
||||||
|
|
||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|
|
||||||
53
build.bat
53
build.bat
|
|
@ -1,53 +0,0 @@
|
||||||
@echo off
|
|
||||||
setlocal enabledelayedexpansion
|
|
||||||
|
|
||||||
echo --- Fluxer Reaper Windows Build Script ---
|
|
||||||
|
|
||||||
:: Check for venv
|
|
||||||
if not exist "venv" (
|
|
||||||
echo Creating virtual environment...
|
|
||||||
python -m venv venv
|
|
||||||
if errorlevel 1 (
|
|
||||||
echo Error: Failed to create venv. Make sure Python is installed.
|
|
||||||
exit /b 1
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
echo Activating virtual environment...
|
|
||||||
call venv\Scripts\activate
|
|
||||||
|
|
||||||
echo Ensuring build dependencies are up to date...
|
|
||||||
python -m pip install --upgrade pip --quiet
|
|
||||||
pip install pyinstaller --quiet
|
|
||||||
pip install -r requirements.txt --quiet
|
|
||||||
|
|
||||||
echo Cleaning previous build artifacts...
|
|
||||||
if exist "build" rd /s /q build
|
|
||||||
if exist "dist" rd /s /q dist
|
|
||||||
|
|
||||||
echo Starting PyInstaller build...
|
|
||||||
pyinstaller --clean fluxer-reaper.spec
|
|
||||||
|
|
||||||
echo Generating Launch-Reaper.bat launcher...
|
|
||||||
(
|
|
||||||
echo @echo off
|
|
||||||
echo cd /d "%%~dp0"
|
|
||||||
echo if exist "fluxer-reaper.exe" ^(
|
|
||||||
echo fluxer-reaper.exe
|
|
||||||
echo ^) else ^(
|
|
||||||
echo echo Error: fluxer-reaper.exe not found!
|
|
||||||
echo pause
|
|
||||||
echo ^)
|
|
||||||
) > dist\Launch-Reaper.bat
|
|
||||||
|
|
||||||
echo Packaging release: fluxer-reaper-windows.zip...
|
|
||||||
copy config.example.yaml dist\
|
|
||||||
powershell -Command "Compress-Archive -Path 'dist\fluxer-reaper.exe', 'dist\Launch-Reaper.bat', 'dist\config.example.yaml' -DestinationPath 'dist\fluxer-reaper-windows.zip' -Force"
|
|
||||||
|
|
||||||
echo -----------------------------------
|
|
||||||
echo Build complete!
|
|
||||||
echo Standalone executable: dist\fluxer-reaper.exe
|
|
||||||
echo Launcher script: dist\Launch-Reaper.bat
|
|
||||||
echo Release Package: dist\fluxer-reaper-windows.zip
|
|
||||||
echo ---
|
|
||||||
pause
|
|
||||||
|
Before Width: | Height: | Size: 492 KiB After Width: | Height: | Size: 492 KiB |
Loading…
Add table
Reference in a new issue