Gedis

An in-memory, Redis-like datastore for Godot.

Overview

Gedis is a high-performance, in-memory key-value datastore for Godot projects, inspired by Redis. It provides a rich set of data structures and commands. Simply create an instance with var gedis = Gedis.new() and start using it: gedis.set_value("score", 10).

Redis-like? What the heck is Redis? - See Redis in 100 Seconds.

Features

• Strings: Basic key-value storage (set_value, get_value, incr, decr).
• Hashes: Store object-like structures with fields and values (hset, hget, hgetall).
• Lists: Ordered collections of strings, useful for queues and stacks (lpush, rpush, lpop).
• Sets: Unordered collections of unique strings (sadd, srem, smembers).
• Key Expiry: Set a time-to-live (TTL) on keys for automatic deletion (expire, ttl).
• Pub/Sub: A powerful publish-subscribe system for real-time messaging between different parts of your game (publish, subscribe).

Installation

1. Copy the entire addons/Gedis folder into your Godot project's addons directory.
2. In Godot, go to Project -> Project Settings -> Plugins and enable the "Gedis" plugin.
3. The plugin will register an autoloaded singleton named Gedis, which is now available globally in your scripts.

Usage Examples

First, create an instance of Gedis in your script:

# Create a Gedis instance
var gedis = Gedis.new()

Strings

# Set and get a value
gedis.set_value("player_name", "Alice")
var name = gedis.get_value("player_name") # "Alice"

# Increment/decrement a numeric value
gedis.set_value("score", 100)
gedis.incr("score") # 101
gedis.decr("score") # 99

Hashes

# Store player data in a hash
gedis.hset("player:1", "name", "Bob")
gedis.hset("player:1", "hp", 100)
gedis.hset("player:1", "mana", 50)

# Get a single field
var player_name = gedis.hget("player:1", "name") # "Bob"

# Get all fields as a Dictionary
var player_data = gedis.hgetall("player:1") # {"name": "Bob", "hp": 100, "mana": 50}

Lists

# Use a list as a queue for game events
gedis.rpush("events", "player_spawned")
gedis.rpush("events", "enemy_appeared")

# Process the first event in the queue
var event = gedis.lpop("events") # "player_spawned"
var queue_length = gedis.llen("events") # 1

Sets

# Store unique items a player has collected
gedis.sadd("inventory", "sword")
gedis.sadd("inventory", "shield")
gedis.sadd("inventory", "sword") # This will be ignored

# Check if an item exists
var has_shield = gedis.sismember("inventory", "shield") # true

# Get all items
var all_items = gedis.smembers("inventory") # ["sword", "shield"] or ["shield", "sword"]

Key Expiry

# Create a temporary key
gedis.set_value("session_token", "xyz123")
gedis.expire("session_token", 60) # Expires in 60 seconds

# Check the remaining time
var time_left = gedis.ttl("session_token") # e.g., 59

# Make the key permanent again
gedis.persist("session_token")
var time_left_after_persist = gedis.ttl("session_token") # -1 (no expiry)

Pub/Sub System

The Pub/Sub system allows for decoupled communication using signals.

# Subscriber script
var gedis = Gedis.new()

func _ready():
    # Subscribe to the 'game_events' channel and connect to a local method
    gedis.subscribe("game_events", self)
    gedis.connect("pubsub_message", _on_game_event)

func _on_game_event(channel, message):
    print("Received message on channel '%s': %s" % [channel, message])

# Publisher script (can be anywhere else)
var gedis = Gedis.new()

func _on_button_pressed():
    # Publish a message to the 'game_events' channel
    gedis.publish("game_events", "Player pressed the button!")

Pattern-Based Subscriptions

You can also subscribe to channels that match a specific pattern.

# PSubscriber script
var gedis = Gedis.new()

func _ready():
 # Subscribe to all channels starting with 'player:'
 gedis.psubscribe("player:*", self)
 gedis.connect("psub_message", _on_player_event)

func _on_player_event(pattern, channel, message):
 print("Received message on channel '%s' (matched pattern '%s'): %s" % [channel, pattern, message])

# Publisher script
var gedis = Gedis.new()

func _on_some_event():
 gedis.publish("player:login", "Alice logged in")
 gedis.publish("player:logout", "Bob logged out")

Debugger

Gedis comes with a debugger interface!

API Reference

Contribution Instructions

This addon is implemented in GDScript and does not require native compilation. To work on or test the addon, follow these steps:

1. Clone the repository:

   git clone --recursive https://github.com/NodotProject/Gedis.git
   cd Gedis
   

2. Develop & Test:

   • The addon code lives under addons/Gedis. Copy that folder into your Godot project's addons directory to test changes.
   • Run the project's test suite with ./run_tests.sh.

3. Contribute:

   Create a branch, make your changes, and open a pull request describing the work.

License

MIT — see LICENSE for details.