Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
unknown-gd authored Jan 24, 2024
1 parent 57882a6 commit 760c9ec
Showing 1 changed file with 21 additions and 9 deletions.
30 changes: 21 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,34 @@
# VGUI Tools
A small pack of console commands for the vgui developer in Garry's Mod.
A small pack of console commands for vgui development in Garry's Mod.

### How to install
1. Download `vgui-cleanup.zip` from the [latest release](https://github.com/PrikolMen/vgui-cleanup/releases/latest).
2. Unzip the downloaded zip into the `garrysmod/addons/` folder.

## Where is Lua code?
Written in [Yuescript](https://github.com/pigpigyyy/Yuescript), compiled Lua code can be found in [releases](https://github.com/PrikolMen/vgui-cleanup/releases), or you can compile it yourself using compiled [Yuescript Compiler](https://github.com/pigpigyyy/Yuescript/releases/latest).

### Commands
- `vgui_remove <pattern>` - allow you remove `vgui` panels using [`patterns`](https://wiki.facepunch.com/gmod/Patterns)
- `vgui_list <start pos/end pos> <end pos>` - outputs the list of all valid panels to the console, you can specify the length of the output list or the start and end points in the list.
- `vgui_remove_all <pattern>` - same as `vgui_remove`, but for all panels including children.
- `vgui_list <start pos/end pos> <start pos/end pos>` - outputs the list of all valid panels to the console, you can specify the length of the output list or the start and end points in the list.
- `vgui_find <pattern>` - display the list of found panels using [`patterns`](https://wiki.facepunch.com/gmod/Patterns)

### Examples

#### List of the first 10 panels
![image](https://github.com/PrikolMen/vgui-tools/assets/44779902/022d6864-b021-4c6b-8847-bc3a33d18580)
![image](https://github.com/PrikolMen/vgui-tools/assets/44779902/f2550f9f-6fe0-461b-8d31-a66bb8484007)
#### `vgui_list` usage
![image](https://github.com/PrikolMen/vgui-tools/assets/44779902/5d9143d5-c818-427c-9127-a72a7c90c4e9)
![image](https://github.com/PrikolMen/vgui-tools/assets/44779902/705c6414-86af-400b-8b32-348d110672ce)
![image](https://github.com/PrikolMen/vgui-tools/assets/44779902/4c695020-2fa0-4d68-bbd5-4a1558bc1013)

#### `vgui_find` usage
![image](https://github.com/PrikolMen/vgui-tools/assets/44779902/18ceb8e3-158f-4802-aad5-7299f65f6de1)
![image](https://github.com/PrikolMen/vgui-tools/assets/44779902/15e4e849-2fe2-4a1a-a1a4-9c427abd0514)

#### Panel list from 10 to 25
![image](https://github.com/PrikolMen/vgui-tools/assets/44779902/cbea973e-3150-4a77-a37d-0a42cb4be1dc)
#### `vgui_remove` usage
![image](https://github.com/PrikolMen/vgui-tools/assets/44779902/ad7b5cb0-89e6-454b-b998-dc61cad890f1)
![image](https://github.com/PrikolMen/vgui-tools/assets/44779902/29c8a4d9-2678-48d9-9c2d-2790074c533c)

#### Removing all lua created panels
![image](https://github.com/PrikolMen/vgui-tools/assets/44779902/72bebd93-38ce-44f3-a6c7-13e76f7d7c1f)
#### `vgui_remove_all` usage
![image](https://github.com/PrikolMen/vgui-tools/assets/44779902/270cdbec-2f7c-47ee-ba1f-d744bf50ee72)
![image](https://github.com/PrikolMen/vgui-tools/assets/44779902/36dcaace-bc71-4d19-a7b5-dbed2ef75084)

0 comments on commit 760c9ec

Please sign in to comment.