Snake-Game

Final Project for OOP

Name: Riski Ilyas
NRP : 5025211189

Reference: https://www.youtube.com/watch?v=bI6e6qjJ8JQ&t=1532s

Description

This project is a simple GUI game called Snake Game. This game has 10 levels that needs to be completed and each level has different diffculties and obstacles. There is also Casual Mode to play the game with no obstacles. There is also a Highscore that records your top score in each Casual Game. Besides the gameplay, it also has Settings with multiple options such as Changing Player Name, Turn On/Off Music, Turn On/Off SFX, & Reset Game. All the settings data will be stored in an external file so that the game still remember the data even when the Game has Closed.

Screenshots

To-do

• Casting/Conversion (Casting GameMusic)

  Snake-Game/src/main/java/sound/SoundManager.java

  Line 33 in df0c463

  GameMusic gameMusic = (GameMusic) sounds.get(GAME_MUSIC);

• Constructor (Constructors for each screen)

  Snake-Game/src/main/java/screens/GameScreen.java

  Line 42 in df0c463

  public GameScreen(ScreenRouter screenRouter, SoundManager soundManager, DataStore dataStore) {

  Snake-Game/src/main/java/screens/LevelScreen.java

  Line 27 in df0c463

  public LevelScreen(ScreenRouter screenRouter, SoundManager soundManager, DataStore dataStore) {

  Snake-Game/src/main/java/screens/MenuScreen.java

  Line 28 in df0c463

  public MenuScreen(ScreenRouter screenRouter, SoundManager soundManager, DataStore dataStore) {

  Snake-Game/src/main/java/screens/SettingsScreen.java

  Line 26 in df0c463

  public SettingsScreen(ScreenRouter screenRouter, SoundManager soundManager, DataStore dataStore) {

• Overloading (Overloading at screenRouter to route to gamescreen)

  Snake-Game/src/main/java/screens/ScreenRouter.java

  Lines 35 to 42 in df0c463

  	public void route(ScreenState state) {
  	screenState.setValue(state);
  	}
  	public void route(LevelState levelState) {
  	this.levelState = levelState;
  	screenState.setValue(ScreenState.GAME);
  	}

• Encapsulation (Observable encapsulation on DataStore)

  Snake-Game/src/main/java/utils/DataStore.java

  Lines 18 to 22 in df0c463

  	private final Observable<Boolean> isMusicOn = new Observable<>(true);
  	private final Observable<Boolean> isSfxOn = new Observable<>(true);
  	private final Observable<String> playerName = new Observable<>("Player 1");
  	private final Observable<Integer> currentLevel = new Observable<>(1);
  	private final Observable<Integer> highscores = new Observable<>(0);

  Snake-Game/src/main/java/utils/DataStore.java

  Lines 64 to 66 in df0c463

  	public Observable<Boolean> getMusicObservable() {
  	return isMusicOn;
  	}

  Snake-Game/src/main/java/utils/DataStore.java

  Lines 73 to 75 in df0c463

  	public Observable<Boolean> getSfxObservable() {
  	return isSfxOn;
  	}

  Snake-Game/src/main/java/utils/DataStore.java

  Lines 82 to 84 in df0c463

  	public Observable<String> getPlayerNameObservable() {
  	return playerName;
  	}

  Snake-Game/src/main/java/utils/DataStore.java

  Lines 91 to 93 in df0c463

  	public Observable<Integer> getCurrentLevelObservable() {
  	return currentLevel;
  	}

• Inheritance (Inheritance on Buttons)

  Snake-Game/src/main/java/components/Button.java

  Line 5 in df0c463

  public class Button extends ImageIcon {

  Snake-Game/src/main/java/components/BackButton.java

  Line 3 in df0c463

  public class BackButton extends Button {

  Snake-Game/src/main/java/components/MenuButton.java

  Line 5 in df0c463

  public class MenuButton extends Button {

• Polymorphism (Level polymorphism on GameScreen)

  Snake-Game/src/main/java/screens/GameScreen.java

  Line 38 in df0c463

  private Level playingLevel;

  Snake-Game/src/main/java/screens/GameScreen.java

  Lines 226 to 240 in df0c463

  	private void getLevel(LevelState levelState) {
  	switch (levelState) {
  	case L1 -> playingLevel = new Level1();
  	case L2 -> playingLevel = new Level2();
  	case L3 -> playingLevel = new Level3();
  	case L4 -> playingLevel = new Level4();
  	case L5 -> playingLevel = new Level5();
  	case L6 -> playingLevel = new Level6();
  	case L7 -> playingLevel = new Level7();
  	case L8 -> playingLevel = new Level8();
  	case L9 -> playingLevel = new Level9();
  	case L10 -> playingLevel = new Level10();
  	case CASUAL -> playingLevel = null;
  	}
  	}

• ArrayList (Arraylist for Linsteners on Observable)

  Snake-Game/src/main/java/utils/Observable.java

  Line 8 in df0c463

  private final ArrayList<OnValueChangedListener<V>> listeners;

• Exception Handling (Exception Handling on DataStore)

  Snake-Game/src/main/java/utils/DataStore.java

  Lines 29 to 44 in df0c463

  	private void getData() {
  	try {
  	Scanner dataScanner = new Scanner(data);
  	while (dataScanner.hasNextLine()) {
  	String[] keyValue = dataScanner.nextLine().split(":");
  	switch (keyValue[0]) {
  	case IS_MUSIC_ON -> isMusicOn.setValue((Integer.parseInt(keyValue[1]) == 1));
  	case IS_SFX_ON -> isSfxOn.setValue((Integer.parseInt(keyValue[1]) == 1));
  	case PLAYER_NAME -> playerName.setValue(keyValue[1]);
  	case CURRENT_LEVEL -> currentLevel.setValue(Integer.valueOf(keyValue[1]));
  	case HIGHSCORE -> highscores.setValue(Integer.valueOf(keyValue[1]));
  	}
  	}
  	dataScanner.close();
  	} catch (Exception ignored) {}
  	}

• GUI (Java Swing)

  Snake-Game/src/main/java/GameFrame.java

  Lines 6 to 22 in df0c463

  	public class GameFrame extends JFrame {
  	public GameFrame() {
  	DataStore dataStore = new DataStore();
  	ScreenRouter screenRouter = new ScreenRouter(this, dataStore);
  	this.setTitle("Snake");
  	this.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
  	this.setResizable(false);
  	this.pack();
  	this.setLocationRelativeTo(null);
  	this.setVisible(true);
  	dataStore.getPlayerNameObservable().observe((name) -> {
  	this.setTitle("Snake Game " + ((name.isBlank()) ? "" : ("(" + name + ")")));
  	});
  	}
  	}

• Interface (Interface for callback on Observable)

  Snake-Game/src/main/java/utils/Observable.java

  Lines 30 to 32 in df0c463

  	public interface OnValueChangedListener<V> {
  	void onValueChanged(V value);
  	}

• Abstract Class (Abstract class for Screen and Level)

  Snake-Game/src/main/java/screens/Screen.java

  Lines 7 to 19 in df0c463

  	public abstract class Screen extends JPanel {
  	protected ScreenRouter screenRouter;
  	protected SoundManager soundManager;
  	public Screen(ScreenRouter screenRouter, SoundManager soundManager) {
  	this.screenRouter = screenRouter;
  	this.soundManager = soundManager;
  	}
  	public abstract void stopScreen();
  	public abstract void startScreen();
  	}

• Generics (Pair Class)

  Snake-Game/src/main/java/utils/Pair.java

  Lines 3 to 20 in df0c463

  	public class Pair<F, S> {
  	public F first;
  	public S second;
  	public Pair(F first, S second) {
  	this.first = first;
  	this.second = second;
  	}
  	public boolean compareWith(Pair<F,S> anotherPair) {
  	return first == anotherPair.first && second == anotherPair.second;
  	}
  	public Pair<F, S> copy() {
  	return new Pair<>(first, second);
  	}
  	}

• Collection (Hashmap on SounManager)

  Snake-Game/src/main/java/sound/SoundManager.java

  Line 11 in df0c463

  private final HashMap<SoundState, Sound> sounds = new HashMap<>();

• Input Output (I/O for the dataStore)

  Snake-Game/src/main/java/utils/DataStore.java

  Lines 29 to 62 in df0c463

  	private void getData() {
  	try {
  	Scanner dataScanner = new Scanner(data);
  	while (dataScanner.hasNextLine()) {
  	String[] keyValue = dataScanner.nextLine().split(":");
  	switch (keyValue[0]) {
  	case IS_MUSIC_ON -> isMusicOn.setValue((Integer.parseInt(keyValue[1]) == 1));
  	case IS_SFX_ON -> isSfxOn.setValue((Integer.parseInt(keyValue[1]) == 1));
  	case PLAYER_NAME -> playerName.setValue(keyValue[1]);
  	case CURRENT_LEVEL -> currentLevel.setValue(Integer.valueOf(keyValue[1]));
  	case HIGHSCORE -> highscores.setValue(Integer.valueOf(keyValue[1]));
  	}
  	}
  	dataScanner.close();
  	} catch (Exception ignored) {}
  	}
  	// Write data using new Thread
  	private void writeData() {
  	new Thread(() -> {
  	try {
  	FileWriter fileWriter = new FileWriter(data);
  	PrintWriter printWriter = new PrintWriter(fileWriter, false);
  	printWriter.println(IS_MUSIC_ON + ":" + (isMusicOn.getValue() ? 1 : 0));
  	printWriter.println(IS_SFX_ON + ":" + (isSfxOn.getValue() ? 1 : 0));
  	printWriter.println(PLAYER_NAME + ":" + playerName.getValue());
  	printWriter.println(CURRENT_LEVEL + ":" + currentLevel.getValue());
  	printWriter.println(HIGHSCORE + ":" + highscores.getValue());
  	printWriter.close();
  	} catch (IOException ignored) {
  	}
  	}).start();
  	}