Hydrogen

A Framework for Roblox designed to handle things that you would rather not.

---

WARNING: Hey There! Please note that Hydrogen is NOT finished and contains MANY issues and no official documentation

These will come with due time after the project has been battle-tested, however feel free to use Hydrogen if you figure it out!

Install

With pesde

pesde add teamhydrogen/hydrogen
pesde install

In File

pesde.toml:

[dependencies]
hydrogen = { name = "teamhydrogen/hydrogen", version = "^0.1.0-alphadev-6"}

Usage:

These documents will be very brief as it is just a readme

Hydrogen.Start(Config: {
	ModuleDirectory: any,
	ModuleSuffix: string?,
	RunLifecycles: boolean? | { "PlayerAdded" | "PlayerRemoving" | "CharacterAdded" | "Heartbeat" | "RenderStepped" }?,
})

ModuleDirectory: Where your modules are stored on Server and Client ModuleSuffix: What your modules end in, Defaults to "Handler" RunLifecycles: True for all, select what you can use automatically as a function without needing extra connections

This will load your modules and other Hydrogen aspects like lifecycles and sound, Players will need to be sorted yourself.

Lifecycles

Lifecycles set in Hydrogen.Start can be ran with the following

local Module = {}

function Module.CONNECTION(Args)
end

return Module

For example:

local Module = {}

function Module.PlayerAdded(Player: Player)
end

return Module

This will run every time a player is added

PlayerHandler

This handles player data and saving, being a wrapper for Lapis allowing you to set, get and even handle custom functions when data is updated

This will go more in-depth in the real documentation, however for a README I want to keep it short.

SoundHandler

Plays sounds on Server and/or Client, tries to make sounds completely handled by Client.