xinyanhe/save-princess

An Android game application using Java, Gradle and Android Studio

README - PROJECT SETUP

---

Instructions of how to install and play the project

Project setup instructions

• Please use Pixel 3 API 28 device.
• Please note Java SDK version 8 is required. Ensure you have upgraded before attempting to run our program!

1. Open Android Studio. Click "Check out project from Version Control" -> "Git".
2. Copy the Phase 2 Git repository link (above) into the URL box. Click "Clone".
3. Enter any MarkUs login info if prompted.
4. In the "Import Project" window, select "Import project from external model". Choose "Gradle" from the list and click "Next".
5. Set the "Gradle project:" path to Phase2/slidingtiles (inside your new project folder) and hit "OK". You should now be able to select the radio button beside "Use default gradle wrapper (recommended)". Do so and click "Finish".
6. If you receive any "Unregistered VCS root detected" message, address this by clicking "Add root". If you receive any "Unsupported Modules Detected" error, you can safely ignore it.
7. Let the project complete its build. You should now be able to run the app!

Playing the Game:

Creating Account:

If you don't have any account, please click "create account" to create one. You can create the name and password to whatever you like. Each play has their unique username. If you are trying to create a username that has been registered, you will be notified: "This username has been registered."

LogIn Account:

After creating your account, you can enter the correct username and password to get into the next page. In the next page, click "Startplay" button to go to the main page of the first game "Catch Ball".

Setting:

Setting button is on the left up corner of the screen. The player can customize by three ways.

1. Turn on night mode or not.(As the night mode on, the text color will change to adapt the background)
2. Choose a character.
3. Start play the music or pause.

The common button in these three game:

On menu page of each game:

A. New Game: Start a new game

B. Scoreboard: Scoreboard for this specific game after clicking it. The player's score will be stored on the scoreboard. Also, the scoreboard will include both Global Top scores and User Top Scores

C. Introduction: Introduction for the game

D. Quit: Quit the game, game state won't be saved. The player will go back to "Choose Game" menu.

On game page:

A. Intro: Introduction of the game. If you click the

B. Back: Return to the menu of the sepcific game.

C. Pause: Timer will stop and the game will remain its current state. The current "pause" button will change to "resume" button.

D. Resume: Timer will start, and the game will start from the state where it stops. The current "resume" button will change to "pause" button.

E. Save: Save the current game state.

F. Next: Math24: Jump to next question.

K. Return: Return to the page before

** Important Note: If the player already finish the game, and get back to the game page by clicking the phone's back button, the player will go back to previous page, with timer stopped

ScoreBoard:

A. After the game is over, a page will pop up asking the player whether want to save the score or not. There are three options: 1. Save the score, and display both username and score on scoreboard. 2. Save the score, but only display the score on scoreboard. 3. Do not save the score, and go back to the main page. B. On the scoreboard, you can choose "Main Menu" button to go back to "choose game" page.

Introduction of the game:

Game 1: Catchball

A. Game Rule: 1. Purpose of the game is to control the character's intent on eating as much as yellow or red balls as possible and watch out the booms(black stars). 2. The yellow ball values 10 points while the red ball values 30 points. 3. When the score reaches 60 points, the player will be access to the next level. 4. Level 2 increases game difficulty by increasing speed of the balls. 5. The game will end with the character collides to a boom(black stars)

Game 2: Sliding

A. Game Rule: 1. Purpose of the game is sliding cards to merge the same cards into a new pictured card that is in higher level. 2. In level 1, it's played on a 33 grid, while in level 2, it's on a 44 grid 3. Every turn, a new pictured card(##) will randomly appear in an empty spot on the board #### 4. Cards slide as far as possible in the chosen direction until they are stopped by either another card, or the edge of the grid. 5. The game will end when their is no more space for merge and sliding.

B. Please check the "Sliding intro" page for clear introduction of the pictured cards

Game 3: Math24

A. Game Rule:

1. The purpose: use the 4 numbers to get 24. Each number must and can be only used once.
2. Three lives for level 1, and one live for level 2. The player will lose a live if the result isn't 24 after clicking the equal sign.
3. The clear button can clear the letters you entered before you press the equal sign.
4. After getting a question accurate, click 'next' button to get to next question.
5. After getting three questions accurate, you will jump to level 2, which needs more complex number combinations.
6. The game will end when the player has no more lives. For level 2 specifically, if you get three questions accurate consecutively"