Skip to content

Code Smell & Logger Messages

Bohan edited this page Oct 19, 2021 · 2 revisions

Fix some code smells

Process

One of Team9's task it to solve some code smells according to the sonar cloud. There are five levels of severity:

  1. Blocker: We resolved 7 of this.
  2. Critical: We resolved approximately 30 of this.
  3. Major: We resolved approximately 50 of this.
  4. Minor: We resolved approximately 100 of this.
  5. Info: We did not change any of these. During the process of fixing these code smells. We found the the major causes of code smells are:
  6. Duplicate code: hard to solve, may cause merge conflicts. (We spent 1/3 of the time solving merge conflicts)
  7. Bad variable names: Very hard to fix. Need to change the whole contexts and unnecessary.
  8. Varibales may be "final": Easy to change, based on the suggestions of IDE.
  9. Lots of commented lines of code: This is easy to solve. Just delete them and no need to worry other teams will uncomment in the future cause this is the last sprint.
  10. Varibales should be static: Hard to solve, need to change other parts of the class and also need to change classes in other packages.
  11. Unused Methods & Variabales: Easy to solve, but need some considerations.
  12. Unused import: This is the easiest code smells to fix.
  13. Remove some local variables because they can be local variables: Easy to fix. ...there are many more

Result

This image is the proof of our work. Since we have limited time, we couldn't fix all of them. There are about 850 code smells before and now it has only 680 (10/19/2021 1pm.)

Logger Messages

With the help from Therese and Week 8 Tutorial. We figured out how to change the level of the logger messages sent to the console in the properties files. However, we did not commit any changes of that file because each memeber in this studio can change them locally.
Instead, we deleted some useless logger messages (each logger has its purpose but some of them are unnecessary in sprint4). For example, the logger.info(Users' operations) including click quit button or click play button and go to main game screen.... These logger messages are unnecessary at this stage. They could be used in some user tests to track how do users play this game.
What we kept are:

  1. Some important class must at least have one logger messages --- according to Week 8 tutorial slides last page.
  2. The loadAssets: % ..... Date is kept because it works like a loading page which tells user the loading status.
  3. Most of the debug level logger messages were kept.

Gameplay

Home

Main Character

πŸ‘Ύ Obstacle/Enemy

Food & Water

Pickable Items

Game achievements

Game Design

Emotional Goals

Game Story

Influences

Style

Pixel Grid Resolution

Camera Angle and The Player's Perspective

Features Design

Achievements Screen

Achievements Trophies and Cards

Music Selection GUI

πŸ‘Ύ Obstacle/Enemy

 Monster Manual
 Obstacles/Enemies
  - Alien Plants
  - Variation thorns
  - Falling Meteorites
  - FaceHugger
  - AlienMonkey
 Spaceship & Map Entry
 Particle effect

Buffs

Debuffs

Buffs and Debuffs manual

Game Instruction

[code for debuff animations](code for debuff animations)

Infinite loop game system

Main Menu Screen

New Setting Screen

Hunger and Thirst

Goals and Objectives

HUD User Interface

Inventory System

Item Bar System

Scoring System

Props store

BGM design

Sound Effect design

Main game interface

Invisible ceiling

New terrain sprint 4

New game over screen sprint 4

Code Guidelines

Main Character Movement, Interactions and Animations - Code Guidelines

Item Pickup

ItemBar & Recycle system

Main Menu Button Code

Game Instructions Code

πŸ‘Ύ Obstacle/Enemy

 Obstacle/Enemy
 Monster Manual
 Spaceship Boss
 Particle effects
 Other Related Code
 UML & Sequence diagram of enemies/obstacles

Scoring System Implementation Explanation

Music Implementation

Buff and Debuff Implementation

Score History Display

code improvement explanation

Infinite generating terrains Implementation Explanation

Game Over Screen and functions explaination

Buffer timer before game start

Scrolling background

Multiple Maps

Invisible ceiling

Rocks and woods layout optimization

Magma and nails code implementation

Background Music Selection

Chooser GUI Implementation

Chooser GUI Logic Persistence

Guide: Adding Background music for a particular screen

Achievements Ecosystem - Code Guidelines

Achievements System

Achievements Screen

Adding Achievements (Guide)

Game Records

DateTimeUtils

History Scoreboard - Score Details

Listening for important events in the Achievements ecosystem

Food and Water System

Food System Water System

Hunger and Thirst icon code guidelines

Asset Creation

In Game Background Music

User Testing

Hunger and Thirst User Testing

Main Character Testing

Buffs and Debuffs Testing

Buff and Debuff Manual User Testing

Game Instruction User Testing

The Main Menu User Test

The New Button User Test in Setting Page

The Main Menu Buttons User Testing

Hunger and Thirst User Test

Infinite loop game and Terrain Testing

Item Bar System Testing

Randomised Item Drops

Recycle System Testing

Scoring System Testing

Music User test

https://github.com/UQdeco2800/2021-ext-studio-2.wiki.git

πŸ‘Ύ Obstacle/Enemy

 Obstacle testing
  - Alien Plants & Variation Thorns
  - Falling Meteorites
 Enemy testing
  - Alien Monkeys & Facehugger
  - Spaceship Boss
 Monster Manual
 Particle-effect
 Player attack testing
  - Player Attack

Inventory system UI layout

Props store user testing

Achievements User Testing

Sprint 1

Sprint 2

Sprint 3

Sprint 4

Items testing

Player Status testing

Changeable background & Buffer time testing

Main game interface test

Invisible ceiling test

Game over screen test sprint 4

New terrain textures on bonus map test sprint 4

Buying Props User Testing

Testing

Hunger and Thirst Testing

Main Character Player

Achievements System, Game Records and Unlockable Chapters

DateTimeUtils Testing

Scoring System Testing Plan

Distance Display Testing Plan

Musics Implementation Testing plan

History Board Testing plan

Rocks and woods testing plan

Sprint 4 terrain tests

Items

Item Bar System Testing Plan

Recycle System Testing Plan

Game Engine

Game Engine Help

Getting Started

Entities and Components

Service Locator

Loading Resources

Logging

Unit Testing

Debug Terminal

Input Handling

UI

Animations

Audio

AI

Physics

Game Screens and Areas

Terrain

Concurrency & Threading

Settings

Troubleshooting

MacOS Setup Guide

Clone this wiki locally