Home
Eggscript is an extension of TorqueScript, adding various new features which make programming in the archaic language a little easier.
Each extension is described in a page of this wiki.
This is an extension of TorqueScript, as mentioned above. What this means is eggscript keeps the same syntax and grammar of TorqueScript while adding on extensions via additional syntax. The file format of eggscript is the .egg file. In one of these files, you will write TorqueScript but you will also be able to use the extensions provided by eggscript. Any syntax will transpile down to TorqueScript when the eggscript transpiler program is run. Think Typescript, but for TorqueScript instead of Javascript.
This currently is a WIP and is open to extension suggestions. To suggest a feature, create an issue with the "suggestion" label and explain your submission in detail. If it is an extension of syntax, provide some examples and what the examples will polyfill to. Also, if you have a problem with any of the syntax the eggscript extensions use, also feel free to open an issue and suggestion alternatives.
Play around with eggscript here: https://bansheerubber.com/eggscript/
There are two executables provided. One of them is a bash file, and the other is a Windows .cmd file. The differences are not important, and the usage between the two is the same.
To use, type eggscript [a .egg file] into the command line. This will transpile a .egg file into a .cs file with the same name in the same directory. There are some more complicated options that can be used. The -o or --output argument can be used to switch the output directory for the file. For instance, eggscript -o ./Add-Ons/Server_Example/ server.egg will transpile the server.egg file into server.cs and store the results in the relative path ./Add-Ons/Server_Example/. eggscript also supports transpiling entire directores by supplying a directory instead of a .egg file to the command. For instance, eggscript -o ./Add-Ons/Server_Example/ ./Server_Example-dev/ will look through all files and subdirectories in ./Server_Example-dev/ and transpile any .egg files to ./Add-Ons/Server_Example/. There are other arguments you can view by running eggscript --help in the console. Arguments must come before the files or directories you include, or else the program will encounter errors.
It is recommended that you add the directory you download eggscript into to your PATH env variable. Look up how to do it for your operating system. This will allow you to use the eggscript command from anywhere in the OS.
By default, eggscript only recognizes .egg files. You can use the -c or --include-cs argument to include .cs files as well.
Any metadata files eggscript requires will be stored in the .eggscript directory in the same directory you run eggscript.