frame-of-mind/README.md

40 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

2025-01-29 16:44:22 +00:00
![Screenshot of a realistic messy teenage-room desk in a warm room. A pinboard is labelled with "mind board" and has an "order thoughts" button.](gitlab-banner-screenshot.png)
2023-03-03 15:19:12 +00:00
# Frame of Mind
2023-03-03 15:41:49 +00:00
Imagine moving out of your childhood room. What mementos will you find? What thoughts will they bring with them? What do you want to take away?
2023-03-03 15:19:12 +00:00
2023-03-03 15:41:49 +00:00
And how will all of it have changed by the time you move next?
2023-03-03 15:19:12 +00:00
## Description
2023-03-03 15:41:49 +00:00
Frame of Mind is a queer game about mental health.
2023-03-03 15:19:12 +00:00
## Installation
2023-03-03 15:41:49 +00:00
Get [Godot](https://godotengine.org/download) and open the src folder as a new project.
2023-03-03 15:19:12 +00:00
2023-03-27 17:12:30 +00:00
## Building and developing with Nix
### Building
This project can be build with `$ nix-build` or `$ nix build` (flakes).
### Building for Linux without Nix
Use `$ nix bundle`, the resulting binary should be completly self contained.
### Developing
It is recommended to use `direnv`, but `$ nix develop`, `$ nix shell` and `$ nix-shell` also work.
2023-03-03 15:41:49 +00:00
## Support Me
You can support the development of Frame of Mind by
- [Becoming a Patreon](https://www.patreon.com/betalars)
- [Contacting me to Cotnribute Code or Assets](mailto::contact@betalars.de)
2023-03-03 15:19:12 +00:00
## License
2023-03-03 15:41:49 +00:00
- [CC-BY-SA-NC](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.de)
2023-03-03 15:19:12 +00:00
2025-06-04 13:35:33 +00:00
## Project Status
Currently working on getting a beta version out ASAP so we can do final playtests and prepare for polish before launch.
## Save Game Encryption
2025-06-04 13:36:36 +00:00
This is for the super nerds: I have thought about encrypting save games, because some may consider this data to be sensitive. However given that this is an open source project and sharing save games between different devices is expected to work, I choose to not encrypt save games.
2025-06-04 13:35:33 +00:00
My rationale being: I don't want security theatre. Any solution I managed to come up with would be either too clunky for the average user or would not be protecting player data from valve.
If you can suggest a simple solution for encryption that allows for syncing via, is easy to use and cannot be broken by valve, feel free to help me out.
You may also point out if my rationale is irrational.