README.md

PF Tool

Easily import and share Polyfield maps

---

🌍 Translations

You can help translate PF Tool on Crowdin.

🦝 Shizuku support

Shizuku is an app which lets other apps elevate their permissions using wireless debugging or root access.

Shizuku method in PF Tool can be enabled or disabled anytime from settings.

Shizuku method will automatically be enabled if there is no other way for the app to access Polyfield data. The app will guide you to setup Shizuku if this mode is enabled.

🔧 Building

Using GitHub Actions

• Fork the repository
• Add environment variables required for signing from Repository settings > Secrets and variables > Actions > Repository secrets:
  • KEYSTORE_ALIAS
  • KEYSTORE_BASE64 this can be obtained using openssl base64 -in keystore.jks
  • KEYSTORE_PASSWORD
  • KEY_PASSWORD
• Enable workflows
• Trigger a build workflow and wait for it to build a release variant APK

Locally

• Clone the repository
• Add a signing config (unless you only want to build debug variant or sign manually)
• Build APK:
  • Release variant: ./gradlew assembleRelease
  • Debug variant: ./gradlew assembleDebug