شروع کار#

این راهنما برای زمانی است که می‌خواهید bgscan را روی سیستم خودتان اجرا و تغییر دهید.

قبل از شروع، راهنمای مشارکت را ببینید. آن‌جا گفته‌ایم Branchها و PRها را چطور نگه می‌داریم.

چیزهایی که لازم دارید#

• Go نسخهٔ 1.27 یا جدیدتر
• Git
• اگر برای Android Build می‌گیرید: Android NDK

سورس را بگیرید#

git clone https://github.com/MohsenBg/bgscan.git
cd bgscan

برای تغییر خودتان یک Branch بسازید:

git checkout -b feature/my-change

وابستگی‌ها را آماده کنید#

bgscan برای گرفتن باینری Slipstream مخصوص هر سیستم و فهرست‌های IP پیش‌فرض، از bgscan-builder استفاده می‌کند. (خود Xray باینری نمی‌خواهد و با کتابخانهٔ داخلی xray-core داخل برنامه اجرا می‌شود.)

Linux / macOS

./scripts/install-deps.sh

Windows

./scripts/install-deps.ps1

این اسکریپت bgscan-builder را به ریشهٔ پروژه می‌آورد و با setup-dev باینری Slipstream مناسب OS و معماری فعلی را دانلود می‌کند.

اجرا#

go mod tidy
go run ./cmd/bgscan/

برنامه اول بررسی‌های اولیه را داخل TUI نشان می‌دهد. اگر همه‌چیز درست بود، Enter بزنید.

ساخت Release#

اگر هنوز bgscan-builder را ندارید، آن را نصب کنید:

# Linux / macOS
./scripts/install-builder.sh

# Windows
./scripts/install-builder.ps1

بعد Release بسازید:

bgscan-builder release -os linux -arch amd64
bgscan-builder release -os android -arch arm64 -ndk-dir /opt/android-ndk
bgscan-builder release -os all -arch all -dest ./dist

برای Android باید مسیر NDK را با -ndk-dir بدهید.

ابزار bgscan-builder#

یک ابزار کوچک Go فقط برای ساخت پروژه است و دو ساب‌کامند دارد:

• setup-dev — باینری Slipstream مناسب همین سیستم را دانلود می‌کند تا go run ./cmd/bgscan/ کار کند.
• release — باینری Slipstream را کنار Build می‌گذارد و خروجی Release را برای OS و معماری هدف می‌سازد.

نصب و به‌روزرسانی نسخه‌های منتشرشده کار builder نیست؛ آن را ابزار جداگانهٔ bgscan-installer انجام می‌دهد.