Update README
This commit is contained in:
世界
parent
a2fb6ad09a
commit
e01fe0d361
15
.github/ISSUE_TEMPLATE/language_request.md
vendored
Normal file
15
.github/ISSUE_TEMPLATE/language_request.md
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
name: Language builtin request
|
||||
about: Request to amend the built-in translation
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Language (please complete the following information):**
|
||||
- Language: [e.g. en_US]
|
||||
- Pack Link: [e.g. https://translations.telegram.org/en/]
|
||||
|
||||
**If the language has already been built in, please describe the reason for the replacement:**
|
||||
e.g. The language pack is no longer maintained / The original meaning is modified
|
||||
89
README.md
89
README.md
@ -15,46 +15,47 @@ NekoX is an **free and open source** third-party Telegram client, based on Teleg
|
||||
## NekoX Changes
|
||||
|
||||
- Most of Nekogram's features
|
||||
- Max account limit set to 32
|
||||
- Max account limit set to 16
|
||||
- OpenCC Chinese Convert
|
||||
- Built-in Vmess, Shadowsocks, SSR proxies support
|
||||
- Built-in public proxy list / Proxy subscription support.
|
||||
- Proxies import and export, remarks, speed measurement, sorting, delete unusable nodes, etc.
|
||||
- Scan the qrcode (any link, can add a proxy).
|
||||
- The ( vemss / vmess1 / ss / ssr / rb ) proxy link in the message can be clicked.
|
||||
- Allow auto disable proxy when VPN is enabled
|
||||
- Built-in VMess, Shadowsocks, SSR, Trojan-GFW proxies support
|
||||
- Built-in public proxy list / Proxy subscription support
|
||||
- Able to parse all proxy subscription format: SIP008, ssr, v2rayN, vmess1, shit ios app formats, clash config and more
|
||||
- Proxies import and export, remarks, speed measurement, sorting, delete unusable nodes, etc
|
||||
- Scan the QR code (any link, can add a proxy)
|
||||
- The ( vmess / vmess1 / ss / ssr / trojan ) proxy link in the message can be clicked
|
||||
- Allow auto-disabling proxy when VPN is enabled
|
||||
- Proxy automatic switcher
|
||||
- Add stickers without sticker pack
|
||||
- Allow disable vibration
|
||||
- Allow disabling vibration
|
||||
- Allow clicking on links in self profile
|
||||
- Sticker set list backup / restore / share
|
||||
- Full InstantView translation support
|
||||
- Translation support for selected text on input and in messages
|
||||
- Delete all messages in group
|
||||
- Dialog sorting is optional "Unread and can be prioritized for reminding" etc.
|
||||
- Dialog sorting is optional "Unread and can be prioritized for reminding" etc
|
||||
- Allow to skip "regret within five seconds"
|
||||
- Unblock all users support
|
||||
- Login via qrcode
|
||||
- Scan and confirm the login qrcode directly
|
||||
- Allow clear application data
|
||||
- Login via QR code
|
||||
- Scan and confirm the login QR code directly
|
||||
- Allow clearing app data
|
||||
- Option to not send comment first when forwarding
|
||||
- 0ption to use nekox chat input menu: replace record button with a menu which contains an switch to control link preview (enabled by default)
|
||||
- Option to disable link preview by default: to prevent the server from knowing that the link is shared through Telegram.
|
||||
- Option to ignore Android-only content restrictions (except for the Play Store version).
|
||||
- OpenKaychain client ( sign / verify / decrypt / import )
|
||||
- OpenKaychain client (sign / verify / decrypt / import)
|
||||
- Google Cloud Translate / Yandex.Translate support
|
||||
- Custom cache directory (supports external storage)
|
||||
- Custom AppId and Hash (optional NekoX / Andorid / Android X or Manual input)
|
||||
- Custom server (official, test DC or Manual input)
|
||||
- Custom app ID and Hash (optional NekoX / Andorid / Android X or Manual input)
|
||||
- Custom server (official, test DC)
|
||||
- Keep the original file name when downloading files
|
||||
- View the data center you belong to when you don't have an avatar
|
||||
- Proxies, groups, channels, sticker packs are able to shared as qrcodes.
|
||||
- Proxies, groups, channels, sticker packs are able to shared as QR codes
|
||||
- Force English emoji keywords to be loaded
|
||||
- Add "@Name" when long press @ user option
|
||||
- Enhanced notification service, optional version without Google Services.
|
||||
- Add "@Name" when long-pressing @user option
|
||||
- Enhanced notification service, optional version without Google Services
|
||||
- Don't alert "Proxy unavailable" for non-current account
|
||||
- Option to block others from starting a secret chat with you
|
||||
- Allow create group without invite
|
||||
- Allow creation of group without invite
|
||||
- Option to upgrade group to supergroup
|
||||
- Mark dialogs as read using tab menu
|
||||
- Option to hide device info
|
||||
@ -62,8 +63,14 @@ NekoX is an **free and open source** third-party Telegram client, based on Teleg
|
||||
- Improved link long click menu
|
||||
- Text replacer
|
||||
- Option to disable trending
|
||||
- Tgx style message unpin menu
|
||||
- Telegram X style menu for unpinning messages
|
||||
- Built-in Material Design themes / Telegram X style icons
|
||||
- Enabled set auto delete timer option for private chats and private groups
|
||||
- Don't process cleanup draft events after opening chat
|
||||
- Support saving multiple selected messages to Saved Messages
|
||||
- Support unpinning multiple selected messages
|
||||
- View stats option for messages
|
||||
- And more :)
|
||||
|
||||
## Compilation Guide
|
||||
|
||||
@ -72,17 +79,17 @@ Consider using a Linux VM or dual booting.**
|
||||
|
||||
**Important:**
|
||||
|
||||
1. Install Android Sdk and NDK ( default location is $HOME/Android/Sdk, otherwise you need to specify $ANDROID_HOME for it )
|
||||
1. Install Android SDK and NDK (default location is $HOME/Android/SDK, otherwise you need to specify $ANDROID_HOME for it)
|
||||
|
||||
It is recommended to use [AndroidStudio](https://developer.android.com/studio) to install. [here is how to install AndroidStudio](https://developer.android.com/studio/install).
|
||||
It is recommended to use [AndroidStudio](https://developer.android.com/studio) to install.
|
||||
|
||||
2. Install golang ( 1.15.8 ).
|
||||
2. Install golang ( 1.15 ).
|
||||
```shell
|
||||
# debian sid
|
||||
apt install -y golang
|
||||
```
|
||||
|
||||
3. Install rust and its stdlib for android abis, add environment variables for it.
|
||||
3. Install Rust and its stdlib for Android ABIs, and add environment variables for it.
|
||||
|
||||
It is recommended to use the official script, otherwise you may not find rustup.
|
||||
|
||||
@ -108,9 +115,9 @@ rustup target install armv7-linux-androideabi aarch64-linux-android i686-linux-a
|
||||
|
||||
More features, **without** [additional trackers](https://gitlab.com/search?utf8=%E2%9C%93&snippets=false&scope=&repository_ref=master&search=AnalyticsHelper&group_id=10273976&project_id=22804922).
|
||||
|
||||
#### What is the difference between Full and Mini version?
|
||||
#### What is the difference between the Full and Mini version?
|
||||
|
||||
The full version comes with built-in proxy support for v2ray, shadowsocks, and shadowsocksr, which is usually provided to advanced users to help friends who have no computer knowledge in mainland China to bypass censorship. Don't complain about imperfect functions or ask to add other rare proxy types, you can use their clients directly.
|
||||
The full version comes with built-in proxy support for v2ray, shadowsocks, shadowsocksr, and trojan, which is usually provided to advanced users to help friends who have no computer knowledge in mainland China to bypass censorship. Don't complain about imperfect functions or ask to add other rare proxy types, you can use their clients directly.
|
||||
|
||||
#### What if I don't need a proxy?
|
||||
|
||||
@ -118,17 +125,35 @@ Then it is recommended to use the `Mini` version.
|
||||
|
||||
#### I've encountered a bug!
|
||||
|
||||
First, make sure you have the latest version installed (check the channel, play store updates usually have a delay).
|
||||
First, make sure you have the latest version installed (check the channel, Play store versions usually have a delay).
|
||||
|
||||
Then, if the issue appears on the official telegram as well, please submit it to the officials, ( but be careful not to show NekoX in the description and screenshots, the official developers don't like us! ).
|
||||
Then, if the issue appears in the official Telegram client too, please submit it to the officials, (be careful not to show NekoX in the description and screenshots, the official developers doesn't like us!).
|
||||
|
||||
Then, please *detail* your issue, create an issue or submit it to our [group](https://t.me/NekoXChat) with #bug.
|
||||
|
||||
If you experience a *crash*, you also need to click on the version number at the bottom of the settings and select "Enable Log" and send it to us.
|
||||
|
||||
#### How can I help with Localization?
|
||||
## Localization
|
||||
|
||||
Join the project at https://hosted.weblate.org/projects/nekox/
|
||||
Is NekoX not in your language, or the translation is incorrect or incomplete? Get involved in the translations on our [Weblate](https://hosted.weblate.org/engage/nekox/).
|
||||
|
||||
[](https://hosted.weblate.org/engage/nekox/)
|
||||
|
||||
### Adding a new language
|
||||
|
||||
First and foremost, Android must already support the specific language and locale you want to add. We cannot work with languages that Android and the SDK do not support, the tools simply break down. Next, if you are considering adding a country-specific variant of a language (e.g. de-AT), first make sure that the main language is well maintained (e.g. de). Your contribution might be useful to more people if you contribute to the existing version of your language rather than the country-specific variant.
|
||||
|
||||
Anyone can create a new language via Weblate.
|
||||
|
||||
### Adding unofficial translations for Telegram
|
||||
|
||||
Current built-in language packs:
|
||||
|
||||
* 简体中文: [moecn](https://translations.telegram.org/moecn)
|
||||
* 正體中文: [taiwan](https://translations.telegram.org/taiwan)
|
||||
* 日本語: [ja_raw](https://translations.telegram.org/ja_raw)
|
||||
|
||||
You can [open an issue to](https://github.com/NekoX-Dev/NekoX/issues/new?&template=language_request.md) request to amend the built-in translation.
|
||||
|
||||
## Credits
|
||||
|
||||
@ -143,6 +168,4 @@ Join the project at https://hosted.weblate.org/projects/nekox/
|
||||
<li>OpenCC: <a href="https://github.com/BYVoid/OpenCC/blob/master/LICENSE">Apache License 2.0</a></li>
|
||||
<li>opencc-data: <a href="https://github.com/nk2028/opencc-data">Apache License 2.0</a></li>
|
||||
<li>android-device-list: <a href="https://github.com/pbakondy/android-device-list/blob/master/LICENSE">MIT</a> </li>
|
||||
</ul>
|
||||
|
||||
[](https://hosted.weblate.org/engage/nekox/)
|
||||
</ul>
|
||||
@ -1,55 +1,62 @@
|
||||
NekoX is an third-party Telegram client, based on Telegram-FOSS with features added.
|
||||
|
||||
* Most of Nekogram's features
|
||||
* Max account limit set to 32
|
||||
* OpenCC Chinese Convert
|
||||
* Built-in Vmess, Shadowsocks, SSR proxies support
|
||||
* Built-in public proxy list / Proxy subscription support.
|
||||
* Proxies import and export, remarks, speed measurement, sorting, delete unusable nodes, etc.
|
||||
* Scan the qrcode (any link, can add a proxy).
|
||||
* The ( vemss / vmess1 / ss / ssr / rb ) proxy link in the message can be clicked.
|
||||
* Allow auto disable proxy when VPN is enabled
|
||||
* Proxy automatic switcher
|
||||
* Add stickers without sticker pack
|
||||
* Allow disable vibration
|
||||
* Allow clicking on links in self profile
|
||||
* Sticker set list backup / restore / share
|
||||
* Full InstantView translation support
|
||||
* Translation support for selected text on input and in messages
|
||||
* Delete all messages in group
|
||||
* Dialog sorting is optional "Unread and can be prioritized for reminding" etc.
|
||||
* Allow to skip "regret within five seconds"
|
||||
* Unblock all users support
|
||||
* Login via qrcode
|
||||
* Scan and confirm the login qrcode directly
|
||||
* Allow clear application data
|
||||
* Option to not send comment first when forwarding
|
||||
* 0ption to use nekox chat input menu: replace record button with a menu which contains an switch to control link preview (enabled by default)
|
||||
* Option to disable link preview by default: to prevent the server from knowing that the link is shared through Telegram.
|
||||
* Option to ignore Android-only content restrictions (except for the Play Store version).
|
||||
* OpenKaychain client ( sign / verify / decrypt / import )
|
||||
* Google Cloud Translate / Yandex.Translate support
|
||||
* Custom cache directory (supports external storage)
|
||||
* Custom AppId and Hash (optional NekoX / Andorid / Android X or Manual input)
|
||||
* Custom server (official, test DC or Manual input)
|
||||
* Keep the original file name when downloading files
|
||||
* View the data center you belong to when you don't have an avatar
|
||||
* Proxies, groups, channels, sticker packs are able to shared as qrcodes.
|
||||
* Force English emoji keywords to be loaded
|
||||
* Add "@Name" when long press @ user option
|
||||
* Enhanced notification service, optional version without Google Services.
|
||||
* Don't alert "Proxy unavailable" for non-current account
|
||||
* Option to block others from starting a secret chat with you
|
||||
* Allow create group without invite
|
||||
* Option to upgrade group to supergroup
|
||||
* Mark dialogs as read using tab menu
|
||||
* Option to hide device info
|
||||
* Improved session dialog
|
||||
* Improved link long click menu
|
||||
* Text replacer
|
||||
* Option to disable trending
|
||||
* Tgx style message unpin menu
|
||||
* Built-in Material Design themes / Telegram X style icons
|
||||
- Most of Nekogram's features
|
||||
- Max account limit set to 16
|
||||
- OpenCC Chinese Convert
|
||||
- Built-in VMess, Shadowsocks, SSR, Trojan-GFW proxies support
|
||||
- Built-in public proxy list / Proxy subscription support
|
||||
- Able to parse all proxy subscription format: SIP008, ssr, v2rayN, vmess1, shit ios app formats, clash config and more
|
||||
- Proxies import and export, remarks, speed measurement, sorting, delete unusable nodes, etc
|
||||
- Scan the QR code (any link, can add a proxy)
|
||||
- The ( vmess / vmess1 / ss / ssr / trojan ) proxy link in the message can be clicked
|
||||
- Allow auto-disabling proxy when VPN is enabled
|
||||
- Proxy automatic switcher
|
||||
- Add stickers without sticker pack
|
||||
- Allow disabling vibration
|
||||
- Allow clicking on links in self profile
|
||||
- Sticker set list backup / restore / share
|
||||
- Full InstantView translation support
|
||||
- Translation support for selected text on input and in messages
|
||||
- Delete all messages in group
|
||||
- Dialog sorting is optional "Unread and can be prioritized for reminding" etc
|
||||
- Allow to skip "regret within five seconds"
|
||||
- Unblock all users support
|
||||
- Login via QR code
|
||||
- Scan and confirm the login QR code directly
|
||||
- Allow clearing app data
|
||||
- Option to not send comment first when forwarding
|
||||
- 0ption to use nekox chat input menu: replace record button with a menu which contains an switch to control link preview (enabled by default)
|
||||
- Option to disable link preview by default: to prevent the server from knowing that the link is shared through Telegram.
|
||||
- Option to ignore Android-only content restrictions (except for the Play Store version).
|
||||
- OpenKaychain client (sign / verify / decrypt / import)
|
||||
- Google Cloud Translate / Yandex.Translate support
|
||||
- Custom cache directory (supports external storage)
|
||||
- Custom app ID and Hash (optional NekoX / Andorid / Android X or Manual input)
|
||||
- Custom server (official, test DC)
|
||||
- Keep the original file name when downloading files
|
||||
- View the data center you belong to when you don't have an avatar
|
||||
- Proxies, groups, channels, sticker packs are able to shared as QR codes
|
||||
- Force English emoji keywords to be loaded
|
||||
- Add "@Name" when long-pressing @user option
|
||||
- Enhanced notification service, optional version without Google Services
|
||||
- Don't alert "Proxy unavailable" for non-current account
|
||||
- Option to block others from starting a secret chat with you
|
||||
- Allow creation of group without invite
|
||||
- Option to upgrade group to supergroup
|
||||
- Mark dialogs as read using tab menu
|
||||
- Option to hide device info
|
||||
- Improved session dialog
|
||||
- Improved link long click menu
|
||||
- Text replacer
|
||||
- Option to disable trending
|
||||
- Telegram X style menu for unpinning messages
|
||||
- Built-in Material Design themes / Telegram X style icons
|
||||
- Enabled set auto delete timer option for private chats and private groups
|
||||
- Don't process cleanup draft events after opening chat
|
||||
- Support saving multiple selected messages to Saved Messages
|
||||
- Support unpinning multiple selected messages
|
||||
- View stats option for messages
|
||||
- And more :)
|
||||
|
||||
Anti-Feature: Non-Free Network, since the servers run proprietary software.
|
||||
The official source code of the app contains binary blobs, so this tracks a fork which builds those from source. Hence, versions might become available with a certain lag.
|
||||
Loading…
Reference in New Issue
Block a user