https://github.com/Thomvis/Construct

Dungeons & Dragons DM companion app in SwiftUI
https://github.com/Thomvis/Construct

Last synced: about 1 month ago
JSON representation

Dungeons & Dragons DM companion app in SwiftUI

• Host: GitHub
• URL: https://github.com/Thomvis/Construct
• Owner: Thomvis
• License: mit
• Created: 2020-09-26T12:27:26.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-09-11T11:29:47.000Z (over 1 year ago)
• Last Synced: 2024-11-07T23:02:25.379Z (about 1 month ago)
• Language: Swift
• Homepage: https://www.construct5e.app
• Size: 68 MB
• Stars: 120
• Watchers: 6
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-tca - Construct
• fucking-open-source-ios-apps - Construct for D&D 5e

README

        
 Construct: D&D companion app in SwiftUI

===

![](https://github.com/Thomvis/Construct/workflows/Construct%20CI/badge.svg?branch=main) [![](https://img.shields.io/badge/TestFlight-join-blue.svg)](https://testflight.apple.com/join/tvK1gYv9)

|  |  |  |   |

|---|---|---|---|

## Project Goals

This project aims to be...

- 🐉 an easy to use companion app for Dungeon Masters running [5th edition D&D](https://en.wikipedia.org/wiki/Dungeons_%26_Dragons)

- 🎓 a resource for developers learning [SwiftUI](https://developer.apple.com/xcode/swiftui/) and [The Composable Architecture](https://github.com/pointfreeco/swift-composable-architecture)

### For Dungeon Masters

The easiest way to use the app is by downloading it from the App Store.



You can find an overview of Construct's features at [construct5e.app](https://www.construct5e.app).

### For developers

Download the project, open `Construct.xcodeproj` and run `Construct`.

#### Architecture overview

Construct is built using SwiftUI and a reducer-based architecture implemented using [The Composable Architecture](https://github.com/pointfreeco/swift-composable-architecture) framework. The entire app's state is represented by the [AppState struct](https://github.com/Thomvis/Construct/blob/main/Construct/App/AppState.swift), a deeply nested data structure containing the top-level screens and any screen, sheet or popover opened from there. A [tight integration](https://github.com/Thomvis/Construct/blob/main/Construct/Foundation/Navigation.swift) between SwiftUI's NavigationLink and the app's state make programmatic navigation a breeze.

All data in the app is stored locally in an sqlite database using [GRDB](http://groue.github.io/GRDB.swift/). Construct defines a simple [key-value store](https://github.com/Thomvis/Construct/blob/main/Construct/Persistence/KeyValueStore.swift) on top of GRDB. All entities are serialized using Swift's Codable, can optionally support full-text search and are [automatically](https://github.com/Thomvis/Construct/blob/main/Construct/Persistence/EntityChangeObserver.swift) saved in the database when they change in the app state.

The D&D domain calls for some interesting parsing solution. Construct contains a small [parser combinator framework](https://github.com/Thomvis/Construct/blob/main/Construct/Foundation/ParserCombinator.swift) and defines a couple of [interesting](https://github.com/Thomvis/Construct/blob/main/Construct/Models/CreatureActionParser.swift) [parsers](https://github.com/Thomvis/Construct/blob/main/Construct/Models/DiceExpressionParser.swift).

I hope to write posts detailing some of the interesting parts of the app in the future.