mirror of
https://github.com/SideStore/SideStore.git
synced 2026-02-09 06:43:25 +01:00
bcfbe515a4
* Update README.md * change casing of SideStore * Add roxas and replace git * Additional detail for Netmuxd * fix wording this fixes the wording of Licensing and building instructions to be simplified. * Correct spelling AltStore * Forgotten S
78 lines
4.1 KiB
Markdown
78 lines
4.1 KiB
Markdown
# SideStore
|
|
|
|
> SideStore is an alternative app store for non-jailbroken iOS devices that can sideload using a VPN over the internet.
|
|
|
|
[](https://swift.org/)
|
|
[](https://www.gnu.org/licenses/agpl-3.0)
|
|
[](http://makeapullrequest.com)
|
|
|
|
SideStore is an iOS application that allows you to sideload other apps (.ipa files) onto your iOS device with just your Apple ID. SideStore resigns apps with your personal development certificate and sends them to a desktop app called AltServer or use the SideStore VPN, which installs the resigned apps back to your device using iTunes WiFi sync or using the SideStore VPN where you can sideload at any place over wifi that supports zerotier that has internet. To prevent apps from expiring, SideStore just like AltStore will also periodically refresh your apps in the background when on the same WiFi as AltServer or using SideStore VPN over wifi on any network that includes a internet connection.
|
|
|
|
The goal of this project is to allow easy and a mostly computerless experience to sideload apps on iOS based devices. This project is meant as a alternative of AltStore where you can do anything AltStore can (maybe even more) but over a vpn. You will be able to use SideStore just like if you were using AltStore with benifits.
|
|
(contributions welcome! 🙂).
|
|
|
|
|
|
## Requirements
|
|
- Xcode 11
|
|
- iOS 12.2+ (SideStore)
|
|
- macOS 10.14.4+ (TBD)
|
|
- Swift 5+
|
|
- Visual Studio Code
|
|
|
|
## Project Overview
|
|
|
|
### SideStore
|
|
SideStore is a alternative to AltStore and is a sandboxed iOS application like AltStore. The SideStore app target contains the vast majority of AltStore's functionality, including all the logic for downloading and updating apps through SideStore.
|
|
|
|
### Netmuxd
|
|
Netmuxd is a program that replaces Usbmuxd to be able to connect over a VPN reliably. It is programmed in the Rust programming language and it is open source. You can set Netmuxd to be a hyper link like Netmuxd: [Netmuxd](https://github.com/jkcoxson/netmuxd)
|
|
|
|
### Roxas
|
|
Roxas is Riley Testut's internal framework from AltStore used across many of their iOS projects, developed to simplify a variety of common tasks used in iOS development. For more info, check the [Roxas repo](https://github.com/rileytestut/roxas).
|
|
|
|
## Compilation Instructions
|
|
AltStore and AltServer are both fairly straightforward to compile and run if you're already an iOS or macOS developer. To compile AltStore and/or AltServer:
|
|
|
|
1. Clone the repository
|
|
```
|
|
git clone https://github.com/SideStore/SideStore.git
|
|
```
|
|
2. Update submodules:
|
|
```
|
|
cd AltStore
|
|
git submodule update --init --recursive
|
|
```
|
|
3. Open `AltStore.xcworkspace` and select the AltStore project in the project navigator. On the `Signing & Capabilities` tab, change the team from `Yvette Testut` to your own account.
|
|
|
|
5. **(SideStore app only)** Change the value for `ALTDeviceID` in the Info.plist to your device's UDID. Normally, SideStore embeds the device's UDID in AltStore's Info.plist during installation. When running through Visual Studio you'll need to set the value yourself or else SideStore won't resign (or even install) apps for the proper device. You can achieve this by changing a few things to be able to build and use SideStore.
|
|
|
|
**Steps for making SideStore run with your own build**
|
|
This is all in vscode because Xcode UI is tricky
|
|
|
|
AltBackup/AltBackup.entitlements
|
|
Change the app group to something you can sign like group.com.[Rick].SideStore
|
|
|
|
AltStore/AltStore.entitlements
|
|
Same thing ^^
|
|
|
|
AltWidget/AltWidgetExtension.entitlements
|
|
Same thing ^^
|
|
|
|
AltWidget/Info.plist
|
|
Change ALTAppGroups to your group
|
|
|
|
AltStore/Info.plist
|
|
Change ALTAppGroups to your app group name group.com.[Rick].SideStore
|
|
|
|
AltStore/project.pbxproj
|
|
Change all the PRODUCT_BUNDLE_IDENTIFIERs to something you can sign like com.[Rick].SideStore...
|
|
|
|
Shared/Extensions/Bundle+AltStore.swift
|
|
Change the string "group.com.rileytestut.AltStore" to your group you are using.
|
|
|
|
Build + run app! 🎉
|
|
|
|
## Licensing
|
|
|
|
This project is licensed under the **AGPLv3 license**.
|