Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sleepyfran/duets
🎸 A text based music simulation game
https://github.com/sleepyfran/duets
cli fsharp game life-simulation sim simulation text-based text-based-game tycoon
Last synced: 3 months ago
JSON representation
🎸 A text based music simulation game
- Host: GitHub
- URL: https://github.com/sleepyfran/duets
- Owner: sleepyfran
- License: gpl-3.0
- Created: 2019-07-29T23:01:26.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T10:42:51.000Z (3 months ago)
- Last Synced: 2024-10-21T15:36:46.553Z (3 months ago)
- Topics: cli, fsharp, game, life-simulation, sim, simulation, text-based, text-based-game, tycoon
- Language: F#
- Homepage:
- Size: 3.53 MB
- Stars: 27
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Duets 🎸
Duets is a music/life simulation game focused on allowing the player to be the leader of their own band, composing songs and making gigs to become a star.
📷 Screenshots
# 🛠 Run it locally
Duets is built with F# as an interactive CLI game. Start by cloning the repository and entering in it:
```bash
git clone --recurse-submodules https://github.com/sleepyfran/duets.git
cd duets
```
> [!WARNING]
> Duets currently uses a fork of Spectre.Console, so it's important to clone the submodules as well to bring that dependency.
Once you have it, you can either chose to run it with a local installation of the .NET SDK or, if you prefer, through
Docker to avoid installing the SDK on your computer and instead running the game inside a container.
## Running with local .NET
If you you want to install .NET, follow the instructions [here](https://dotnet.microsoft.com/download) to get the latest
version of .NET. Once you have it, you can simply run:
```bash
dotnet build
dotnet run --project src/Cli/Cli.fsproj
```
## Running with Docker
There's an included Dockerfile in the repo that allows you to run the game inside a Docker container if you prefer to do
so, simply run it with:
```bash
docker build -t duets .
docker run -it duets
```
> [!WARNING]
> The game is nowhere near done or bug-free. I'm constantly doing changes to the savegame format and thus constantly breaking
> savegames. In the future when the game will be more complete I'll introduce some mechanism to automatically migrate savegames
> but for the time being you either need to tinker with the savegame file to adapt it when new versions come up or be okay
> with losing your savegames.
# 🧪 Testing
You can run the tests with:
```bash
dotnet test
```
# 😄 Contributions
Right now the game is in concept phase and it'll probably change quickly until it has certain features so there's no
public roadmap. The best way of contributing right now is running the game and reporting bugs, if you want to contribute
to the code check the project a little bit later, I'll update this section as soon as it's possible to have external
contributions!