A shadowsocks client for Android

dev4u fadd8423c3 Fix the compile error #2930 (#2935) 1 week ago
.circleci 9f6b3a41f0 Bump version 1 month ago
.github 466fc7bb2d Update issue templates with labels 2 years ago
buildSrc 9f6b3a41f0 Bump version 1 month ago
core fadd8423c3 Fix the compile error #2930 (#2935) 1 week ago
gradle 590c1e71fa Update dependencies 1 month ago
mobile ce4f6080e5 Remove useless code 1 month ago
plugin 590c1e71fa Update dependencies 1 month ago
tv b7e90d42f1 Misc fixes 1 month ago
.gitignore cc9adc2a32 Update .gitignore 4 months ago
.gitmodules 833b35e7b7 Fix output name second attempt 2 years ago
.travis.yml 07ec96bf27 Use api-28-ndk image for CI 3 years ago
AUTHORS 4d907bbdf0 add AUTHORS 6 years ago
CONTRIBUTING.md 4fd44a3225 Clarifying instruction documents (#2213) 3 years ago
LICENSE 694be8abbe Update README and LICENSE 5 years ago
README.md 5510e44abe Fix Codacy badge 7 months ago
build.gradle.kts 590c1e71fa Update dependencies 1 month ago
detekt.yml 590c1e71fa Update dependencies 1 month ago
gradle.properties 115a60aa17 Enable Parallel GC 1 year ago
gradlew 590c1e71fa Update dependencies 1 month ago
gradlew.bat 70d509e195 Update dependencies 2 years ago
privacy_policy.md 286ff2274d Update privacy_policy.md 3 years ago
release.sh 247c4a1f36 Bump version 1 year ago
repositories.gradle.kts 2c2b14dfa7 Downgrade AGP 1 month ago
settings.gradle.kts 990b693b82 Migrate to Kotlin DSL (#2490) 2 years ago
translate.py ec0f43b833 Update translations 2 months ago

README.md

Shadowsocks for Android

CircleCI API Releases Codacy Badge

for Android & Chrome OS (beta)
for Android TV (beta)

PREREQUISITES

  • JDK 11+
  • Android SDK
    • Android NDK
  • Rust with Android targets installed
  $ cd core/src/main/rust/shadowsocks-rust
  $ rustup target add armv7-linux-androideabi aarch64-linux-android i686-linux-android x86_64-linux-android

BUILD

You can check whether the latest commit builds under UNIX environment by checking Travis status.

  • Install prerequisites
  • Clone the repo using git clone --recurse-submodules <repo> or update submodules using git submodule update --init --recursive
  • Build it using Android Studio or gradle script

BUILD WITH DOCKER

  • Clone the repo using git clone --recurse-submodules <repo> or update submodules using git submodule update --init --recursive
  • Run docker run --rm -v ${PWD}:/build -w /build shadowsocks/android-ndk-go ./gradlew assembleDebug

CONTRIBUTING

If you are interested in contributing or getting involved with this project, please read the CONTRIBUTING page for more information. The page can be found here.

TRANSLATE

OPEN SOURCE LICENSES

LICENSE

Copyright (C) 2017 by Max Lv <max.c.lv@gmail.com>
Copyright (C) 2017 by Mygod Studio <contact-shadowsocks-android@mygod.be>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.