From 04d689907adf2bad1a3b85088e173463c0fac710 Mon Sep 17 00:00:00 2001 From: Kasherpete <119694008+Kasherpete@users.noreply.github.com> Date: Wed, 27 Sep 2023 21:08:53 -0500 Subject: [PATCH] Update README.md --- README.md | 37 +++++++++++++++++++++++++++---------- 1 file changed, 27 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d5c9597..359710b 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,36 @@ # Overview This is the Pypush sms-registration branch. This branch allows you to register your phone number to your Apple account as an iMessage alias. -### Info sms-registration is not fully developed yet, and still contains bugs! If you encounter any sort of bug, please join [our Discord](https://discord.gg/BtSbcExKJ9), however please note we cannot get to everyone, so try to figure out any errors yourself before asking. +***Please note:*** You will have to use a client to send messages from your phone. We recommend [Beeper](https://www.beeper.com/), which is the best solution to keep all your chat apps inside one place, including iMessage! You can also use [BlueBubbles](https://www.beeper.com/) (which requires you to have a server Mac running 24/7) or [Sunbird](https://www.sunbirdapp.com/) (which is closed source and requires you to be a beta tester). Beeper is completely free and easy to use, and comes packed with multiple features that reivals native apps. Beeper is currently in the process of removing the waitlist, so you will have to use an invite link shared to you in order to skip the waitlist until this change is made. + # Installation -You will first install Pypush onto your machine. *Please keep in mind that you will have to have a script running on a home server or PC 24/7 to keep your number active!* +You will first install Pypush onto your machine. *Please keep in mind that you will have to have a script running on a home server or PC 24/7 to keep your number active! See below for instructions.* ### PNRgateway -In order for Apple to verify your number, a specialized message has to be sent from your phone to Apple's "gateway number" and have the response captured. This number is different for each carrier, however the newest app version should automatically find your gateway number. +In order for Apple to verify your number, a specialized message has to be sent from your phone to Apple's "gateway number" and have the response captured. This number is different for each carrier, however the newest app version should automatically find your gateway number. If PNRgateway cannot find your gateway number, see below for help. 1. Enable USB debugging/ADB on your phone. There are multiple online guides that guide you through this based on your phone. 2. Install the APK. The message link containing the APK is located [here](https://discord.com/channels/1130633272595066880/1145177252015915080/1153070972090470481), and the GitHub repository is [here](https://github.com/JJTech0130/PNRGatewayClientV2). -3. Connect your phone to the same WiFi network as your host PC, and open the app. +3. Grant SMS permissions. This will be in the app info page, and on the newer version, there should be a button in the app that does this for you. +4. Connect your phone to the same WiFi network as your host PC, and open the app. ### Pypush -Make sure you have Git and Python installed. +Make sure you have git and Python installed. 1. `git clone -b sms-registration https://github.com/beeper/pypush` -2. `cd pypush` && `python3 -m pip install -r requirements.txt` +2. `cd pypush` , `python3 -m pip install -r requirements.txt` # Number Registration -1. `python3 demo.py --phone [ip]`. Replace `ip` with your phone's local IP. +1. `python3 demo.py --phone [ip]`. Replace `ip` with your phone's local IP. *(Usually this starts with `192.168.x.x`, however it can also start with `172` or `10`.)* 2. If the previous ran successfully, you can now run `python3 demo.py --reregister` -***Please note:*** This last script is the script you will be running continuously. We recommend every 30 minutes. There should also be a file called `reregister.py`, if you run this it should reregister you every 30 minutes. +***Please note:*** This last script is the script you will be running continuously. We recommend every 30 minutes. + +### Automatic registration +There should also be a file called `reregister.py`, if you run this it should reregister you every 30 minutes. You can edit this file to rerun at any other interval. You can also use a cronjob to do this task for you in a more streamlined way if you are more familiar with IT. ### Good to Know @@ -45,9 +50,21 @@ This means the app crashed or could not parse the response data from the gateway ### Failed to resolve host This error occurs when you are not connected to the same network, the all is closed, or you are not using the correct IP. -If you encounter any other errors, please try to find answers online for help. +### Automatic gateway detection failed +This is because PNRgateway could not detect the correct gateway corresponding to your carrier. Please report this issue if you find it. To fix this issue, when you are on step 1 of number registration, append `--gateway [number]` after the `--ip` argument, and replace `number` with the gateway number. *(You can find your gateway number [here](https://discord.com/channels/1130633272595066880/1130990221920575618/1154069380699791470))* + +### Failed to load the dynamic library +This is a Unicorn error. We do not yet know exactly what causes this error, but on MacOS try to run `sudo brew install unicorn`. This error usually occurs in MacOS VMs. + +### Failed to register +Delete `config.json` and retry. + +**If you encounter any other errors, please try to find answers online for help.** # Resources - [IDS and APNs error codes](https://discord.com/channels/1130633272595066880/1130990221920575618/1153062573533577246) - [Rustpush](https://github.com/TaeHagen/rustpush) -- [PNRgateway repo](https://github.com/JJTech0130/PNRGatewayClientV2) \ No newline at end of file +- [PNRgateway repo](https://github.com/JJTech0130/PNRGatewayClientV2) +- [Carrier gateway list](https://discord.com/channels/1130633272595066880/1130990221920575618/1154069380699791470) +- [Beeper install](https://www.beeper.com/download) +- [Beeper signup](https://airtable.com/appSlLTU0QBt8EBZ2/shrYWTCBhNCUKU9iv)