Skip to content

Commit

Permalink
Dungeon: add support for editing and managing of dsl files ("task man…
Browse files Browse the repository at this point in the history
…ager") (#1611)

Der Task Manager ist im Rahmen der Bachelorarbeit von @mpeters4
entstanden und wird als Kotlin-Projekt in diesem PR in das
Dungeon-Projekt integriert.

Mit dem Task Manager können DSL-Dateien komfortabel außerhalb einer IDE
bearbeitet und geladen werden, es steht sogar ein Syntaxhighlighting zur
Verfügung. Im Gegensatz zum [LSP-Support](dsl-ide-support-with-lsp/)
(#1601) sollte dieses Sub-Projekt mittelfristig fest in den
Dungeon-DSL-Starter integriert werden, damit informatikfremde Nutzende
einfacher mit den Aufgabendefinition in den DSL-Dateien umgehen können.
(Der LSP-Support sollte als separates Sub-Projekt weitergeführt werden,
da es hier um die IDE-Unterstützung geht.)

---

Todo vor dem Merge:

- [x] Anpassen des Haupt-Readme (Lizenzen)


Todo nach dem Merge:

- [ ] ~~Einbinden als Gradle-Sub-Projekt im Haupt-Dungeon-Projekt~~
(#1615)
- [ ] ~~Anpassen der Ordnerstruktur und Hilfs-/Konfig-Dateien an die
anderen Gradle-Sub-Projekte~~ (#1616)
- [ ] ~~Anpassen des Haupt-Readme (Erwähnung des Projekts)~~ (#1617)
- [ ] ~~Ausschließen von Checkstyle und Spotless (Kotlin-Code)~~ (#1618)


Mittelfristig: 

- [ ] ~~Umbauen auf Java (?) =>
https://codeconverter.io/convert/kotlin-to-java (?)
https://stackoverflow.com/questions/34957430/how-to-convert-a-kotlin-source-file-to-a-java-source-file
(?)~~ (#1619)
- [ ] ~~Bereitstellen im JAR des Dungeon-DSL-Starters: Beim Starten des
Dungeons kommt nicht der Auswahldialog für die DSL-Dateien, sondern
@mpeters4's schicke GUI und von dort kann man dann Dateien laden,
editieren, speichern, ...~~ (#1620)

---------

Co-authored-by: Carsten Gips <[email protected]>
  • Loading branch information
mpeters4 and cagix authored Aug 14, 2024
1 parent d494592 commit 0f65e4f
Show file tree
Hide file tree
Showing 105 changed files with 7,621 additions and 48 deletions.
9 changes: 9 additions & 0 deletions LICENSE-ICONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Apache License 2.0

=======================================================================

Copyright (c) 2023 Composable Horizons LLC.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
107 changes: 59 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,9 @@ problems or suggestions, please feel free to contact us in English or German.
This project was funded by [Stiftung für Innovation in der Hochschullehre] (["Freiraum
2022"]).

The assets in [`game/assets/`], [`dungeon/assets/`] and [`devDungeon/assets/`] are a mix from free and self created resources:
The assets in [`game/assets/`], [`dungeon/assets/`], [`devDungeon/assets/`], and
[`dungeon-task-manager/Task_Management_Dungeon/src/main/kotlin/icon/`] are a mix from free and
self created resources:

- Textures and animations:
- https://0x72.itch.io/16x16-dungeon-tileset (CC0 1.0)
Expand All @@ -91,64 +93,73 @@ The assets in [`game/assets/`], [`dungeon/assets/`] and [`devDungeon/assets/`] a
- https://opengameart.org/content/hurt-death-sound-effect-for-character (CC0 1.0)
- https://opengameart.org/content/80-cc0-creture-sfx-2 (CC0 1.0)
- https://freesound.org/s/578488/ (CC0 1.0)
- Icons in [`dungeon-task-manager/Task_Management_Dungeon/src/main/kotlin/icon/`]
- https://www.composables.com/icons (Apache 2.0)
- Adapted and modified by [\@Flamtky][]:
- Files (except [Health Potion]) in [`dungeon/assets/items/potion/`] (originating from @dkirshner)
- Files (except [Health Potion]) in [`dungeon/assets/items/potion/`] (originating from
[\@dkirshner])
- Files in [`game/assets/dungeon/*/floor`][]: each `floor_damaged.png` (originating from
[\@dkirshner])
- [`game/assets/dungeon/fire/floor/floor_1.png`] (originating from [\@dkirshner])
- Self created by [\@Flamtky][]:
- Files in [`devDungeon/assets/objects/spawner/`]
- Self created by [\@Flamtky][]:
- Files in [`devDungeon/assets/objects/spawner/`]

## Licenses

This [work] by [André Matutat], [Malte Reinsch], and [contributors] is licensed under [MIT].

All files in [`doc/publication/`] are licensed under [CC BY-SA 4.0].

All files in [`game/assets/`](game/assets/), [`dungeon/assets/`](dungeon/assets/) and [`devDungeon/assets/`](devDungeon/assets/) are licensed under [CC0 1.0].
All files in [`game/assets/`], [`dungeon/assets/`] and [`devDungeon/assets/`] are licensed
under [CC0 1.0].

All files in [`dungeon-task-manager/Task_Management_Dungeon/src/main/kotlin/icon/`] are
licensed under [Apache 2.0].

<p align="right"><img src="https://github.com/Dungeon-CampusMinden/Dungeon/blob/master/doc/img/logo/cat_logo_64x64.png?raw=true" alt="Banner"></p>

["Game"]: #game-dungeon-platform
["Dungeon"]: #dungeon-learning-by-questing
["Blockly"]: #blockly-low-code-dungeon
[interesting report]: https://www.hsbi.de/presse/pressemitteilungen/informatik-studierende-am-campus-minden-entwickeln-2d-rollenspiel-zum-lehren-und-lernen
[`game`]: game
[libGDX]: https://github.com/libgdx/libgdx
[rogue-like 2D role-playing games]: https://en.wikipedia.org/wiki/Roguelike
[Java]: https://jdk.java.net/
[ECS architecture pattern]: https://en.wikipedia.org/wiki/Entity_component_system
[Quickstart]: game/doc/quickstart.md
[Documentation]: game/doc/
[1]: game/doc/img/monster.gif
[`dungeon`]: dungeon
[2]: dungeon/doc/quickstart.md
[3]: dungeon/doc/
[Dungeon: StarterKit]: https://github.com/Dungeon-CampusMinden/Dungeon-StarterKit
[4]: dungeon/doc/dsl/img/quickstart_select_config_level.png
[5]: dungeon/doc/dsl/img/quickstart_answer_menu.png
[`blockly`]: blockly
[Google's Blockly]: https://github.com/google/blockly
[6]: blockly/doc/
[7]: blockly/doc/img/examples/komplexes_beispiel.png
[Java SE Development Kit 21 LTS]: https://jdk.java.net/21/
[Stiftung für Innovation in der Hochschullehre]: https://stiftung-hochschullehre.de
["Freiraum 2022"]: https://stiftung-hochschullehre.de/foerderung/freiraum2022/
[`game/assets/`]: game/assets/
[`dungeon/assets/`]: dungeon/assets/
[`devDungeon/assets/`]: devDungeon/assets/
[\@Flamtky]: https://github.com/Flamtky
[Health Potion]: dungeon/assets/items/potion/health_potion.png
[`dungeon/assets/items/potion/`]: dungeon/assets/items/potion/
[`game/assets/dungeon/*/floor`]: game/assets/dungeon/
[\@dkirshner]: https://github.com/dkirshner
[`game/assets/dungeon/fire/floor/floor_1.png`]: game/assets/dungeon/fire/floor/floor_1.png
[`devDungeon/assets/objects/spawner/`]: devDungeon/assets/objects/spawner/
[work]: https://github.com/Dungeon-CampusMinden/Dungeon
[André Matutat]: https://github.com/AMatutat
[Malte Reinsch]: https://github.com/malt-r
[contributors]: https://github.com/Dungeon-CampusMinden/Dungeon/graphs/contributors
[MIT]: LICENSE.md
[`doc/publication/`]: doc/publication/
[CC BY-SA 4.0]: LICENSE-PAPER.md
[CC0 1.0]: LICENSE-ASSETS.md
["Game"]: #game-dungeon-platform
["Dungeon"]: #dungeon-learning-by-questing
["Blockly"]: #blockly-low-code-dungeon
[interesting report]: https://www.hsbi.de/presse/pressemitteilungen/informatik-studierende-am-campus-minden-entwickeln-2d-rollenspiel-zum-lehren-und-lernen
[`game`]: game
[libGDX]: https://github.com/libgdx/libgdx
[rogue-like 2D role-playing games]: https://en.wikipedia.org/wiki/Roguelike
[Java]: https://jdk.java.net/
[ECS architecture pattern]: https://en.wikipedia.org/wiki/Entity_component_system
[Quickstart]: game/doc/quickstart.md
[Documentation]: game/doc/
[1]: game/doc/img/monster.gif
[`dungeon`]: dungeon
[2]: dungeon/doc/quickstart.md
[3]: dungeon/doc/
[Dungeon: StarterKit]: https://github.com/Dungeon-CampusMinden/Dungeon-StarterKit
[4]: dungeon/doc/dsl/img/quickstart_select_config_level.png
[5]: dungeon/doc/dsl/img/quickstart_answer_menu.png
[`blockly`]: blockly
[Google's Blockly]: https://github.com/google/blockly
[6]: blockly/doc/
[7]: blockly/doc/img/examples/komplexes_beispiel.png
[Java SE Development Kit 21 LTS]: https://jdk.java.net/21/
[Stiftung für Innovation in der Hochschullehre]: https://stiftung-hochschullehre.de
["Freiraum 2022"]: https://stiftung-hochschullehre.de/foerderung/freiraum2022/
[`game/assets/`]: game/assets/
[`dungeon/assets/`]: dungeon/assets/
[`devDungeon/assets/`]: devDungeon/assets/
[`dungeon-task-manager/Task_Management_Dungeon/src/main/kotlin/icon/`]: dungeon-task-manager/Task_Management_Dungeon/src/main/kotlin/icon/
[\@Flamtky]: https://github.com/Flamtky
[Health Potion]: dungeon/assets/items/potion/health_potion.png
[`dungeon/assets/items/potion/`]: dungeon/assets/items/potion/
[`game/assets/dungeon/*/floor`]: game/assets/dungeon/
[\@dkirshner]: https://github.com/dkirshner
[`game/assets/dungeon/fire/floor/floor_1.png`]: game/assets/dungeon/fire/floor/floor_1.png
[`devDungeon/assets/objects/spawner/`]: devDungeon/assets/objects/spawner/
[work]: https://github.com/Dungeon-CampusMinden/Dungeon
[André Matutat]: https://github.com/AMatutat
[Malte Reinsch]: https://github.com/malt-r
[contributors]: https://github.com/Dungeon-CampusMinden/Dungeon/graphs/contributors
[MIT]: LICENSE.md
[`doc/publication/`]: doc/publication/
[CC BY-SA 4.0]: LICENSE-PAPER.md
[CC0 1.0]: LICENSE-ASSETS.md
[Apache 2.0]: LICENSE-ICONS.md
2 changes: 2 additions & 0 deletions dungeon-task-manager/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto
11 changes: 11 additions & 0 deletions dungeon-task-manager/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

Task_Management_Dungeon/.idea/uiDesigner.xml
*.xml
Task_Management_Dungeon/.idea/gradle.xml
Task_Management_Dungeon/.idea/gradle.xml
Task_Management_Dungeon/gradle/wrapper/gradle-wrapper.jar
Task_Management_Dungeon/gradle/wrapper/gradle-wrapper.jar
Task_Management_Dungeon/gradle/wrapper/gradle-wrapper.jar
Task_Management_Dungeon/task_manager.db
Task_Management_Dungeon/Dungeon_Files/Test.dng
*.dng
21 changes: 21 additions & 0 deletions dungeon-task-manager/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Michael Peters

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
7 changes: 7 additions & 0 deletions dungeon-task-manager/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Dies is eine Software zur Verwaltung von Aufgaben im Dungeon.
Die Erstellung erfolgt im Rahmen meiner Bachelorarbeit.

Folgende externe Bibliotheken stehen unter einer anderen Lizenz (Apache 2.0):

[Material Symbols for Jetpack Compose (Ordner: Task_Management_Dungeon\src\main\kotlin\icon)](https://www.composables.com/icons)

42 changes: 42 additions & 0 deletions dungeon-task-manager/Task_Management_Dungeon/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
.gradle
build/
!gradle/wrapper/gradle-wrapper.jar
!**/src/main/**/build/
!**/src/test/**/build/

### IntelliJ IDEA ###
.idea/modules.xml
.idea/jarRepositories.xml
.idea/compiler.xml
.idea/libraries/
*.iws
*.iml
*.ipr
out/
!**/src/main/**/out/
!**/src/test/**/out/

### Eclipse ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
bin/
!**/src/main/**/bin/
!**/src/test/**/bin/

### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/

### VS Code ###
.vscode/

### Mac OS ###
.DS_Store
88 changes: 88 additions & 0 deletions dungeon-task-manager/Task_Management_Dungeon/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
import org.jetbrains.compose.desktop.application.dsl.TargetFormat
import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType

plugins {
kotlin("jvm")
id("org.jetbrains.compose")
id("app.cash.sqldelight") version "2.0.1"
}

group = "org.example"
version = "1.0-SNAPSHOT"

//Set Compiler to Java 21.01
compose {
kotlinCompilerPlugin.set("androidx.compose.compiler:compiler:1.5.7")
}

kotlin{

sourceSets{
main{
dependencies{
// implementation("app.cash.sqldelight:native-driver:2.0.1")
}
}
}
}

repositories {
mavenCentral()
maven("https://maven.pkg.jetbrains.space/public/p/compose/dev")
google()
}


dependencies {
val voyagerVersion = "1.0.0"
// Note, if you develop a library, you should use compose.desktop.common.
// compose.desktop.currentOs should be used in launcher-sourceSet
// (in a separate module for demo project and in testMain).
// With compose.desktop.common you will also lose @Preview functionality
implementation(compose.desktop.currentOs)

// Navigator Copyright (c) 2021 Adriel Café
implementation("cafe.adriel.voyager:voyager-navigator:$voyagerVersion")

// Screen Model Copyright (c) 2021 Adriel Café
implementation("cafe.adriel.voyager:voyager-screenmodel:$voyagerVersion")

// BottomSheetNavigator Copyright (c) 2021 Adriel Café
implementation("cafe.adriel.voyager:voyager-bottom-sheet-navigator:$voyagerVersion")

// TabNavigator Copyright (c) 2021 Adriel Café
implementation("cafe.adriel.voyager:voyager-tab-navigator:$voyagerVersion")

// Transitions Copyright (c) 2021 Adriel Café
implementation("cafe.adriel.voyager:voyager-transitions:$voyagerVersion")

//Material 3
implementation("org.jetbrains.compose.material3:material3-desktop:1.6.0")
//SQLdelight
implementation("app.cash.sqldelight:sqlite-driver:2.0.1")
implementation("app.cash.sqldelight:coroutines-extensions:2.0.1")

implementation("org.slf4j:slf4j-nop:1.7.25")

}

//Database
sqldelight {
databases {
create("Database") {
packageName.set("Task_Management_Dungeon")
}
}
}

compose.desktop {
application {
mainClass = "MainKt"

nativeDistributions {
targetFormats(TargetFormat.Dmg, TargetFormat.Msi, TargetFormat.Deb)
packageName = "Task_Management_Dungeon"
packageVersion = "1.0.0"
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
kotlin.code.style=official
kotlin.version=1.9.20
compose.version=1.5.10
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
13 changes: 13 additions & 0 deletions dungeon-task-manager/Task_Management_Dungeon/settings.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
pluginManagement {
repositories {
gradlePluginPortal()
maven("https://maven.pkg.jetbrains.space/public/p/compose/dev")
}

plugins {
kotlin("jvm").version(extra["kotlin.version"] as String)
id("org.jetbrains.compose").version(extra["compose.version"] as String)
}
}

rootProject.name = "Task_Management_Dungeon"
Loading

0 comments on commit 0f65e4f

Please sign in to comment.