Mappevurdering-IDATT2003

The exam of IDATT2003, "Programming 2" subject.

Overview

Summary
Packages
Gallery
How to run
Persistence
Usage
Guide to tests

Summary

Millions is a stock trading simulation game where players navigate a dynamic digital market to build as much wealth as possible. Play it safe with careful investments, or take high-risk gambles for the chance at enormous returns.

What you can expect from the game:

Buying stocks
Selling holdings
Transaction overview
Player portfolio
Interesting price evolution
Finish the game with a summary

Some additional features:

Saving and loading the game
Visual price graphs
Newspaper system influencing the market evolution
Predefined .csv file available

Player statuses achievable:

Novice
Investor
Speculator
Paper Hands
Diamond Hands
Roaring Kitty

Packages

.
├── java
│   └── edu
│       └── ntnu
│           └── idi
│               └── idatt
│                   ├── model     
│                   │   ├── enums         -- Enums
│                   │   ├── market        -- Classes relating directly to the exchange
│                   │   ├── player        -- Player model
│                   │   ├── portfolio     -- Player related models
│                   │   └── transaction   -- Models relating to transactions
│                   ├── service
│                   │   └── transaction   -- Services that connect to transactions
│                   ├── session           -- Main class connecting view together with model
│                   ├── storage           -- Storage classes for handeling .csv and .json files
│                   │   └── util         -- Adapters handeling GSON dependency abstract class handeling
│                   └── view 
│                       ├── components                -- Components that make UI layout
│                       │   ├── elements              -- Standalone UI elements made for repetative tasks
│                       │   ├── primitives            -- Diverse helper classes.
│                       │   └── ui                    -- Builders/Utils/Factory
│                       ├── entry    -- Start MVC
│                       ├── primary                   -- Main game MVC's
│                       │   ├── exchange                -- Exchange view
│                       │   ├── finish                    -- Finish/Summary view
│                       │   ├── newspaper                 -- Newspaper view
│                       │   ├── portfolio                 -- Portfolio view
│                       │   │   ├── sections                    -- Portfolio view sections
│                       │   │   └── viewmodel                   -- Portfolio view section models
│                       │   ├── stock                    -- Stock view
│                       │   │   ├── sections                    -- Stock view sections
│                       │   │   └── viewmodel                   -- Stock view section models
│                       │   └── transactions            -- Transaction view
│                       └── util                -- Helper classes for view styling/resources
└── resources
    ├── icons    -- UI icons
    └── themes    -- CSS styling files

Gallery

Exchange. Stocks from SP500.

Apple Inc. stock page. Picture taken at week 57.

How to run

Prerequesites

Atleast Java 25 JRE
Apache Maven in case of source code compilation.

Source code compilation

Clone the repository: git clone https://git.ntnu.no/danieskj/Mappevurdering-IDATT2003.
Navigate to the newly cloned folder.
Run command: mvn clean javafx:run.

Executable variants

Tip

Try running the "fat jar" solution as the primary solution.
In case of malfunction, process to the other methods.

Navigate to the Releases tab in Github and press the latest release.
Downloadable configurations for different operating systems should be available.
Download and decompress the downloaded folder using any .ZIP tool alternative.
Navigate to the executable. Regurarly in main directory or found under ~/bin/.
Double press the file and launch.

Alternatively, a "fat jar" (Jar including all dependencies packaged together) is compiled.
This solution seems to work on some computers, but JavaFX is often found problematic.

Important

Due to missing testing ability. only .AppImage and .exe are compiled correspondingly for Linux and Windows machines.

Windows: Microsoft Defender may be angry becuase of unsigned executables. Try running it as administrator.

Linux: In case of executable not working, try starting it through the command line: ./Millions.
If execution fails, try making the file a executable: chmod +x Millions and running again.
Do not move the executable file from the bin folder. JavaFX requires compiled dependencies laying in lib.

Running tests

Tests can be run with the following command: mvn clean test.
This requires having cloned the repository in the first section.

Persistence

The application utilizes 'AppData' folders of the three major systems.

This includes:

Windoows: ~/home/AppData/Millions/
MacOS: ~/home/Library/Application Support/Millions/
Linux: ~/home/.local/share/Millions/

The application saves player and gamestate in the corresponding folders under the name storage.json.
This file can be removed via. the scripts attached to each Release in the Releases tab.

Usage

Initial launch

User may type in their player name.
If none found, fill out the rest of the fields for initializing the player.
Choose .csv stock file with proper format or use the predefined checkbox.

Default UI-Walkthrough

Header
- Contains often sort menu on the left and searchbar centered.
Navigation (Left bar)
- Name of current view.
- Clickable buttons for current view.
- Home screen & Previous page button.
- Advance to Next Week button.
Toolbar
- Information display.
- Balance, week number, player status, Net worth.
- Account button & Quit button.
Menu (Right pop-up bar)
- Displays on account button click.
- Player relevant navigation.
- Portfolio button.
- Transactions (Archive) button.

Exchange View

User can browse, sort and search after stocks.
Stocks are given with ticker, company name, latest price & price changes.
User can sort after gainers or loosers of the current week, or stocks with new news.
Stocks with white pulsating glow effect indicates new news in their newspaper.
Interaction with stocks to go to their view.

Stock View

Navigation: Newspaper button to see news.
Content:
- Graph of the stock price evolution.
- Display with values on price evolution and holdings summarized.
- Buy menu with live calculations.
- Sell button which redirects to Portfolio with focus on current stock shares.

Portfolio View

Displays relevant portfolio information & player statistics.
"Finish game" button to finish the game and get a summary.
Overview of current holdings and their returns.
Sorting & searching capability by relevant information.
Ability to sell holding instances.
Ability to press the share to get redirected to the stock view.

Transaction Archive View

Overview of all transactions made all time.
Detailed information about each transaction.
Sorting & searching capability by relevant information.

Game Finish

Displays important statistics throught the playthrough.
Summarizes profits.
Deletes current player from storage.

Guide to tests

Testing follows the default AAA model (Arrange, Act, Assert).
Each testing class relying on many dependencies uses @BeforeEach setup the testing environment.
Complicating testing processes have necessary JavaDocs appended to them.
Each test method is named descriptively after it's purpose.

Launching steps are described in the How to Run, Running Tests - section.

danieskj/Mappevurdering-IDATT2003

About

Resources

Stars

Watchers

Forks

Releases 4

Packages 0

Contributors 2

Languages

Packages