https://github.com/shadowsocks/kcptun-android

kcptun for Android.
https://github.com/shadowsocks/kcptun-android

Last synced: 2 months ago
JSON representation

kcptun for Android.

• Host: GitHub
• URL: https://github.com/shadowsocks/kcptun-android
• Owner: shadowsocks
• License: gpl-3.0
• Created: 2017-01-22T19:55:10.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-18T06:12:33.000Z (over 2 years ago)
• Last Synced: 2025-03-28T16:08:11.685Z (2 months ago)
• Language: Shell
• Homepage:
• Size: 4.33 MB
• Stars: 571
• Watchers: 33
• Forks: 164
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## kcptun for Android

[![CircleCI](https://circleci.com/gh/shadowsocks/kcptun-android.svg?style=svg)](https://circleci.com/gh/shadowsocks/kcptun-android)

[![API](https://img.shields.io/badge/API-21%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=21)

[![Releases](https://img.shields.io/github/downloads/shadowsocks/kcptun-android/total.svg)](https://github.com/shadowsocks/kcptun-android/releases)

[![Language: Kotlin](https://img.shields.io/github/languages/top/shadowsocks/kcptun-android.svg)](https://github.com/shadowsocks/kcptun-android/search?l=kotlin)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/46b34df6fe624ef9a46507126f407880)](https://www.codacy.com/app/shadowsocks/kcptun-android?utm_source=github.com&utm_medium=referral&utm_content=shadowsocks/kcptun-android&utm_campaign=Badge_Grade)

[![License](https://img.shields.io/github/license/shadowsocks/kcptun-android.svg)](https://github.com/shadowsocks/kcptun-android/blob/master/LICENSE)

[kcptun](https://github.com/shadowsocks/kcptun) plugin for [shadowsocks-android](https://github.com/shadowsocks/shadowsocks-android).



### PREREQUISITES

* JDK 1.8

* Go 1.11+

* Android SDK

  - Android NDK r19+

### BUILD

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

* Set environment variable `ANDROID_HOME` to `/path/to/android-sdk`

* (optional) Set environment variable `ANDROID_NDK_HOME` to `/path/to/android-ndk` (default: `$ANDROID_HOME/ndk-bundle`)

* Clone the repo using `git clone --recurse-submodules ` or update submodules using `git submodule update --init --recursive`

* Build it using Android Studio or gradle script

### TRANSLATE

This plugin is an official plugin thus you can see [shadowsocks-android](https://github.com/shadowsocks/shadowsocks-android/blob/master/README.md#translate)'s instructions to translate this plugin's UI.

## OPEN SOURCE LICENSES



    
kcptun: MIT





### LICENSE

Copyright (C) 2017 by Max Lv <>  

Copyright (C) 2017 by Mygod Studio <>

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 .