Skip to content

Commit a19017d

Browse files
JBrosDevelopmentJBrosDevelopment
committed
Added Wiki Docs to Main Repo
1 parent 13cf338 commit a19017d

7 files changed

Lines changed: 1412 additions & 0 deletions

File tree

‎docs/EZCode-Docs.md‎

Lines changed: 896 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/EZProject-Docs.md‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
# EZProj
2+
3+
<details open>
4+
<summary>Directory</summary>
5+
6+
- [Syntax](#syntax)
7+
- [Properties](#properties)
8+
- [Variables](#vars)
9+
- [Comments](#comments)
10+
- [Code Seperation](#code-seperation)
11+
- [Examples](#examples)
12+
</details>
13+
14+
## Syntax
15+
16+
The Syntax is simple,
17+
```
18+
name:"Hello World Test"
19+
icon:"~/icon.ico"
20+
startup:"~/Main.ezcode"
21+
```
22+
It's the [property](#propery), a colon `:`, and then the value in quotations `""`.
23+
24+
## Properties
25+
26+
<details open>
27+
<summary>Properties</summary>
28+
29+
- [Clearconsole](#clear-console)
30+
- [Closeonend](#close-on-end)
31+
- [Debug](#debug)
32+
- [Exclude](#exclude)
33+
- [Fileinerror](#file-in-error)
34+
- [Icon](#icon)
35+
- [Include](#include)
36+
- [Isvisual](#is-visual)
37+
- [Name](#name)
38+
- [Showbuild](#show-build)
39+
- [Startup](#start-up)
40+
- [Window](#window)
41+
</details>
42+
43+
### Clear Console
44+
45+
The `clearconsole` property will clear the console before playing the program.
46+
47+
Default = "True"
48+
49+
### Close On End
50+
51+
the `closeonend` property will Stop the program when the program ends.
52+
53+
Default = "True"
54+
55+
### Debug
56+
57+
The `debug` property will Open a Debug window if the project property [Window](#window) is true. This Debug window contains a console and a quit button.
58+
59+
Default = "False"
60+
61+
### Exclude
62+
63+
The `exclude` property excludes files in the program. It takes a full or local file path (`~/` or `~\`) that has the EZCode extension `.ezcode`. It can also take `"all"` or `"folder"`.
64+
- `"all"`: will get all of the files in the current directory. It will get all `.ezcode` files including sub directories.
65+
- `"folder"`: will get all of the files in the current folder. It will not get any sub directories.
66+
67+
This is especially used when [Include](#include) proprety has `"all"` but a file or two needs to be excluded.
68+
69+
### File In Error
70+
71+
The `fileinerror` will show the file path the error occured in when an error occurers.
72+
73+
Default = "True"
74+
75+
### Icon
76+
77+
The `icon` property is the Icon of the program. It takes a file path with a `.ico` extension. The path can be local using `~/` or `~\`.
78+
79+
Default = "C:\\Users\\<USER_NAME>\\AppData\\Roaming\\EZCode\\EZCode\\EZCode_Logo.ico"
80+
81+
### Include
82+
83+
The `include` property includes files into the program. It takes a full or local file path (`~/` or `~\`) that has the EZCode extension `.ezcode`. It can also take `"all"` or `"folder"`.
84+
- `"all"`: will get all of the files in the current directory. It will get all `.ezcode` files including sub directories.
85+
- `"folder"`: will get all of the files in the current folder. It will not get any sub directories.
86+
87+
### Is Visual
88+
89+
The `isvisual` proprety will tell the program that the code uses the [visual-output](Programs#visual-output).
90+
91+
Default = "False"
92+
93+
### Name
94+
95+
The `name` property sets the name of the program.
96+
97+
Default = "EZCode_v{EzCode.Version}"
98+
99+
### Show Build
100+
101+
The `showbuild` property will show `Build Started` and `Build Ended` whenever the program starts and ends.
102+
103+
Default = "False"
104+
105+
### Start Up
106+
107+
The `startup` property sets the start up file for the program. Takes a full or local path (`~/` or `~\`). If there is only one file in the program, then using both `include` and `startup` is not needed, just choose one of them. See the example in [Syntax](#syntax).
108+
109+
The Default is the first file that was included. If includes `"all"`, the first on alphabetically.
110+
111+
### Window
112+
113+
The `window` property tells the program that this program uses one or more windows.
114+
115+
## Variable
116+
117+
This is a more complex use of EZProj syntax. To declare a variable, just put its name in quotation marks and the value on the other side of the colon also in quotation marks,
118+
```
119+
"varName":"value"
120+
```
121+
Then to use the variable,
122+
```
123+
isvisual:"varName"
124+
```
125+
126+
Another feature of variables is to read a file and get its value from that. It will read the file if the value side does not contain any quotations. Here is an example,
127+
```
128+
"varName":~/file.txt
129+
```
130+
131+
## Comments
132+
133+
Comments are apart of the code that doesn't run. It is started with // and the rest of that line is excluded from being executed. Here is an example, `name:"Hello World Test" // This sets the project name to 'Hello World Test' and doesn't cause any errors becaues of the presence of '//'`.
134+
135+
## Code Seperation
136+
137+
Each line of code is seperated by a newline, or the pipe character `|`. Here is an example,
138+
139+
```
140+
isvisual:"true" | clearconsole:"false"
141+
```
142+
143+
## Examples
144+
145+
Here is an example of a program that contains [windows](ezcode-docs#window).
146+
```
147+
name:"Hello World Test"
148+
window:"true"
149+
icon:"~/icon.ico"
150+
startup:"~/Main.ezcode"
151+
include:"all"
152+
```
153+
154+
Here is an example of a program that uses the [visual-output](Programs#visual-output).
155+
```
156+
name:"Visual Test"
157+
isvisual:"true"
158+
startup:"~\Main.ezcode"
159+
```
160+
161+
Here is an example of a program that just uses the [console](Programs#console).
162+
```
163+
name:"Console Test"
164+
startup:"~\Main.ezcode"
165+
```

‎docs/Home.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
![Main Image](https://github.com/JBrosDevelopment/EZCode/blob/master/docs/Images/EZCode_Wide_Logo.png)
2+
3+
# Welcome to the EZCode Wiki
4+
5+
### Overview
6+
7+
Welcome to the official documentation for EZCode, a powerful programming language designed to make coding easy and efficient. This wiki serves as a comprehensive resource for developers, providing detailed information on the language, its features, and how to use it effectively.
8+
9+
### Files
10+
11+
EZCode's supported file extensions are _.ezcode_ and _.ezproj_. The _ezcode_ extension should have EZCode in it with it's specific syntax. The _ezproj_ has the EZProject Syntax that acts as the entry part for the program.
12+
13+
### Syntax
14+
15+
EZCode has simple syntax designed to make coding easy. There are two sets of syntax, the main one being [EZCode](EZCode-Docs). The second syntax is [EZProj](EZProject-Docs).
16+
17+
### Programs
18+
19+
There are many programs that make up EZCode. To make it simple and prevent any errors, [EZCode Installer](https://github.com/JBrosDevelopment/EZCode/releases/latest) was created to download the necessary programs and give optional installation for other programs. One of the programs (Test Environment) isn't on the Installer because it isn't made for just any user. If that is something that you might like to install, download it directly from GitHub yourself! The current list of the programs available to download from the [Installer](Programs#installer) are: [EZ Player](Programs#ezplayer), [SLN Builder](Programs#sln-builder), and the [EZ Integrated Development Environment (IDE).](Programs#ez-ide)
20+
21+
### Website
22+
23+
You can find EZCode at [The Official EZCode Website](https://ez-code.web.app). You can also find it on the [JBros Development Page](https://jbros-development.web.app).
24+
25+
---
26+
27+
Thank you for choosing EZCode! We hope this wiki helps you become proficient in EZCode programming. If you have any questions or need further assistance, don't hesitate to ask in the [discussion board](https://github.com/JBrosDevelopment/EZCode/discussions). Also join our [Discord Server](https://discord.gg/DpBrp6Zy)
28+
__

0 commit comments

Comments
 (0)