-
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from Nats-ji/cet-sandbox-fix
CET 1.10.0 fix
- Loading branch information
Showing
23 changed files
with
1,399 additions
and
939 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
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,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2021 Mingming Cui | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
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,278 @@ | ||
| # CPStyling.lua | ||
|
|
||
| This project can be found at https://github.com/Nats-ji/CPStyling.lua | ||
|
|
||
| ### What is this | ||
| Made for Cyber Engine Tweaks Mod creation. | ||
| This is a set of color schemes and widgets I made to match the style of Cyberpunk 2077's UI. | ||
| I also included some useful functions for easier and faster ImGui styling. | ||
|
|
||
|
|
||
| Please make PR if you want to fix bugs or make improvements | ||
| ### How to use | ||
| ```lua | ||
| CPS = require "CPStyling" | ||
| theme = CPS.theme | ||
| color = CPS.color | ||
| ``` | ||
|
|
||
| To use `CPS.loadPNG()` and `CPS.CPDraw()` functions, you need to include the `png-lua` library. | ||
|
|
||
| #This project is still WIP, will add more widgets. You can also download the demo to play with it yourself. | ||
|
|
||
|  | ||
|
|
||
| ### Projects using this library | ||
| CP77-TetrisArcade [[Nexus]](https://www.nexusmods.com/cyberpunk2077/mods/1118) | [[Github]](https://github.com/justarandomguyintheinternet/cp77_arcade_tetris) | ||
|
|
||
|  | ||
|
|
||
| CP77-Braindance Protocol [[Nexus]](https://www.nexusmods.com/cyberpunk2077/mods/616) | [[Github]](https://github.com/WolvenKit/BraindanceProtocol) | ||
|
|
||
|  | ||
|
|
||
| ### Utilities | ||
| ```lua | ||
| --Check if a file exists | ||
| CPS.fileExists(filename) | ||
| --returns bool | ||
|
|
||
| --Setup the style for a new window and it's content. | ||
| CPS.setThemeBegin() | ||
| -- ImGui.Begin("I'm a window") | ||
| -- ImGui.End() | ||
| CPS.setThemeEnd() | ||
|
|
||
| --Setup the style for frame items (Checkbox, Combobox, Inputbox, etc.), | ||
| --Needs to be put bellow ImGui.Begin() or window's title will also be bordered. | ||
| CPS.setFrameThemeBegin() | ||
| CPS.setFrameThemeEnd() | ||
|
|
||
| --Same as ImGui.PushStyleColor(ImGuiCol.style, r, g, b, a), but can take any color format. | ||
| CPS.colorBegin(style, color) | ||
| -- style (string): style = "Text" | ||
| -- color can be u32 (number): color = 0x00000000 | ||
| -- color can be rgb (table): color = { 0.40 , 0.17 , 0.12 } | ||
| -- color can be rgba (table): color = { 0.40 , 0.17 , 0.12 , 0.5 } | ||
| -- color can be hex (string): color = "#672b1f" color = "672b1f" | ||
| -- color can be hex with alpha (table): color = { "672b1f", 0.5 } | ||
| CPS.colorEnd(count) --Same as ImGui.PopStyleColor(count) | ||
|
|
||
| ---Example--- | ||
| CPS.colorBegin("Button", { 1, 0, 0, 1 }) | ||
| CPS.colorBegin("Button", "672b1f") | ||
| CPS.colorBegin("Button", theme.Button) -- get color from theme.lua | ||
| CPS.colorBegin("Button", color.blue) -- get color from styles.lua | ||
| ImGui.Button("I'm a Button") | ||
| CPS.colorEnd(1) | ||
|
|
||
| --Same as ImGui.PushStyleVar() | ||
| CPS.styleBegin(style, var1) | ||
| CPS.styleBegin(style, var1, var2) | ||
| -- Same as ImGui.PushStyleVar(ImGuiStyleVar.style, var1, var2) | ||
| -- style (string): style = "ChildRounding" | ||
| -- var1 (float), var2 (float) | ||
| CPS.styleEnd(count) -- Same as ImGui.PopStyleVar(count) | ||
|
|
||
| ---Example--- | ||
| CPS.styleBegin("FrameBorderSize", 5) | ||
| ImGui.Button("I'm a bordered button", 200, 30) | ||
| CPS.styleEnd(1) | ||
| ``` | ||
| ### Cyberpunk Style Widgets | ||
|
|
||
| CPButton: | ||
|
|
||
|  | ||
| ```lua | ||
| press = CPS.CPButton(label) | ||
| press = CPS.CPButton(label, sizex, sizey) | ||
| -- label (string), sizex (float), sizey (float) | ||
| -- Returns press (bool) | ||
|
|
||
| ---Example--- | ||
| btn1 = CPS.CPButton("Btn1") | ||
| btn2 = CPS.CPButton("Btn2", 50, 30) | ||
| ``` | ||
| CPToggle: | ||
|
|
||
|  | ||
| ```lua | ||
| value, press = CPS.CPToggle(label, label_on, label_off, value, sizex, sizey) | ||
| -- label (string), label_on (string), label_off (string), value (bool), sizex (float), sizey (float) | ||
| -- Returns value (bool), press (bool) | ||
|
|
||
| ---Example--- | ||
| value, press = CPS.CPToggle("Toggle godmode", "OFF", "ON", value, 180, 0) | ||
| ``` | ||
| CPToolTip: | ||
|
|
||
|  | ||
| ```lua | ||
| CPS.CPToolTip1Begin(sizex, sizey) | ||
| -- ImGui.Text("This is a CPToolTip1") | ||
| CPS.CPToolTip1End() | ||
|
|
||
| CPS.CPToolTip2Begin(sizex, sizey) | ||
| -- ImGui.Text("This is a CPToolTip2") | ||
| CPS.CPToolTip2End() | ||
| ``` | ||
| CPRect: | ||
|
|
||
|  | ||
| ```lua | ||
| press = CPS.CPRect1(label, sizex, sizey, color, border_color [O], border_size [O], border_rounding [O], textalignx [O], textaligny [O]) | ||
| -- lable (string), sizex (float), sizey (float), color (any format), border_color (any format) | ||
| -- border_size (float), border_rounding (float), textalignx (float), textaligny (float) | ||
| -- Returns press (bool) | ||
|
|
||
| CPS.CPRect2(text_id, sizex, sizey, color) | ||
| -- text_id (string), sizex (float), sizey(float), color (any format) | ||
| -- Faster than CPRect1 but without return value. | ||
| -- Also used in CPS.CPDraw() | ||
|
|
||
| ---Example--- | ||
| -- Draw a red 50x50 Circle | ||
| CPS.CPRect1("##circle", 50, 50, {0,0,0,0}, color.red, 5, 25) | ||
| -- Draw a green rounded rectangle with a brown border and text inside aligned to the right. | ||
| CPS.CPRect1("I'm the text", 150, 50, color.green, color.brown, 3, 10, 1, 0.5) | ||
| ``` | ||
| loadPNG and CPDraw: | ||
|
|
||
|  | ||
|
|
||
| ```lua | ||
| -- Load a png image from file | ||
| image = CPS.loadPNG(path_to_png) | ||
| -- Return image = { wdith = int, height = int, pixels = { | ||
| [1]:{ | ||
| [1]:{ R, G, B, A }, | ||
| [2]:{ R, G, B, A }, | ||
| ...... | ||
| }, | ||
| [2]:{ | ||
| ...... | ||
| }, | ||
| ..... | ||
| } | ||
| -- Draw the png image | ||
| CPS.CPDraw(text_id, image, scale) | ||
| -- text_id (string), image (table), scale (number) | ||
|
|
||
| ---Example--- | ||
| image = CPS.loadPNG("./images/logo.png") | ||
| CPS.CPDraw("logo", image, 5) | ||
| ``` | ||
|
|
||
| ### Color Names | ||
| ```lua | ||
| "red" | ||
| "cyan" | ||
| "blue" | ||
| "darkblue" | ||
| "lightblue" | ||
| "purple" | ||
| "yellow" | ||
| "lime" | ||
| "magenta" | ||
| "white" | ||
| "silver" | ||
| "grey" | ||
| "black" | ||
| "orange" | ||
| "brown" | ||
| "maroon" | ||
| "green" | ||
| "olive" | ||
| ``` | ||
|
|
||
|
|
||
| ### ImGui style names | ||
| Color | ||
| ```lua | ||
| "Text" | ||
| "TextDisabled" | ||
| "WindowBg" | ||
| "ChildBg" | ||
| "PopupBg" | ||
| "Border" | ||
| "BorderShadow" | ||
| "FrameBg" | ||
| "FrameBgHovered" | ||
| "FrameBgActive" | ||
| "FrameBgDisabled" | ||
| "FrameBgHoveredDisabled" | ||
| "FrameBgActiveDisabled" | ||
| "TitleBg" | ||
| "TitleBgActive" | ||
| "TitleBgCollapsed" | ||
| "MenuBarBg" | ||
| "ScrollbarBg" | ||
| "ScrollbarGrab" | ||
| "ScrollbarGrabHovered" | ||
| "ScrollbarGrabActive" | ||
| "CheckMark" | ||
| "CheckMarkTrueDisabled" | ||
| "CheckMarkFalseDisabled" | ||
| "SliderGrab" | ||
| "SliderGrabActive" | ||
| "Button" | ||
| "ButtonHovered" | ||
| "ButtonActive" | ||
| "Header" | ||
| "HeaderHovered" | ||
| "HeaderActive" | ||
| "Separator" | ||
| "SeparatorHovered" | ||
| "SeparatorActive" | ||
| "ResizeGrip" | ||
| "ResizeGripHovered" | ||
| "ResizeGripActive" | ||
| "Tab" | ||
| "TabHovered" | ||
| "TabActive" | ||
| "TabUnfocused" | ||
| "TabUnfocusedActive" | ||
| "DockingPreview" | ||
| "DockingEmptyBg" | ||
| "PlotLines" | ||
| "PlotLinesHovered" | ||
| "PlotHistogram" | ||
| "PlotHistogramHovered" | ||
| "TextSelectedBg" | ||
| "DragDropTarget" | ||
| "NavHighlight" | ||
| "NavWindowingHighlight" | ||
| "NavWindowingDimBg" | ||
| "ModalWindowDimBg" | ||
| "ModalWindowDarkening" | ||
| "COUNT" | ||
| ``` | ||
|
|
||
| StyleVar | ||
| ```lua | ||
| "Alpha" | ||
| "WindowPadding" | ||
| "WindowRounding" | ||
| "WindowBorderSize" | ||
| "WindowMinSize" | ||
| "WindowTitleAlign" | ||
| "ChildRounding" | ||
| "ChildBorderSize" | ||
| "PopupRounding" | ||
| "PopupBorderSize" | ||
| "FramePadding" | ||
| "FrameRounding" | ||
| "FrameBorderSize" | ||
| "ItemSpacing" | ||
| "ItemInnerSpacing" | ||
| "IndentSpacing" | ||
| "ScrollbarSize" | ||
| "ScrollbarRounding" | ||
| "GrabMinSize" | ||
| "GrabRounding" | ||
| "TabRounding" | ||
| "SelectableTextAlign" | ||
| "ButtonTextAlign" | ||
| "COUNT" | ||
| ``` |
Oops, something went wrong.