43 lines
1.4 KiB
Markdown
43 lines
1.4 KiB
Markdown
# Malatro
|
|
|
|
## About
|
|
|
|
`Malatro` is a simplified clone of the game `Balatro`.
|
|
Its main purpose is to serve as an educational tool, teaching foundational programming concepts.
|
|
|
|
📢 **Note**: This project is purely educational and will not be used for any commercial purposes.
|
|
|
|
---
|
|
|
|
## For Students
|
|
|
|
The remainder of this README is yours to complete. Take this opportunity to describe your
|
|
contributions, the design decisions you've made, and any other information you deem necessary.
|
|
|
|
# Task 1 - Partial Delivery 1
|
|
|
|
This project defines the basic entities for a card-based video game using Scala.
|
|
It includes classes for `Card`, `Rank`, `Suit`, `Joker`, `Hand`, and `Score`, each documented and independently tested.
|
|
|
|
## Structure
|
|
|
|
- `cards/` → Cards, ranks, and suits
|
|
- `jokers/` → Jokers with type as a string
|
|
- `hand/` → A hand containing a set of cards and jokers
|
|
- `score/` → Score with chips and multiplier
|
|
|
|
## Testing
|
|
|
|
All tests are written using [MUnit](https://scalameta.org/munit/) and located under `src/test/scala`.
|
|
The project achieves **90%+ test coverage** using `sbt-scoverage`.
|
|
|
|
---
|
|
|
|
|
|
<div style="text-align:center;">
|
|
<img src="https://i.creativecommons.org/l/by/4.0/88x31.png" alt="Creative Commons License">
|
|
</div>
|
|
|
|
This project is licensed under the [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).
|
|
|
|
--- |