wucket/Z-Sharp
1
0
Fork 0
mirror of https://github.com/sam-astro/Z-Sharp.git synced 2025-12-11 16:22:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
sam-astro 2022-05-21 23:47:51 -04:00 committed by GitHub
parent 31c287c88a
commit ffc10d13e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -1,15 +1,16 @@
<img src="https://raw.githubusercontent.com/sam-astro/Z-Sharp/master/ExtraResources/ZS-Gem-Icon-Small.png"/><img src="https://raw.githubusercontent.com/sam-astro/Z-Sharp/master/ExtraResources/ZS-Logo-Light-Small.png"/>
## Introduction
Z-Sharp is a custom programming language I made because I don't like c++ very much (Z-Sharp's interpreter is written in c++ though). It used to be called Slang, standing for "Stupid Lang", but another programming language called Slang already exists :(. Z-Sharp scripts have the file extension .zs. The base syntax and formatting I would say is quite similar to C#, but differs as task complexity increases. It has support for graphics using SDL2.
If you are thinking about using this language, then you may wish to reconsider. It is quite bare-bones, and doesn't have a lot of features. Also the syntax must be very exact and even a space, a missing space, or using spaces instead of tabs could throw an error.
Z-Sharp is a custom programming language I made because I don't like c++ very much (Z-Sharp's interpreter is written in c++ though). It used to be called Slang, standing for "Stupid Lang", but another programming language called Slang already exists :(. Z-Sharp scripts have the file extension .zs. The base syntax and formatting I would say is quite similar to C#, but differs as task complexity increases. It has support for graphics using SDL2, and by default is not enabled.
## Installation
Downloading or installing is very simple, and you don't need to build it yourself. I recommend the regular version if you are just exploring, and not the installer, because then you don't need to find the executable in your program files. If you plan on developing for a long time though, then you should use the installer and I'll guide you through that after.
### ZSharp Windows x64
1. Navigate to [the most recent release](https://github.com/sam-astro/Z-Sharp/releases) and download `ZSharp-Win-x64.zip`.
2. Unzip `ZSharp-Win-x64.zip` and open the unzipped folder.
3. You will see many files. The Z# interpreter is `ZSharp.exe` and has a Z# icon. Any time you want to execute a script, this is the program that will be used. There are a few ways to use it:
Downloading or installing is very simple, here is how depending on your version and operating system:
### Windows
1. Navigate to [the most recent release](https://github.com/sam-astro/Z-Sharp/releases) and download `ZSharp-Win-Installer.zip`.
2. Unzip `ZSharp-Win-Installer.zip` and open the unzipped folder.
3. Inside is a single file titled `ZSharp-Setup.exe`. Run it, and follow the setup instructions.
4. Now that it is installed, there are a few ways to use it:
* (recommended) Any ZSharp file that ends with .ZS will automatically be associated with the interpreter. Just double-click it, and the interpreter will run.
* Drag and drop any .ZS script directly onto the executable.
* Use command line, providing path to interpreter and then to script like so:
`> ./ZSharp.exe ./Pong-Example-Project/script.zs`
@ -22,51 +23,35 @@ Downloading or installing is very simple, and you don't need to build it yoursel
* Use terminal, providing path to executable and then to script like so:
`$ ./ZSharp ./Pong-Example-Project/script.zs`
4. Feel free to use and edit the included `Pong-Example-Project`. It is a single script called `script.zs`, and you can open it with any of the methods above.
### ZSharp Installer Windows x64
1. Navigate to [the most recent release](https://github.com/sam-astro/Z-Sharp/releases) and download `ZSharp-Installer-Win-x64.zip`.
2. Unzip `ZSharp-Installer-Win-x64.zip` and open the unzipped folder.
3. You will see some files. Both the .EXE and the .MSI both do exactly the same thing, so you may execute either to begin the installation. Follow the steps in the wizard as it guides you through the install process. Make sure to remember the directory where you install it (the default one is `C:\Program Files\ZSharp`).
3. Navigate to the directory you installed Z-Sharp (the default one is `C:\Program Files\ZSharp`).
4. You will see many files. The Z# interpreter is `ZSharp.exe` and has a Z# icon. Any time you want to execute a script, this is the program that will be used. There are a few ways to use it:
* Drag and drop any .ZS script directly onto the executable.
* Use command line, providing path to executable and then to script like so:
`> ./ZSharp.exe ./Pong-Example-Project/script.zs`
* Right-click on your .ZS script file, then select `'Open with...'`. Click `'More Apps'`, scroll down, and select `'Look for another app on this PC'`. Navigate to the `ZSharp.exe` executable and select it. Now whenever you double-click any .ZS file, it will automatically open with the interpreter.
5. Feel free to use and edit the included `Pong-Example-Project`. It is a single script called `script.zs`, and you can open it with any of the methods above.
## Here is some example code:
```c++
// Comments are indicated by two forward slashes
// They can only be on their own line
int j = 4 // <- This is invalid comment placement, and will throw an error
// int j = 4 // <- This is invalid comment placement
// All programs start with a main function
func Main()
{
// Initialize variable by stating it's type, then name, then "=" and it's value
int i = 0
string s = "r"
// These operators will change the variable by the value on the right
i += 2
i -= 1
i /= 3
i *= 2
// Repeat until i >= 10
while i < 10
{
i += 1
}
// Check if the variable s contains the value "r"
if s == "r"
{
print s + " is r"
}
// Call function called "ExampleFunction" with two inputs, both as different types,
// then get the return value and store it in the new variable "functionNumber"
int functionNumber = ExampleFunction("A", s)
ExampleFunction(1, 3)
@ -74,8 +59,8 @@ func Main()
}
// Declare new function with 'func', then it's name, and the names of any input variables.
// The input variables don't need types, as those are automatic. Also, they don't need to
/// be assigned at all on execute and can be left blank by the caller
// The input variables don't need type, as those are automatic. Also, they don't need to
/// be assigned at all on execute and can be left blank
func ExampleFunction(inputA, inputB)
{
print "In A is: " + inputA
@ -116,7 +101,7 @@ func Start()
}
// Executes each frame
func Update()
func Update(deltaTime)
{
// Draws the image created in Start(). This is usually at the end of update.
ZS.Graphics.Draw(exampleSprite)