Contributing to SideStore

Thank you for your interest in contributing to SideStore! SideStore is a community driven project, and it's made possible by people like you.

By contributing to this Project (SideStore), you agree to the Developer's Certificate of Origin found in CERTIFICATE-OF-ORIGIN.md. Any contributions to this project after the addition of the Developer's Certificate of Origin are subject to its policy.

There are many ways to contribute to SideStore, so if you aren't a developer, there are still many other ways you can help out:

Writing documentation
Submitting detailed bug reports and suggesting new features
Helping out with support
- Discord
- GitHub Discussions

However, this guide will focus on the development side of things. For now, we will only have setup information here, but you can join our Discord if you need help after setup.

Requirements

This guide assumes you:

are on a Mac
have Xcode installed
have basic command line knowledge (know how to run commands, cd into a directory)
have basic Git knowledge (GitHub Desktop is a great tool for beginners, and greatly simplifies working with Git)
have basic Swift/iOS development knowledge

Setup

Fork the SideStore repo on GitHub.
Clone the fork: git clone https://github.com/<your github username>/SideStore.git --recurse-submodules

If you are using GitHub Desktop, refer to this guide.
Copy CodeSigning.xcconfig.sample to CodeSigning.xcconfig and fill in the values.
(Development only) Change the value for ALTDeviceID in the Info.plist to your device's UDID. Normally, SideServer embeds the device's UDID in SideStore's Info.plist during installation. When running through Xcode 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.
Finally, open AltStore.xcodeproj in Xcode.

Next, make and test your changes. Then, commit and push your changes using git and make a pull request.

Prebuilt binary information

minimuxer and em_proxy use prebuilt static library binaries built by GitHub Actions to speed up builds and remove the need for Rust to be installed when working on SideStore. SideStore/fetch-prebuilt.sh will be run before each build by Xcode, and it will check if the downloaded binaries are up-to-date once every 6 hours. If you want to force it to check for new binaries, run bash ./SideStore/fetch-prebuilt.sh force.

Building with Xcode

Install cocoapods if required using: brew install cocoapods
Now using commandline on the repository workspace root, perform Pod-Install using: pod install command to install the cocoapod dependencies.
After this you can do regular builds within Xcode.

Building an IPA for distribution

You can then use the Makefile command: make build fakesign ipa in the root directory.
By default the config for build is: Release
For debug builds: export BUILD_CONFIG=Debug;make build fakesign ipa in the root directory.
For alpha/beta builds: export IS_ALPHA=1; or export IS_BETA=1; before invoking the build command.
This will create SideStore.ipa.

Examples: 

    # cocoapods
    brew install cocoapods
    # perform installation of the pods
    pod install

    # alpha release build
    export IS_ALPHA=1;make build fakesign ipa
    # alpha debug build
    export IS_ALPHA=1;export BUILD_CONFIG=Debug;make build fakesign ipa

    # beta release build
    export IS_BETA=1;make build fakesign ipa
    # beta debug build
    export IS_BETA=1;export BUILD_CONFIG=Debug;make build fakesign ipa

    # stable release build
    make build fakesign ipa
    # stable debug build
    export BUILD_CONFIG=Debug;make build fakesign ipa

By default sidestore will build for its default bundleIdentifier com.SideStore.SideStore but if you need to set a custom bundleID for commandline builds, once can do so by exporting BUNDLE_ID_SUFFIX env var

    # stable release build
    export BUNDLE_ID_SUFFIX=XYZ0123456;make build fakesign ipa
    # stable debug build
    export BUNDLE_ID_SUFFIX=XYZ0123456;export BUILD_CONFIG=Debug;make build fakesign ipa

NOTE: When building from XCode, the BUNDLE_ID_SUFFIX is set by default with the value of DEVELOPMENT_TEAM

This can be customized by setting/removing the BUNDLE_ID_SUFFIX in overriding CodeSigning.xcconfig created from CodeSigning.xcconfig.sample

Warning

The binary created will contain paths to Xcode's DerivedData, and if you built minimuxer on your machine, paths to $HOME/.cargo. This will include your username. If you want to keep your user's username private, you might want to get GitHub Actions to build the IPA instead.

Developing minimuxer alongside SideStore

Please see minimuxer's README for development instructions.

5.6 KiB Raw Blame History