add script to publish

This commit is contained in:
Sir Papate 2023-08-13 13:13:02 -04:00
parent 911adc1e8d
commit 9daf9ac184
7 changed files with 82 additions and 61 deletions

17
.gitattributes vendored
View File

@ -1,17 +0,0 @@
# Auto detect text files and perform LF normalization
* text=auto
# Custom for Visual Studio
*.cs diff=csharp
# Standard to msysgit
*.doc diff=astextplain
*.DOC diff=astextplain
*.docx diff=astextplain
*.DOCX diff=astextplain
*.dot diff=astextplain
*.DOT diff=astextplain
*.pdf diff=astextplain
*.PDF diff=astextplain
*.rtf diff=astextplain
*.RTF diff=astextplain

1
.gitignore vendored
View File

@ -1,2 +1 @@
*.txt
*.cmd

View File

@ -1,3 +1,6 @@
[comment]: <> (## For more information, go to the [GitHub Page][GitHub Page])
[comment]: <> (To convert this file in Steam format, use this website: https://steamdown.vercel.app/)
# EntextaCore
In this core, you can now detect a entity when it spawns or when it gets removed. It adds some useful functions too. And best of all, it adds a system of tag. So basically It allows you to set tags on entities. With it, you can recognize a group of entities without wire and entities marker. There tags are persisting after a duplication.
@ -19,24 +22,24 @@ Clone this repository into your `steamapps\common\GarrysMod\garrysmod\addons` fo
| Declaration | Replacing | Description |
|-------------------------------------|------------------------------------|----------------------------------------|
| `event entitySpawn(Entity:entity)` | runOnEntitySpawn, entitySpawnClk | Triggered when an entity is spawned. |
| `event entityRemove(Entity:entity)` | runOnEntityRemove, entityRemoveClk | Triggered when an entity is removed. |
| event entitySpawn(Entity:entity) | runOnEntitySpawn, entitySpawnClk | Triggered when an entity is spawned. |
| event entityRemove(Entity:entity) | runOnEntityRemove, entityRemoveClk | Triggered when an entity is removed. |
### Tick Functions
| Function | Return | Description |
|---------------------------------------------------------------------------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| `runOnEntitySpawn(number activate)` | void | If set to 1, E2 will run when an entity is spawned. |
| `entitySpawnClk()` | entity | Returns the entity that was spawned. |
| `runOnEntityRemove(number activate)` | void | If set to 1, E2 will run when an entity is removed. |
| `entityRemoveClk()` | entity | Returns the entity that was removed. |
| runOnEntitySpawn(number activate) | void | If set to 1, E2 will run when an entity is spawned. |
| entitySpawnClk() | entity | Returns the entity that was spawned. |
| runOnEntityRemove(number activate) | void | If set to 1, E2 will run when an entity is removed. |
| entityRemoveClk() | entity | Returns the entity that was removed. |
### Info
| Function | Return | Description |
|---------------------------------------------------------------------------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| `entity:creationID()` | number | Returns the entity's creation ID. |
| `entity:children()` | array | Returns entity's creation ID. Unlike E:id(), it will always increase and old values won't be reused. |
| entity:creationID() | number | Returns the entity's creation ID. |
| entity:children() | array | Returns entity's creation ID. Unlike E:id(), it will always increase and old values won't be reused. |
### Tags
@ -44,14 +47,14 @@ Allowing E2s to tag entities. The tags can be used to identify the entity in oth
| Function | Return | Description |
|---------------------------------------------------------------------------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| `entity:addTag(Tag:string)` | void | Adds a tag to the entity. The tag can be used to identify the entity in other E2s. |
| `array:addTag(Tag:string)` | void | Adds a tag to all entities in the array. The tag can be used to identify the entity in other E2s. |
| `entity:removeTag(Tag:string)` | void | Removes a tag from the entity. |
| `array:removeTag(Tag:string)` | void | Removes a tag from all entities in the array. |
| `entity:getTags()` | array | Gets all tags of the entity. |
| `entity:hasTag(Tag:string)` | number | Returns 1 if the entity has the tag, 0 otherwise. |
| `array:haveTag(Tag:string)` | array | Returns an array of 1s and 0s. 1 if the entity has the tag, 0 otherwise. |
| `getEntitiesByTag(Tag:string)` | array | Returns an array of entities with the tag. |
| entity:addTag(Tag:string) | void | Adds a tag to the entity. The tag can be used to identify the entity in other E2s. |
| array:addTag(Tag:string) | void | Adds a tag to all entities in the array. The tag can be used to identify the entity in other E2s. |
| entity:removeTag(Tag:string) | void | Removes a tag from the entity. |
| array:removeTag(Tag:string) | void | Removes a tag from all entities in the array. |
| entity:getTags() | array | Gets all tags of the entity. |
| entity:hasTag(Tag:string) | number | Returns 1 if the entity has the tag, 0 otherwise. |
| array:haveTag(Tag:string) | array | Returns an array of 1s and 0s. 1 if the entity has the tag, 0 otherwise. |
| getEntitiesByTag(Tag:string) | array | Returns an array of entities with the tag. |
### Key-Value
@ -60,40 +63,41 @@ The key-value pair can be used to store data on the entity and can be retrieved
| Function | Return | Description |
|---------------------------------------------------------------------------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| `entity:setKeyValue(Key:string, Value:string)` | void | Sets a key-value pair on the entity. The key-value pair can be used to store data on the entity and can be retrieved by other E2s. |
| `array:setKeyValue(Key:string, Value:string)` | void | Sets a key-value pair on all entities in the array. The key-value pair can be used to store data on the entity and can be retrieved by other E2s. |
| `entity:removeKeyValue(Key:string)` | void | Removes a key-value pair from the entity. |
| `array:removeKeyValue(Key:string)` | void | Removes a key-value pair from all entities in the array. |
| `entity:getKeyValue(Key:string)` | string | Gets the value of a key-value pair on the entity. |
| `entity:getKeyValues()` | table | Gets all key-value pairs on the entity. |
| `getEntitiesByKeyValue(Key:string, Value:string)` | array | Gets all entities with the specified key-value pair. |
| `array:haveKeyValue(Key:string, Value:string)` | array | Returns an array of 1s and 0s. 1 if the entity has the key-value pair, 0 otherwise. |
| entity:setKeyValue(Key:string, Value:string) | void | Sets a key-value pair on the entity. The key-value pair can be used to store data on the entity and can be retrieved by other E2s. |
| array:setKeyValue(Key:string, Value:string) | void | Sets a key-value pair on all entities in the array. The key-value pair can be used to store data on the entity and can be retrieved by other E2s. |
| entity:removeKeyValue(Key:string) | void | Removes a key-value pair from the entity. |
| array:removeKeyValue(Key:string) | void | Removes a key-value pair from all entities in the array. |
| entity:getKeyValue(Key:string) | string | Gets the value of a key-value pair on the entity. |
| entity:getKeyValues() | table | Gets all key-value pairs on the entity. |
| getEntitiesByKeyValue(Key:string, Value:string) | array | Gets all entities with the specified key-value pair. |
| array:haveKeyValue(Key:string, Value:string) | array | Returns an array of 1s and 0s. 1 if the entity has the key-value pair, 0 otherwise. |
### Halo
* `Color:vector` - The desired color of the halo. See Color.
* `BlurX:number` = `2` - The strength of the halo's blur on the x axis.
* `BlurY:number` = `2` - The strength of the halo's blur on the y axis.
* `Passes:number` = `1` - The number of times the halo should be drawn per frame. Increasing this may hinder player FPS.
* `Additive:number` = `1` - Sets the render mode of the halo to additive. (0 or 1)
* `IgnoreZ:number` = `0` - Renders the halo through anything when set to 1. (0 or 1)
* "Color:vector" - The desired color of the halo. See Color.
* "BlurX:number" = "2" - The strength of the halo's blur on the x axis.
* "BlurY:number" = "2" - The strength of the halo's blur on the y axis.
* "Passes:number" = "1" - The number of times the halo should be drawn per frame. Increasing this may hinder player FPS.
* "Additive:number" = "1" - Sets the render mode of the halo to additive. (0 or 1)
* "IgnoreZ:number" = "0" - Renders the halo through anything when set to 1. (0 or 1)
| Function | Return | Description |
|----------------------------------------------------------------------------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| `entity:setHalo(Color:vector, BlurX:number, BlurY:number, Add:number, IgnoreZ:number)` | void | Applies a halo glow effect to the entity. |
| `entity:setHalo(Color:vector, BlurX:number, BlurY:number, Add:number)` | void | Applies a halo glow effect to the entity. |
| `entity:setHalo(Color:vector, BlurX:number, BlurY:number)` | void | Applies a halo glow effect to the entity. |
| `entity:setHalo(Color:vector)` | void | Applies a halo glow effect to the entity. |
| `entity:removeHalo()` | void | Removes the halo from the entity. |
| entity:setHalo(Color:vector, BlurX:number, BlurY:number, Add:number, IgnoreZ:number) | void | Applies a halo glow effect to the entity. |
| entity:setHalo(Color:vector, BlurX:number, BlurY:number, Add:number) | void | Applies a halo glow effect to the entity. |
| entity:setHalo(Color:vector, BlurX:number, BlurY:number) | void | Applies a halo glow effect to the entity. |
| entity:setHalo(Color:vector) | void | Applies a halo glow effect to the entity. |
| entity:removeHalo() | void | Removes the halo from the entity. |
### World Tip
| Function | Return | Description |
|----------------------------------------------------------------------------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| `entity:setWorldTip(string text)` | void | Sets a world tip on the entity. |
| `entity:removeWorldTip()` | void | Removes the world tip from the entity. |
| entity:setWorldTip(string text) | void | Sets a world tip on the entity. |
| entity:removeWorldTip() | void | Removes the world tip from the entity. |
[EntextraCore Workshop Page]: <https://steamcommunity.com/sharedfiles/filedetails/?id=714598720>
[Expression 2 Core Collection]: <https://steamcommunity.com/workshop/filedetails/?id=726399057>
[GitHub Page]: <https://github.com/sirpapate/entextracore>

View File

@ -1,10 +1,16 @@
{
"title" : "[E2] EntextraCore",
"type" : "tool",
"tags" : [ "build" ],
"id" : 714598720,
"title" : "[E2] EntextraCore",
"type" : "tool",
"tags" : [ "build" ],
"ignore" : [
"*.cmd",
"*.gma",
"addonid.txt"
"addonid.txt",
".git*",
"*.md",
".*",
"LICENSE",
"images/*"
]
}

BIN
images/backgroud.jpeg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

BIN
images/icon.jpeg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

29
publish.cmd Normal file
View File

@ -0,0 +1,29 @@
@echo off
REM This script will create a GMA file and publish it to the workshop.
FOR /F "tokens=*" %%g IN ('jq ".id" .\addon.json') do (SET ID=%%g)
if "%ID%" == "" goto no-id
gmad create -folder .\ -out .\addon.gma
if "%1" == "-m" goto with-message
if "%1" == "-message" goto with-message
if "%1" == "-msg" goto with-message
if "%1" == "" goto without-message
:with-message
gmpublish.exe update -id %ID% -addon .\addon.gma [-changes %2]
goto after
:without-message
gmpublish.exe update -id %ID% -addon .\addon.gma
goto after
:no-id
echo "No ID found in addon.json"
goto after
:after
del .\addon.gma