The following guidelines have been put in place to improve the user experience and enable a healthy growth of the community we are all part of. As a merchant you have to comply to the guidelines in order for your package to be distributed by Twickd
There are few rules and best-practices that all packages, no matter their types, should follow to suit Twickd concept.
Naming a package can be a tedious task, you often lose some precious hours trying to figure out the perfect name for your package. Thankfully the following guideline will help you narrow down your possibilities so your mind will not have to go everywhere while looking for a name.
First, your package name should be short (typically between 3 and 20 characters) and should not include any special characters, emojis, parenthesis,... For reference, Twickd will not accept any package whose name is longer than 30 characters and/or contains any other characters than alpha-numeric, spaces, and dashes.
A name should be unique, therefore make sure to search on popular platforms (i.e: r/jailbreak, iOS Repo Updates, ...), if your package name appears to be the same as someone else and we get notified about it, we are most likely to takedown your package until we find a proper solution. In that case, we will contact you to let you know why your package has been taken down and what you can do to resolve this issue.
All packages should include the recommended fields in their control files:
- Package: The original identifier of your packages (i.e: com.twickd.packagename)
- Name: The name of the package (should follow the Naming guidelines)
- Depends: The package dependencies
- Version: The package version number (Only use numeric character and dots, avoid letters as much as possible. Beta builds are typically before 1.0.0 so if you are running your package in beta version, use 0.1.0 for example)
- Architecture: To what platform the package is intended to be used (always set this value to iphoneos-arm)
- Description: A short description of your package (should not be longer than 140 characters)
- Maintainer: Who maintains the package, it could be you or someone else from your organization
- Author: The creator of the package
If your package does not include those recommended fields it will automatically be rejected upon submission with an error message letting you know which fields are missing.
The description should explain clearly how your package will affect the user's device/experience. It has to be well formatted (i.e: All caps, bold and/or in title format descriptions will result in your package being rejected) using the tools that we provide. Descriptions must only be written in plain and intelligible English, there are many resources online that will help you if needed.
The description must include all the features of your packages. It is also a great place to credit your inspirations or sources.
If your package is open-source, you are more than welcome to add the link to your source code.
Screenshots are the most important element of your package presentation page. They tremendously help the user determine if your package is what they are looking for.
Therefore, we require all the packages to have at least one screenshots.
The screenshots should clearly show how your package will affect the user's device/experience.
When it comes to screenshots, the guidelines are pretty straight forward:
- Do not use inappropriate images as your screenshots.
- Do not show the entire springboard/app if your package only affects a small portion of it.
- Try to use the best quality possible so the users have a good representation of your package.
- Be creative! This is your space to showcase your package, make the most out of it!
Open-sourcing packages, no matter its type, is a great way to build a healthier and more knowledgeable community. Twickd strongly encourages open source.
Sometimes it can be overwhelming to share the sources of your package, but there is plenty of resources online to learn how to open-source the right way.
On the other hand, when using assets or components from open-sourced resources, you must credit the author and respect the licenses they used. Twickd will systematically take down any packages that have been reported for abusing open-source licenses.
Competition is what makes us evolve as creators, but doing the same things as others has never been beneficial for anyone. If your package has the same features of an existing package, without added-value or breakthrough changes, we are most likely to reject it during the moderation process
We encourage the creator to advertise their packages on as many platforms as possible, while respecting the rules of these platforms, to get the maximum amount of exposure.
Twickd does not support paid packages.
A widget should be light-weight (typically not exceeding 5mb). You have to make sure to only include resources that you are using and properly compress your images. Most of the time the size of your package can be reduced by using fewer images and replacing them with SVG or actual code.
We will not accept any widget that sizes exceed 20mb.
Theming is an important part of the jailbreaking industry.
A maximum of 4 variants per package is allowed, typically a colored and a dark version (colored and glyph version is also a popular combination)
All the icons in a theme must follow the same design schema to form a cohesive theme.
Going along with the rule on variants, all icons must have been entirely created by you. We will not accept any package that uses third-party icon libraries (i.e: icons8, flaticon, ...) even if you own the rights to use them.
You should always consider icon requests from your users. We recommend you create a shared document or a form so users can easily submit their icon requests. Doing so will help you keep track of the icons requested by your users. A great-practice is to mention the user which submission has been accepted in the changelog of your theme. Giving them credit will help you build an enthusiastic community!
We consider tweaks that unlock premium features on third-party apps or stock iOS as piracy, therefore we judge them like so.
It is strongly recommended not to do such modifications, except for educational purposes, even if you do not plan to use Twickd to distribute your package.
These guidelines are based on an original idea by Matchstic