You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+44-11Lines changed: 44 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,28 +3,40 @@ Python-like scripting language which transpiles into Overwatch Workshop script r
3
3
4
4
## Setup
5
5
Installation
6
-
====================
6
+
============
7
7
1. Install Python with `pip` if you have not done so already.
8
8
2. Install the requirements using `pip install -r requirements.txt` on your machine.
9
-
3.~Run the command `python owscript.py <filename>` to convert a file into workshop rules.~
9
+
3. Run the command `python OWScript.py` with the following arguments:
10
+
-`input` Path to input file, blank for stdin
11
+
-`-m | --min` Optional: minifies the output by stripping whitespace
12
+
-`-s | --save [FILE]` Optional: saves to the target output file instead of stdout
13
+
14
+
## Syntax Highlighting
15
+
In the `Syntax/` folder, you can find the raw Iro code which I used to generate a Sublime Text file with modifications. You can directly import the `OWScript.sublime-syntax` file by putting it in your ST3 `User` folder.
10
16
11
17
## Documentation
12
-
*See example code in the `Examples/` folder. `.ows` files are input, `.ow` files are output.*
18
+
*See example code in the `Examples/` folder.*
19
+
Input File: `*.owpy`
20
+
Output File: `*.ows` (standard as agreed upon voting results)
- Be sure not to conflict variable/function names with built-in functions such as `Add`, `Wait`, or `Damage`.
39
+
- Many commonly used values have been aliased in order to reduce verbosity. See the table at the bottom for the list of built-in aliases.
28
40
29
41
Values / Actions
30
42
================
@@ -65,7 +77,8 @@ x = x ^ (x + x) % 3
65
77
66
78
Logic
67
79
=====
68
-
Boolean logic is implemented exactly as in Python. The operators `and`, `or`, and `not` function as C-style `&&`, `||`, and `!`. Comparison operators include the traditional `<`, `>`, `<=`, `>=`, `!=`, `==` as well as containment operators `in` and `not in`.
80
+
Boolean logic is implemented exactly as in Python. The operators `and`, `or`, and `not` function as C-style `&&`, `|
81
+
|`, and `!`. Comparison operators include the traditional `<`, `>`, `<=`, `>=`, `!=`, `==` as well as containment operators `in` and `not in`.
69
82
```
70
83
x = True and not True
71
84
Count Of
@@ -207,4 +220,24 @@ The while loop is syntactic sugar for using the `Loop` action in the Workshop. A
0 commit comments