rdb-client's Introduction

rdb-client

This is a client used to interact with rdb, the Realm database of mods.

Submitting a mod

You should have a few things ready:

The URL to your mod icon. must be a 128x128 PNG or JPG
The URL to your mod binary. must be a GitHub release asset, Google Drive file, or Discord attachment
Somewhere to write a password down for later

Once you've got that, just download and run the program.

What to put for each field

FIELD	DESCRIPTION
secret	Essentially a password. Write this down somewhere and keep it secret.*
name	The mod's name.
owner	The person or team of people that made the mod.
version	The mod's current version that increases after each update.
description	[Optional] A brief description of the mod.
icon	URL to a 128x128 PNG or JPG file.
binary	URL to a GitHub release asset, Google Drive file, or Discord attachment. Should be a ZIP or DLL file.
homepage	[Optional] A URL users can visit to learn more about the mod.

* When submitting a new mod, the secret field can be anything you want. When updating the mod later, the secret field must match, or you won't be able to update your mod. If you lose your secret, contact Dual (Discord ID 303617148411183105).

Integrating with GitHub

Submitting mods over and over can be tedious. To fix this, you can add a webhook to your GitHub repository. Every time you publish a release, it will be reflected on rdb.

Video example of setup

rdb.webhook.setup.mp4

How the webhook works

FIELD	WHERE IT COMES FROM
secret	Given in the URL query parameter.
name	The repository's name.
owner	The repository's owner.
version	The release's tag name excluding any "v" prefix.
description	The repository description at the time of publishing.
icon	The file "icon.png" in the repository's root.
binary	The release's last asset when sorted alphabetically.
homepage	The repository's homepage or readme URL.

Recommend Projects