Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Conhan93 committed Sep 29, 2022
1 parent 2429f98 commit 725f256
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 6 deletions.
Binary file modified Images/LookupDisplay.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Images/LookupSpellPop.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Images/LookupStart.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,33 @@ A side project to familiarise myself with Compose.

## About

Desktop app that lets you search for monsters from Dungeons and Dragons and easily view them and their actions, abilities and stats.
For your DM:ing needs. Currently only supports monsters and spells that pops up when you select an ability containing spells.
Desktop app that lets you search for monsters from Dungeons and Dragons and easily view them and their actions, abilities, stats
for your DM:ing needs. Currently, only supports monsters and spells that pops up when you select an ability containing spells.
Actions and abilities are displayed in scrollable lists with clickable items for actions with attack rolls, which will display
a popup with attack roll results and damage.

The app UI is built with [Compose Multiplatform](https://www.jetbrains.com/lp/compose-mpp/) and supports both dark and light themes.
Uses an embedded database for local storage to cache recently fetched monsters and spells.

The information is fetched from an open Dungeons and Dragons [API](https://www.dnd5eapi.co/)
that lets you fetch information from monsters, items, spells, etc.

## Install

Use gradle to build or run the project using

```
# Create runnable executable for your OS
gradle createdistributable
# Or
gradlew createdistributable
# To create an installer for windows
# gradle packageMsi
# To build project
gradle build
```

## Images
<figure>
Expand All @@ -34,13 +52,19 @@ that lets you fetch information from monsters, items, spells, etc.
</figure>


## Dependencies

## Planned
- Local Storage: [H2](https://github.com/h2database/h2database)
- Local Storage ORM: [Exposed](https://github.com/JetBrains/Exposed)
- Dependency Injection: [Koin](https://github.com/InsertKoinIO/koin)
- Logging: [Kotlin-logging](https://github.com/MicroUtils/kotlin-logging)

## Planned

- Add a loading animation when searching
- Add proper fonts
- Make better use of themes by moving shapes and typography into it
- Build window decorator into app bar
- Dice roll animation
- Differentiate clickables with icons
- General dice roller
- ~~UI Tests~~ When UI tests are more developed for compose desktop


Expand Down

0 comments on commit 725f256

Please sign in to comment.