Skip to content

Cross-platform schedule and battle statistic client of Splatoon 3.

License

Notifications You must be signed in to change notification settings

zhxie/conch-bay

Repository files navigation

Conch Bay

Due to Nintendo's continued negative attitude towards 3rd party apps, you should use Conch Bay at your own risk.

Conch Bay is a cross-platform schedule and battle statistic client for Splatoon 3.

You can test the beta app on iOS via TestFlight, or download the unsigned beta APK from Pre-release.

Build

Ensure you have node, yarn, expo-cli, eas-cli and OS-related build tools installed. To build a deployable app, sign the package with valid certificates.

yarn

# Build the development build.
eas build --local --platform <ios|android> --profile development
# Run with the development build.
yarn start
# Build the native app.
eas build --local --platform <ios|android> --profile <production|internal|preview>

FAQs

Import data from s3s

Run the following command to merge all outputs into conch-bay-import.zip, then import it into Conch Bay.

python3 tools/convert_s3s_outputs.py <PATH_TO_S3S>

Import Salmon Run data from stat.ink

Since many fields in stat.ink Salmon Run JSON are missing, importing Salmon Run data from stat.ink is not recommended.

Run the following command to convert stat.ink Salmon Run JSON into conch-bay-import.zip, then import it into Conch Bay. Notice that some fields (ID, banners and badges in Splashtags, etc.) were missing when uploaded to stat.ink which will be replaced with dummy data.

python3 tools/convert_stat_ink_salmon_run_json.py <PATH_TO_EXTRACTED_STAT_INK_SALMON_RUN_JSON>

Import data from ikawidget3

Run the following command to convert data from an ikawidget3 database IKAX3 into conch-bay-import.zip, then import it into Conch Bay. Notice that some information may not be accurate since IKAX3 contains encrypted data.

python3 tools/convert_ikax3.py <PATH_TO_IKAX3>

Import data from salmdroidNW

Run the following command to convert data from a salmdroidNW backup into conch-bay-import.zip, then import it into Conch Bay.

python3 tools/convert_salmdroidnw_backup.py <PATH_TO_SALMDROIDNW_BACKUP>

Import data from Salmonia3+

Run the following command to convert data from a Salmonia3+ backup into conch-bay-import.zip, then import it into Conch Bay. Notice that some information may be missing since the Salmonia3+ backup does not contain all the data of results.

python3 tools/convert_salmonia3+_backup.py <PATH_TO_SALMONIA3+_BACKUP>

Rescue data from a Conch Bay database

Run the following command to convert data from a Conch Bay database into conch-bay-import.zip, then import it into Conch Bay.

python3 tools/convert_db.py <PATH_TO_DB>

Validate data

Run the following command to validate a results ZIP.

python3 tools/validate.py <PATH_TO_ZIP>

Export data to s3s and upload to stat.ink

Run the following command to convert a results ZIP into s3s outputs and upload to stat.ink.

python3 tools/export_s3s_outputs.py <PATH_TO_ZIP>
python3 <PATH_TO_S3S>/s3s.py -i exports/results exports/overview.json
python3 <PATH_TO_S3S>/s3s.py -i exports/coop_results exports/overview.json

License

Conch Bay is licensed under the MIT License.

Acknowledgments

Conch Bay uses API from Splatoon3.ink for schedules and shifts, APIs from imink f API and nxapi znca API for account authorization and Nintendo app versions for API version updates.

Conch Bay uses splat3 for data mapping and Nintendo app versions for API version updates in build time.

Conch Bay uses Splatoon3.ink for images and splat3 for data mapping in data converters.

Conch Bay uses sendou.ink Build Analyzer and splat.top as external tools.

Special thanks to Splatoon-related open source pioneers including s3s and s3si.ts, and all open source components listed in the OSS Licenses.

About

Cross-platform schedule and battle statistic client of Splatoon 3.

Resources

License

Stars

Watchers

Forks

Packages

No packages published