Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ldeluigi/untitled-goose-framework
A framework that allows to write a game like The Goose Game entirely in few LOC with a DSL, in Scala.
https://github.com/ldeluigi/untitled-goose-framework
board-game boardgames dsl framework games goose goosegame library scala scalatest vertx3
Last synced: 2 days ago
JSON representation
A framework that allows to write a game like The Goose Game entirely in few LOC with a DSL, in Scala.
- Host: GitHub
- URL: https://github.com/ldeluigi/untitled-goose-framework
- Owner: ldeluigi
- License: apache-2.0
- Created: 2020-07-08T13:33:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-19T20:03:17.000Z (almost 4 years ago)
- Last Synced: 2024-05-28T21:58:50.184Z (5 months ago)
- Topics: board-game, boardgames, dsl, framework, games, goose, goosegame, library, scala, scalatest, vertx3
- Language: Scala
- Homepage:
- Size: 2.96 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# untitled-goose-framework
Untitled Goose Framework _(not a trademark)_ is a Scala library that is able to run the definition of a board game. It enables the creation and rules automation of games similar to the classic [Game of the Goose](https://en.wikipedia.org/wiki/Game_of_the_Goose).
## CI/CD
### Continuous Integration
A CI system tests, builds and makes new releases of the framework.
- __master__ branch:
- __develop__ branch:
### Continuous Delivery
- New [releases](https://github.com/ldeluigi/untitled-goose-framework/releases) are generated based on the [master](https://github.com/ldeluigi/untitled-goose-framework/tree/master) branch.
- The library is published on ~~[Github packages](https://github.com/ldeluigi?tab=packages&repo_name=untitled-goose-framework) and~~ [Sonatype](https://search.maven.org/artifact/com.github.ldeluigi/untitled-goose-framework_2.12).
[](https://search.maven.org/search?q=g:%22com.github.ldeluigi%22%20AND%20a:%22untitled-goose-framework_2.12%22)
## Features
- Ability to create new games with the shortest, most readable syntax possible through a Scala DSL (_Domain Specific Language_) called **GooseDSL**.
GooseDSL is natural language oriented, in English.
- Ability to play created games locally. Given that each game must be turn-based, one single device is enough to play with any number of human players.
- Possibility to extend game classes, objects or data structures to implement more complex behaviours or functionalities. This can mean both extend the framework functionalities or customize default game logic. For example, one can reimplement the graphical components to make their own visualization.
- Possibility to extend the GooseDSL with custom shortcuts, keywords and more.
## Installation
This library works for Scala 2.12.
### Declaring the library as dependency
Note: `` is the latest version available.
#### SBT (suggested)
Add in your `build.sbt` file:
```scala
libraryDependencies += "com.github.ldeluigi" % "untitled-goose-framework_2.12" % ""
```
#### Gradle Kotlin DSL
Add, in your `build.gradle.kts` file, inside the `dependencies` block:
```kotlin
implementation("com.github.ldeluigi:untitled-goose-framework_2.12:")
```
## Usage
Create a class or object that extends __GooseDSL__ (package: `untitled.goose.framework.dsl`) and write your own game. Documentation on how to write a game can be found in the Wiki.
## Contribute
You can contribute to the project with [Pull Requests](https://github.com/ldeluigi/untitled-goose-framework/pulls) or [Issues](https://github.com/ldeluigi/untitled-goose-framework/issues) about bugs or feature requests.
## Examples
These are the official examples of projects that implement games using this framework:
- __[The Game of the Goose (Goose Game)](https://github.com/ldeluigi/goose-game)__
- __[Snakes and Ladders](https://github.com/ldeluigi/snakes-and-ladders)__
- __[Quiz Race](https://github.com/ldeluigi/quiz-race)__