https://github.com/quasilyte/gdata
A gamedata package that provides convenient cross-platform storage for games
https://github.com/quasilyte/gdata
ebiten ebitengine gamedev go golang
Last synced: 4 months ago
JSON representation
A gamedata package that provides convenient cross-platform storage for games
- Host: GitHub
- URL: https://github.com/quasilyte/gdata
- Owner: quasilyte
- License: mit
- Created: 2023-11-04T17:42:51.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-30T17:28:39.000Z (6 months ago)
- Last Synced: 2024-10-11T11:48:16.580Z (4 months ago)
- Topics: ebiten, ebitengine, gamedev, go, golang
- Language: Go
- Homepage:
- Size: 20.5 KB
- Stars: 21
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gdata
[](https://pkg.go.dev/mod/github.com/quasilyte/gdata)
A gamedata package that provides convenient cross-platform storage for games.
Some examples of such gamedata that you might want to store:
* Game settings
* Save states
* Replays
* Pluging/mods metadata
This package was made with [Ebitengine](https://github.com/hajimehoshi/ebiten/) in mind, but it should be usable with any kind of a game engine for Go.
Platforms supported:
* Windows (file system, AppData)
* Linux (file system, ~/.local/share)
* MacOS (file system, ~/.local/share)
* Android (file system, app data directory)
* Browser/wasm (local storage)
This library tries to use the most conventional app data folder for every platform.
It provides a simple key-value style API. It can be considered to be a platform-agnostic localStorage.
This package was part of my game development framework which I used in all of my Go-powered games. Now I'm feel like it's ready to become a part of the ecosystem.
## Installation
```bash
go get github.com/quasilyte/gdata
```
## Quick Start
```go
package main
import (
"fmt"
"github.com/quasilyte/gdata/v2"
)
func main() {
// m is a data manager; treat it as a connection to a filesystem.
m, err := gdata.Open(gdata.Config{
AppName: "mygame",
})
if err != nil {
panic(err)
}
if err := m.SaveObjectProp("core", "save.data", []byte("mydata")); err != nil {
panic(err)
}
if err := m.SaveObjectProp("core", "settings.json", []byte("settings")); err != nil {
panic(err)
}
result, err := m.LoadObjectProp("core", "save.data")
if err != nil {
panic(err)
}
fmt.Println("=>", string(result)) // "mydata"
fmt.Println(m.ObjectExists("core")) // true
fmt.Println(m.ObjectPropExists("core", "save.data")) // true
fmt.Println(m.ObjectPropExists("core", "settings.json")) // true
{
propKeys, err := m.ListObjectProps("core")
if err != nil {
panic(err)
}
for _, p := range propKeys {
v, err := m.LoadObjectProp("core", p)
if err != nil {
panic(err)
}
fmt.Println("key=", p, "value=", string(v))
}
}
fmt.Println(m.ObjectPropExists("core", "save.data")) // true
}
```