5 Clues | iOS Guess the Word Game Application

Introduction

Please carefully read this guide in order to fully configure this template, and remember to test it on a Real Device – the iOS Simulator may fail or not work properly.

Quick Start

You may just run this app on your own device via Xcode and play with it, it will work.
Anyway you need to customize this app into your own version, so just keep reading this guide.

General

Xcode

This template has a native Apple Swift code, so you can edit it only with Xcode running on a Mac computer. If you don’t have it, download it for free on the Mac App Store.

PLEASE NOTE that you’ll need the latest official version of XcodeNO BETAS, because Betas are always buggy and never work properly.

App Name and Bundle ID

You must change the Display Name and Bundle Identifier into the new ones in the General tab in Xcode: 

Archive App for App Store Publishing

Once your app is ready to be submitted to the App Store for review, you need to Archive your Xcode project.
Click on Product and select Archive. Xcode will archive your project and automatically open the Organizer window, where you’ll find a button to submit your binary to your App Store Connect account.

Reskin the UI design of the app

This project has a Storyboard file called Main.storyboard and you can find it in the list of file that is shown in left-side panel of the Xcode window.
You can edit all the UI elements of this app from the Storyboard, Colors, Fonts, Buttons, Views positions, etc.

The strings of the Alert Controllers are located in the code, so they can be edited only in the .swift files.

The images are stores into the Assets.xcassets folder.

Configurations

The Configurations.swift file

Open this file in Xcode and keep reading this guide, you’ll have to perform some edits in this file in order to get your template ready to run:

App Name

Replace this string with the new name you want to give to this app:

let APP_NAME = "5 Clues"

AdMob Ads

Replace the string of the variable below with your own Banner Unit ID – you have to create such Unit ID on apps.admob.com, just follow the instructions on the AdMob’s website in case you don’t know how to generate a Unit ID:

let ADMOB_BANNER_UNIT_ID = "ca-app-pub-3940256099942544/6300978111"

You also have to replace the string into Info.plist with your own App ID:

You can get both App ID and Unit ID strings from your AdMob Unit page, after creating it:

Sometimes Apple reviewers reject apps because of Ads, the reason why is not clear yet, but a new submission on the App Store will fix the problem and get your app approved – just in case you’ll get a rejection because of IDFA issue.
Anyway, after clicking the Submit For Review button on the App Store Connect page of your application, you’ll get something that looks like the picture below. Mark the options shown below and everything should go smoothly on the next review you’ll get of your app:

Custom Colors

You can edit the HEX values of the following variables as you wish, change the numbers before # symbol. The main color of the app and some UI will be affected by your change:

let DARK_COLOR = hexValue("#333333")
let LIGHT_COLOR = hexValue("#e1e1e1")

PLEASE NOTE that NOT all Views in the app will change accordingly to the new RGB values you’ve set in the above variable, you will still need to adjust some colors in some Controllers in the Storyboard.

Custom fonts

This App uses some custom font, which is stored in the Poppins folder.
In case you want to add a new font, you have to first drag your .ttf or .otf font file into the left-side panel in Xcode and click the Finish button in the popup that will show up:

Then select the Label, Button, TextFiled or textView you want to change font to, click the [T] icon on the right-side Attributes inspector panel and select the font you want in the dropdown list:

App Store link

You have to get the ID of your app from the App Store Connect page of your application – you can get it while preparing it for Review. Replace XXXXXXXXXX with your own App ID (get it on https://appstoreconnect.apple.com) :

let APP_STORE_LINK = "http://itunes.apple.com/app/id" + "XXXXXXXXXX"

Sound clips

There’s a folder in Xcode called Sounds which contains a few .wav files, you may replace those sound clips with other .wav files, just don’t rename them, name your new sound files like the existing ones and replace the existing ones with your new ones, so you won’t have to edit a single line of code.

List of Clues

The following array is a list of clues. You can edit/add elements as you wish, just remember that you must type them lowercase and 5 words/row:

let clues = [
    "croissant, juice, coffee, toast, morning", // position 0
    "flowers, union, ceremony, present, rings", // position 1
    "note, crisis, security, deposit, vault",   // position 2
    "glasses, window, thoughts, conscience, water", // etc...
    "traffic, force, cuffs, weapons, order",
    "injury, patient, building, beds, doctors",
    "writing, seal, character, alphabet, symbol",
    "drinks, solid, music, stone, sway",
    "alcohol, ghost, essence, energy, soul",
    
    // Add more clues here...
]

List of Answers

The following array is a list of answers. You can edit/add elements as you wish, all lowercase words. Keep in mind that their position must be the same as their relative clue in the above array:

let answers = [
    "breakfast", // position 0
    "wedding",   // position 1
    "bank",      // position 2
    "clear",     // etc..
    "police",
    "hospital",
    "letter",
    "rock",
    "spirit",
    
    // Add more answers here...
]

Multi-language translations

As you may notice, this template supports the multi-language system and it includes am Italian.strings file with all translations from English, included the Clues and Answers of the above arrays.
If the player’s device language is set to Italian, for instance, clues and answers will show the translations fro the Italian.strings file, otherwise the language will be in English.

If you want to add a new language, you need to do the following:

1. Enter the Info tab of the PROJECT element in Xcode, click the + button and select a new language from the list:

2. Select the Main.storyboard row and click the Finish button:

3. Click File -> New -> File... and select a Strings file. In the popup window, name that new file like the language name you selected and save it:

4. Copy all the strings from the Italian.strings file and paste them into the new .strings file you’ve just created, then simply edit the Italian translations into the new language of your choice.
Example: You created a Spanish.strings file, so the first 2 translations should look like this:

 "CONTINUE" = "CONTINUAR";
 "PLAY" = "JUGAR";
 and so on...

5. In the Home.swift file, add the 2-digit string of your new language in the IF statement below.
Example: If you’ve added the Spanish language, the && IF stamemernt should look like this:

 if deviceLanguageCode != "en"
 && deviceLanguageCode != "it"
 // You can add other && IF statements here, based on the .strings files you've created for translations
 && deviceLanguageCode != "es" // <-- THIS IS THE NEW LANGUAGE YOU'VE ADDED!

 { deviceLanguageCode = "en" }

Utility Functions

Unless you’re an experienced developer, DO NOT EDIT the code below this comment, otherwise the app won’t work properly:

 // ------------------------------------------------
 // MARK: - UTILITY FUNCTIONS
 // ------------------------------------------------

F.A.Q.

What kind of support is offered?

Free support is offered in case of bugs encountered in the original template, either in the code or the UI design.
In case you have edited the code – and so created bugs because of your editing – I may apply some fee to fix your bugs by a remote connection through AnyDesk, or by you sending me your source code for verification.

Should I use Xcode to edit this template?

Yes, you must always use the latest stable official version of Xcode to edit this application.
Download the latest version on the Mac App Store from your Mac.

I’ve performed all configurations mentioned in this Guide, but something is wrong. What should I do?

• Double-check all your configurations, probably you have missed something.
• Always check the Console log in Xcode if the app crashes.
The Console log helps to debug your app, it’s really important.

How do I remove AdMob ads?

It’s super easy, just comment – or delete – the following line of code into GameBoard.swift file:

fireInterstitialAd()

Support | Contact