FAQ - dreulavelle/rank-torrent-name GitHub Wiki

Frequently Asked Questions for Ranking Settings

Q: What is the "profile" setting used for?

A: The profile setting allows you to name your configuration. It's useful when you have multiple settings profiles for different use cases. There are also some pre-set profiles you can use, which are default, and best.

  • default: This is the default profile and is setup for streaming, it excludes remuxes, and limits to 1080p and 720p. This profile is great for those that don't wish to transcode.
  • best: This will try and find the highest quality torrents available, this is the most restrictive.

[!NOTE] Profiles are still subject to the fetch settings, so if a torrent is not fetch enabled, it will not be processed, regardless of profile settings!

Q: How do I use the "require" setting?

A: The "require" setting lets you specify patterns that must be present in a torrent name for it to be considered. These patterns can be simple strings or regular expressions. For example:

  • To only consider 1080p content: require = ["1080p"]
  • To require a year between 2020 and 2023: require = [r"\b202[0-3]\b"]

Q: What does the "exclude" setting do?

A: The "exclude" setting allows you to specify patterns that, if present in a torrent name, will cause that torrent to be ignored. You can use regex for more complex exclusions. For instance:

  • To exclude all CAM releases: exclude = ["CAM"]
  • To exclude releases with "LQ" or "LOW QUALITY" in the name: exclude = [r"LQ|LOW.?QUALITY"]

Q: How does the "preferred" setting work?

A: The "preferred" setting lets you specify patterns that, if present, will give a torrent a higher priority in ranking. Regex can be used for more flexible matching. For example:

  • To prefer BluRay releases: preferred = ["BluRay"]
  • To prefer releases from specific groups: preferred = [r"(SPARKS|AMIABLE|GECKOS)$"]

Resolution Settings

Q: How do I control which resolutions are accepted?

A: The "resolutions" setting allows you to specify which resolutions you want to accept. Set the value to True for resolutions you want to include, and False for those you want to exclude.

Language Settings

Q: How do I set my language preferences?

A: The "languages" setting has three sub-settings:

  • required: List 2-character language codes that must be present.
  • exclude: List 2-character language codes you don't want.
  • preferred: List 2-character language codes you prefer.

Example: ["es", "de", "fr", "ja"]

Note

All language preferences use ISO 639-1 two-letter language codes.

Options Settings

Q: What does the "title_similarity" option do?

A: The title_similarity option (default 0.85) sets how closely a torrent's title must match the expected title. A higher value (closer to 1.0) requires a more exact match.

Q: What is the "remove_all_trash" option?

A: When set to True, the remove_all_trash option (default True) automatically filters out torrents considered low quality or "trash" based on predefined criteria.

This excludes torrents with indicators of poor quality or undesirable sources, such as:

  • CAM, TS (TeleSYNC), TC (TeleCINE) releases
  • Screener or SCR versions
  • Pre-DVD releases
  • DVB-Rip and SAT-Rip sources
  • R5/R6 releases
  • Leaked versions
  • Deleted scenes
  • HQ audio cleanups

For more information on the trash regex, see Parsett Trash Regex. These filters help ensure that only higher quality releases are considered, improving the overall quality of your media collection.

Q: How does the "remove_ranks_under" option work?

A: The remove_ranks_under option (default -10000) sets a minimum rank threshold. Torrents ranked below this value will be excluded from results.

[!NOTE] Bonus tip! If you want to exclude torrents that don't get ranked or have a negative rank, you can set this to 0. Ensuring you only get positive ranked torrents in your results.

Q: What does "remove_unknown_languages" do?

A: When set to True, the remove_unknown_languages option (default False) will exclude torrents that don't have a language in the title.

Q: What is the purpose of "allow_english_in_languages"?

A: The allow_english_in_languages option (default False), when set to True, allows English language torrents to be included even if a user has excluded English from their language preferences. This can be useful for users who want to prioritize content in specific languages but still want access to English-language releases if they're available alongside their preferred languages. It essentially bypasses the language exclusion for English, ensuring that multilingual torrents containing English aren't filtered out due to strict language settings.

One scenario is if you wanted a movie that's released in Spanish, and you excluded the Spanish language, but you still want to include it if it's in English as well. This setting works great for Anime as well that you want to include if it's in English as well.

Custom Ranks

Q: How do I use custom ranks?

A: Custom ranks allow you to assign specific values to various attributes of torrents.

  • fetch (boolean) is used to determine if it should be picked up or not.
  • use_custom_rank (boolean) is used to enable/disable the custom rank.
  • rank (integer) is used to set its importance.

Ranks are additive, so a higher rank will be prioritized over a lower rank. You can use this to your advantage to fine tune the torrents that are picked up.

Note

You can set a negative rank to subtract from the overall rank. This is useful if you want to ignore certain torrents. Example: -100 will be subtracted from the overall rank.

Q: Can I prioritize certain audio or video codecs?

A: Yes! In the custom_ranks section, you can adjust the rank values for different codecs. Higher rank values will be prioritized.

Remember, these settings allow you to fine-tune RTN to your specific preferences. Don't be afraid to experiment with different configurations to find what works best for you!

⚠️ **GitHub.com Fallback** ⚠️