Repository navigation
Getting started (Making new 3D GUI)
G3 is a Roblox module intended to make 3D GUI a breeze
-
g3Gui
This datatype functions as a container for parts, like ScreenGUIs
Updating the position of a GUI moves all of the GUIs parts with it, but not any of its children GUIAccess its core instance (Model) using myG3Gui.Model
-
g3Part
This datatype functions as a UI element as a part, like frames or labels
You can retrieve any part easily by using
g3.FindFirstChild(source: array of g3.part, name: string)
This searches through an array of g3Parts (Like g3Gui.Parts or _G.G3.allParts)
and spits out the first g3Part with the given nameAccess its core instance (BasePart) using myG3Part.Part
-
g3Point
This datatype is used internally to determine where to move G3 objects. Consists of Position, Rotation, RotationCenter, and Offset
In the documentation, g3Any is referring to either of these 2 types
You can create 3D GUI from scratch, and this works similarly to making new parts and models from Instance.new()
To start, you have to make the GUI (The container for parts). This is quite simply done with g3.NewGui(name: string)
All new G3 GUI starts off with default 3 offset
With that, you can either:
- Bind parts to the GUI (Attach a workspace part to the GUI) using
g3.BindPartToGui(g3Gui: g3.gui, part: BasePart) - Create new parts to the G3 GUI by using
g3.NewPartToGui(g3Gui: g3.gui, name: string)
All new G3 parts start off with default 1 offset
New parts are created as 1x1x1 massless, clientside and noncolliding cubes
You can also create G3 GUI by converting a model into one. Creating GUI this way is a completely separate workflow than starting from scratch
To convert a model into a 3D GUI, use g3.FromModel(model: Model)
Converting models into GUI does come with intricacies.
-
All BaseParts have to parented to a model (Excluding the converting model itself)
This is moreso to make using G3 simpler, as it would mean all parts would have a central command to control as a group (a model)
-
Models are converted from the "Back" point of view
This is just a way to standardize model conversions into one absolute point of view, which makes G3 simpler
Getting Started / Making new 3D GUI
General properties of G3 objects
Prevent GUI being hidden behind the Player
Prevent GUI being obscured by the surroundings
Boost performance by merging parts
If you are interested in G3 expanding beyond a passion project, or if you want to boost G3 along with its development and see more advanced features, please donate!
Donations mean a lot of me, as they are direct proof that I'm going in the right direction. Donating even a dollar would mean so much to not only me but the rest of my family.
