https://github.com/shomykohai/godot-keyring
🔑 A godot gdextension to interact with the OS keyring
https://github.com/shomykohai/godot-keyring
credential-storage godot godot-addons godot4 godotengine keychain libsecret
Last synced: about 1 month ago
JSON representation
🔑 A godot gdextension to interact with the OS keyring
- Host: GitHub
- URL: https://github.com/shomykohai/godot-keyring
- Owner: shomykohai
- License: mit
- Created: 2024-10-29T08:11:27.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-04-28T10:28:29.000Z (about 2 months ago)
- Last Synced: 2025-05-09T01:18:05.127Z (about 1 month ago)
- Topics: credential-storage, godot, godot-addons, godot4, godotengine, keychain, libsecret
- Language: C++
- Homepage:
- Size: 38.1 KB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- trackawesomelist - Keyring (⭐2) - Utility to interact with the OS keyring to store credentials. (Recently Updated / [Oct 31, 2024](/content/2024/10/31/README.md))
README
🔑 Godot Keyring
"Godot Keyring" is a Godot addon to interact with the OS keyring.
The addon itself is a wrapper of [keychain](https://github.com/hrantzsch/keychain) by [@hrantzsch](https://github.com/hrantzsch/) to allow cross-platform support.
## 📙 Usage
```gdscript
#some_node.gd
func store_password(user: String, password: String) -> void:
if password.is_empty() or user.is_empty():
print("Trying to store non valid credentials.")
return
Keyring.set_password("my_cool_application", "credentials", user, password)
func login(user: String) -> void:
var password := Keyring.get_password("my_cool_application", "credentials", user)
if password.is_empty():
return
# Use password
...
```
## 🛠️ Building
**Requirements**
* [SCons](https://www.scons.org/)
* [python3](https://www.python.org/)
* libsecret (Linux only)
Run the scons command to build the addon:
```bash
$ scons
```
You can also specify to which platform compile:
```bash
$ scons platform=windows
```
## ✨ Credits
"Godot Keyring" logo by [@archaeopteryz](https://github.com/archaeopteryz)
## 💼 License
Licensed under the MIT license, see [LICENSE](LICENSE)
The code in ["src/keychain"](src/keychain/) is licensed under the MIT license, see [keychain/LICENSE](src/keychain/LICENSE)