Skip to content
This repository has been archived by the owner on Jan 7, 2023. It is now read-only.

Commit

Permalink
Merge pull request #101 from CSC207-2022F-UofT/meta/readme-round-2
Browse files Browse the repository at this point in the history
Final README Updates
  • Loading branch information
6167656e74323431 authored Dec 9, 2022
2 parents d902c64 + 6d39f76 commit 85cd231
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,29 @@ on any Unix-like operating system (or the built-in IntelliJ IDEA terminal).
- Persistence: When a battle ends your characters' stats are automatically saved and are recalled on next game open.
Even if you lose the game your characters' stats get saved!
- Minimap: Press 'm' to open a minimap that will show a visual representation of the map you've discovered so far!
- Keyboard layout:
- `w`, `a`, `s`, `d`: movement keys, in the usual configuration.
- `e`: interact with an adjacent chest on the map.
- `f`: fight an adjacent enemy on the map.
- `m`: open the minimap (any key closes it).
- `i`: open/close the inventory.
- `<SPACEBAR>`: open the walking menu.
- `k`: open the help text.
- `t`: start the tutorial.
- Code Organization
- Code is organized by layers, `com.mg105.user_interface`, `com.mg105.interface_adapters`, `com.mg105.use_cases`, `com.mg105.entities`.
- Code is organized by layers, `com.mg105.user_interface`, `com.mg105.interface_adapters`, `com.mg105.data_control`, `com.mg105.use_cases`, `com.mg105.entities`.
- The `com.mg105.user_interface` package is the only package that knows anything about the graphics library, JavaFX.
- The `com.mg105.utils` package mostly keeps track of constants.
- Testing
- As of 246787a13d, test coverage is at 44%, 96% for `com.mg105.entities` only and 86% for `com.mg105.use_cases` only.
- As of [96e8a0a3](https://github.com/CSC207-2022F-UofT/course-project-group-105/pull/101/commits/96e8a0a3081fbd400cdc11552415465772a5a1a1), (line) test coverage is as follows:
- `com.mg105.entities`: 90%
- `com.mg105.use_cases`: 90%
- `com.mg105.data_control`: 76%
- `com.mg105.interface_adapters`: 57%
- `com.mg105.user_interface`: 1%
- `com.mg105.utils`: 100%
- Total: 51%
- Some tests assume a **completely clean** environment, if some tests fail delete `move_data.csv` and `party_data.csv` and run them again.
- Documentation
- Current up-to-date Javadoc can be found [here](https://docs.mg105.com/).
- Extra GitHub Features Used
Expand Down

0 comments on commit 85cd231

Please sign in to comment.