Skip to content

Bentheminernz/GrizzcoHandbook

Repository files navigation


Grizzco Handbook

Grizzco Handbook, the ultimate companion for Salmon Run. Created in SwiftUI it is an iOS and watchOS app! You can read up on the Grizzco Employee Handbook, learn about all different kinds of Salmonids in the Field Guide! See the current map rotation and upcoming ones! Don't have your phone? Don't sweat it! You can even see the current map rotation from your wrist.


How to build

Grizzco Handbook requires Xcode 15. If you wish to build the app yourself then follow these steps:

Prerequisites

  • macOS 14.0+
  • Xcode 15.4+
  • iOS 16.0+ Simulator Runtime
  • watchOS 10+ Simulator Runtime

Step One - Cloning the Repository

Clone the repository `git clone https://github.com/Bentheminernz/GrizzcoHandbook.git`

Step Two - Configuring the build settings

Open the project in Xcode, change the Signing Team to your own developer team and Bundle Identifier to anything. Also make sure to select a simulator or connected device from the scheme menu at the top of your Xcode window.

Step Three

To build the project, select Product -> Build from the Menu Bar or press 'CMD+B'.
To run the app on a simulator or device, select Product -> Run from the menu bar or press 'CMD+R'

Troubleshooting

If you're encountering build errors, make sure you meet and have the prerequisites. If that doesn't work try cleaning the build folder 'Cmd+Shift+K' then rebuild. If that still doesn't work then file an issue.

Contributing

  1. Fork the repository
  2. Create a new branch `git checkout -b my-branch`
  3. Make your changes
  4. Submit a pull request

Credits

Splatoon3.ink is used for fetching the current and upcoming Salmon Run stages
WhatsNewKit is used for displaying Whats New in app updates.

License

Grizzco Handbook is available on GitHub under the GNU General Public License v3.0 (GPL-3.0). See LICENSE for more details.

You are free to use, modify, and distribute this project under the terms of the GPL-3.0 license. Please ensure that any redistributed versions of this project also comply with this license.

Other tidbits

The Grizzco Handbook App for iOS and watchOS is a fan project and is not affiliated with, endorsed, or sponsored by Nintendo Co., Ltd. All trademarks and copyrights related to Nintendo's intellectual property are the property of their respective owners.