-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Importing Lydie | ||
|
||
When integrating Lydie as a variable within your code, it yields a structured dictionary in the Lua programming language. The dictionary structure is as follows: | ||
```lua title="Lydie.luau" | ||
{ | ||
Components = require(script.Components), | ||
Modules = require(script.Modules), | ||
} | ||
``` | ||
|
||
- `Components`: This key accesses a dictionary containing a comprehensive collection of UI components accessible within Lydie. These components are categorized based on their functionality, distinguishing between interactive elements and window decorations. | ||
- `Modules`: This key provides access to another dictionary housing the modules packaged with Lydie. These modules play a pivotal role in constructing the various components available within Lydie's interface. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Using Lydie | ||
|
||
Lydie follows the same code pattern found in Fusion, all components are wrapped in a function and can be created by calling it with the properties table. Like: | ||
```lua | ||
local Lydie = require(Packages.Lydie) | ||
|
||
Lydie.Components.Divider { | ||
Size = UDim2.new(1, 0, 0, 1), | ||
ZIndex = 2, | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Installing Lydie | ||
|
||
Lydie is built around Wally packages, because of that, installation of Lydie and its dependencies should be installed the same as how Wally intended to. | ||
|
||
### with wally <small>recommended</small> { #with-rojo data-toc-label="with rojo" } | ||
|
||
Lydie is published as a [Wally](https://wally.run) package and can be installed as long as your game source code is saved in the filesystem. Edit your `wally.toml` configuration file and install the package: | ||
|
||
```toml title="wally.toml" | ||
[dependencies] | ||
Fusion = "elttob/[email protected]" | ||
Lydie = "7kayoh/[email protected]" | ||
``` | ||
|
||
```sh title="terminal" | ||
wally install | ||
``` | ||
|
||
This will install Lydie into the `Packages` directory, the actual location of the folder in-game depends on your Rojo project configuration, but it is usually in `ReplicatedStorage`. | ||
|
||
## with rbxm | ||
|
||
If you edit your game in Roblox Studio, it may be more appropriate to directly install Lydie with the released `rbxm` file from the repository. Download the latest release [here](https://github.com/7kayoh/lydie/releases) and insert it into your game. |