[CS2113-T11-4] EconoCraft Pro #30
Conversation
There was a problem hiding this comment.
The size of your text and colors is great!
|  | ||
|
|
||
| The `EconoCraftLogic` mechanism: | ||
|
|
There was a problem hiding this comment.
In some of your diagrams, such as in EconoCraftLogic components, the standard model of excluding icons is not followed.
There was a problem hiding this comment.
Thank you, may I ask what does it mean by excluding icons?
|
|
||
| Here is the sequence diagram of the `EconoCraftLogic` executing the command: |
There was a problem hiding this comment.
The sequence diagram following could also benefit from UML notes to help viewers understand instead of just bullet points after the diagram.
|
|
||
| # Implementation | ||
|
|
||
| ## MiniGame - Typing Game |
There was a problem hiding this comment.
The different functionalities of the different mini-games is comprehensively but sensibly written about in the DG. Good job.
There was a problem hiding this comment.
Thank you! Will take note of the issues:)
| ## Acknowledgements | ||
|
|
||
| {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} | ||
|
|
||
| ## Design & implementation | ||
| ## Design | ||
|
|
There was a problem hiding this comment.
Format of DG is neat, well-formatted, easy to understand and consistent. Well Done!
| 3. The event generated will be executed via `RandomEvent` interface in `EconoCraftLogic`. | ||
| 4. Player would be prompted to make a decision based on the event. | ||
| 5. Based on the decision made and the event type, the player would receive different rewards or punishments. | ||
| 6. The event would add uncertainty and excitement to the game. | ||
|
|
There was a problem hiding this comment.
It would be nice if the target user for the product and/or the value proposition is specified clearly.
| 3. The command would then update the player profile according to the mini-game result. | ||
|
|
||
| # Implementation | ||
|
|
There was a problem hiding this comment.
There seems to be enough examples e.g., sample inputs/outputs. i can understand.
| > - The `XYZ` in `StockXYZ` represents the stock label e.g., `StockOne`, `StockTwo`, etc. | ||
|
|
||
| Here is the sequence diagram of the `EconoCraftLogic` executing the command: | ||
|
|
There was a problem hiding this comment.
Notation seems to be compliant with the notation covered in the course.
The diagram is suitable for the purpose it is used for and is not too complicated. Well Done!
There was a problem hiding this comment.
DG is neatly arranged with concise explanation, helps with its readability!
docs/UML diagram/Work.png
Outdated
There was a problem hiding this comment.
Perhaps you could standardise the software/theme being used for all sequence diagrams
| 2. When these commands are generated and executed in `EconoCraftLogic`, the respective mini-game would be played. | ||
| 3. The command would then update the player profile according to the mini-game result. | ||
|
|
||
| # Implementation |
There was a problem hiding this comment.
Good thorough explanation on the implementation process but would it better if there were also example inputs/output usages as well
|
|
||
| {Describe the target user profile} | ||
| {Describe the target user playerProfile} | ||
|
|
||
| ### Value proposition | ||
|
|
||
| {Describe the value proposition: what problem does it solve?} | ||
|
|
||
| ## User Stories |
There was a problem hiding this comment.
Very detailed and fits the scope of the project with regards to the user stories. Good work!
| ## Design | ||
|
|
||
| ### Overview of GameFlow | ||
|  |
There was a problem hiding this comment.
I like the flow chart. I think it may be more readable if the size of the picture was reduced?
| 6. Finally, the `WorkCommand` would update the player profile with the reward earned according to the user's performance in the game. | ||
|
|
||
| ## MiniGame - Tic Tac Toe | ||
|
|
There was a problem hiding this comment.
Perhaps some diagrams to represent the architectures of the mini games would be nice.
| 7. The process of selling stock can be invoked by the `SellStockCommand` class when user input `sellstock`. | ||
| 8. The system will calculate user's profit gained at the current price of the stock and return the money back to the | ||
| user based on the stock's current price. | ||
| 9. User can keep the stock they purchased inside their asset for as long as they want. |
There was a problem hiding this comment.
Maybe consider adding a diagram of what a stock represents, as it has felt quite arbitrary throughout the entire guide.
docs/DeveloperGuide.md
Outdated
|  | ||
|
|
||
| The mechanism: | ||
| 1. `Saver` will be called automatically after one command is executed. |
There was a problem hiding this comment.
Perhaps consider adding a screenshot of an example saved file, so the readers can visualise it better.
delete and modify bond and cryptocurrency . Add tracker
Update dg file
Branch fix ped bugs
Simplify PPP
Branch ugdgppp
Branch error
Documentation wrap up
Simplify JavaDoc
Update PPP
Update documentation
Update DG
Update UserGuide.md
Update AboutUs.md
EconoCraft Pro is a single player text adventure game which simulates real-world business challenges, including resource management, investment analysis, and financial planning to help students prepare for the future challenges.