Logo by MagicCrayon9342
This is for people who want to use Scratch like other programming languages.
Also, a devlog is in the releases. If the version is not in the releases, then it's most likely at the bottom of this readme, at the old devlog.
Started C++ port
is at the very bottom. Look at that list before posting bugs.
This is an open-source project. Anyone can contribute. If there's anything discouraging you from contributing, let me know, and I'll try to fix it.
Some .sb3 files are included in the resources folder, so you can test your comp/decomp scripts.
The compiler should read the project.ss1, write the project.json, and pack it and every asset into a .sb3, that can be played and edited in Scratch
Each sprite (including Stage) has an asset folder. The costumes and sound will go there. It also has a .ss1 file, which is where the code is.
A project.json is also included in the resources folder to help understand and reverse engineer how it's made. Although, there is pretty much nothing in it, so I recommend getting your own project.json
This version of ScratchLang isn't really that good yet so I don't recommend trying to contribute. Instead, contribute on the Python Version.
Still being ported to C++.
The file extension is .ss1 because I am planning on having multiple formats.
ss1 Will be its own language Current
ss2 Will be similar to c
ss3 Python or javascript?
ss2 and ss1 won't be worked on anytime soon.
There are a couple of vcpkg packages you need before you can compile the Windows binary. These are not needed if you only want to compile for Linux systems.
curlpp::x64-windows, dirent:x64-windows, tinyfiledialogs:x64-windows, miniz:x64-windows
You can change x64-windows to something else if you need to but I don't know if it'll still work, as I've only used the x64-windows versions of those packages.
Once you have those packages installed for the solution, just open it in Visual Studio and build.
Also, if you're trying to compile for Linux systems on Windows, WSL2 and a C++ compiler is needed (like g++).
Binaries coming to the releases soon. For now you'll have to compile the source in order to run.
To code in the ScratchScript language, edit the .ss(es) in you favorite glorified text editor like VSC or Atom.
Or, you can use ScratchLang's custom editor :D
To add assets, put them in the "assets" folder for the chosen sprite (or stage)
One day I randomly decided to make an editor for ScratchLang. It is not ported to C++ yet.
SKIP THIS SECTION! I AM LEAVING IT IN FOR NOW BUT I WILL EDIT SOME THINGS WHEN THE C++ EDITOR HAS BEEN FINISHED!
Start the editor with
py editor.pyYou can even have the path to your project folder as the 1st argument to avoid the folder select screen and go straight to the editor.
Or you can run it with:
py scratchlang.py --edit
# OR
scratchlang --editBut you can't have a folder as an argument, it won't work.
- Arrow keys: Move around
- You can also click to place the mouse pointer.
- ctrl+s: Save project
- ctrl+/: Toggle line comment
- caps lock: Caps lock. Duh!
- tab: Insert a tab.
- Page Up and Page Down: Quickly navigate through your code
- F1: Open another folder or project.ss1
- F2: New Sprite
You can go into the var/ directory and edit the 'editor_settings.yaml' file to change your settings.
Settings added so far:
- tabsize: N - Set the tabsize to N
- syntax_highlighting: True/False - Turn syntax highlighting on or off. Does not work yet.
- show_cwd: True/False - Show or hide the current working directory.
- theme: Dark/Light/Black/RGB - Theme can be dark, light, black, or you can customize the theme with tr, tg, and tb with RGB colors (listed below)
- tr: N - Set RED to N
- tg: N - Set GREEN to N
- tb: N - Set BLUE to N
- offsetX: N - Text cursor placement offset X
- offsetY: N - Text cursor placement offset Y
You can also run editor_calibrate.py (or py editor.py --calibrate) to set the offsets if the cursor placement is a little off.
- Syntax Highlighting
- Scuffed quote and bracket auto-complete
- Auto-indent
- Dark, Light, and custom RGB themes
- Click to place text cursor
- Project folder explorer
Nothing yet
I probably won't get this working on any Linux distro tbh.
This is what people will do.
Program everything
I don't know what they're doing but I know they're doing something
They quit :/ Goodbye
Develop the Documentation website Nvm they can't do anything anymore since GitHub has been blocked for them.
ScratchLang's language is called ScratchScript.
\nscript - (Tells the compiler that it's a new script. Or maybe we could get rid of this and just detect for hat blocks.)
\prep - (Everything below this [until the next instance of \nscript] is used for compiling the .json)
list: foo="item1", "item2", "item3", etc - (For an empty list, just add a comma after the equal sign.)
broadcast: broadcastexample - (Define a broadcast. The brackets tell the program that it is not defining a variable or a list.)
var: foo=string - (Define a variable)
//!<TYPE> - (Use sha-bangs after a block to set the block type to the desired one if it's not right. For example, replace <TYPE> with 'looks' to make it a looks block. This also changes the syntax highlighting in the editor.)
- //!looks
- //!var
- //!list
- //!events
- //!sound
- //!control
- //!sensing
- //!operators
- //!pen
- //!motion
C++ ScratchLang compiler has not been ported yet.
Has also not been ported yet.
What I'm counting as Vanilla Scratch Blocks:
Normal Blocks
Custom Blocks
Pen
84/86 Stage Blocks + Pen | 97.67% Done Only Custom Blocks left!
132/134 Every Block + Pen | 98.51% Done Only Custom Blocks left!
Write every block in the order they are defined.
Remember, quotes tell the compiler that it is not a variable. If you want to put in a variable, don't put quotation marks. Example:
switch backdrop to ("i") # 'i' is registered as a string
switch backdrop to (i) # 'i' is registered as a variableAlso, the compiler can't tell the difference between a string and an input (like a variable) yet. So most inputs have quotation marks.
When a block has brackets '[ ]' it means that there cannot be a variable in there. It's either a defined object or an object from a set list.
None yet.
Every block is added, except custom blocks.
Lots, because It's not finished.
Too lazy to make a "Blocks to Add" list :/
39/90 Stage Blocks + Pen | 43.33% Done
39/141 Every Block + Pen | 27.66% Done
Write every block in the order they are defined.
Remember, quotes tell the compiler that it is not a variable. If you want to put in a variable, don't put quotation marks.
Also, the compiler can't tell the difference between a string and an input (like a variable) yet. So most inputs have quotation marks.
Brackets means that there cannot be a variable in there. It's either a defined object or an object from a set list.
None yet.
var=string - (Define [or set] a variable)
list=item1,item2,item3,etc - (Overwrites anything in a list to the items listed. No spaces and for an empty list, just add a comma after the equal sign.)
move ("num") steps (Move an amount of steps.)
wait ("num") seconds - (Wait for an amount of seconds.)
switch backdrop to ("backdrop") - (Changes backdrop.)
switch backdrop to ("backdrop") and wait - (Changes backdrop and waits.)
next backdrop - (Changes backdrop by 1.)
change [EFFECT #has to be in caps] effect by ("num") - (Change an effect by an amount.)
set [EFFECT] effect to ("num") - (Sets an effect to an amount.)
clear graphic effects - (Clears all effects applied to the stage or sprite.)
(backdrop [number/name]) - (Reports the number or name of the backdrop.)
play sound ("sound") until done - (Play a sound until done.)
start sound ("sound") - (Start a sound.)
stop all sounds (Stop all sounds.)
change [EFFECT] effect by ("num") (Change an effect by an amount.)
set [EFFECT] effect to ("num") - (Sets an effect to an amount.)
clear sound effects - (Clear sound effects.)
change volume by ("num") - (Change the volume by an amount.)
set volume to ("num") % - (Set the volume to an amount.)
(volume) - (Reports the volume.)
when flag clicked - (When green flag clicked.)
when [key] key pressed - (Runs the script when a certain key is pressed.)
when stage clicked - (Runs the script when the stage is clicked.)
when backdrop switches to [backdrop] - (Runs the script when the stage changes to a certain backdrop.)
when [THING] > ("num")
when i receive [broadcast] - (Runs the script when a certain message is broadcasted.)
repeat (num) {
} - (Repeat everything in the braces for (num) times.)
forever {
} - (Repeat everything in the braces forever.)
if <INPUT> then {
} - (If <INPUT> is true, then run everything in the braces.)
<(num1) = (num2)> - (Reports true if num1 equals num2.)
<(num1) > (num2)> - (Reports true if num1 is greater than num2.)
<(num1) < (num2)> - (Reports true if num1 is less than num2.)
<<1> and <2>> - (Reports true if both statement 1 and 2 report true.)
<<1> or <2>> - (Reports true if either statement report true.)
<not <1>> - (Reports true if statement 1 is false.)
if <INPUT> then {
} else {
} - (If <INPUT> is true, run the stuff above the else. If it is not, run the stuff below the else.)
wait until <INPUT> - (Pause the script until <INPUT> is true.)
repeat until <INPUT> {
} - (Repeat everything in the braces until <INPUT> is true.)
while <INPUT> {
} - (Repeat everything in the braces while <INPUT> is true. Stop when it is false.)
The decompiler cannot decompile boolean blocks ( <> blocks) which are inside other ones. You can't have variables or any round block as inputs yet.
turn cw () deg
turn ccw () deg
go to ()
go to x () y ()
glide () secs to ()
glide () secs to x () y ()
point in direction ()
point towards ()
change x by ()
set x to ()
change y by ()
set y to ()
if on edge, bounce
set rotation style []
(x position)
(y position)
(direction)
say () for () seconds
say ()
think () for () seconds
think ()
switch costume to ()
next costume
change size by ()
set size to ()
show
hide
go to [] layer
go [] () layers
(costume [])
(size)
for each [] in () {
}
stop []
when i start as a clone
create clone of ()
delete this clone
<touching ()>
<touching color (#hex)>
<color (#hex) is touching (#hex)>
(distance to ())
ask () and wait
(answer)
<key () pressed?>
<mouse down?>
(mouse x)
(mouse y)
set drag mode []
(loudness)
(timer)
reset timer
([] of ())
(current [])
(days since 2000)
(username)
(() + ())
(() - ())
(() * ())
(() / ())
(pick random () to ())
(join ()())
(letter () of ())
(length of ())
<() contains ()?>
(() mod ())
(round ())
([] of ()) #abs of block
(my variable)
change [] by ()
show variable []
hide variable []
(my list)
add () to []
delete () of []
delete all of []
insert () at () of []
replace item () of [] with ()
(item () of [])
(item # of () in [])
(length of [])
<[] contains ()?> #list contains block
show list []
hide list []
def example {
}
def example -sr { #run without screen refresh
}
example
pen|erase all
pen|stamp
pen|pen down
pen|pen up
pen|set pen color to (#hex)
pen|change pen () by ()
pen|set pen () to ()
pen|change pen size by ()
pen|set pen size to ()
V1 is officialy deprecated. Please use the latest version of the decompiler.
25/90 Stage Blocks + Pen | 27.78% Done
25/141 Every Block + Pen | 17.73% Done
Write every block in the order they are defined.
Remember, quotes tell the compiler that it is not a variable. If you want to put in a variable, don't put quotation marks.
Also, the compiler can't tell the difference between a string and a boolean/variable yet. So most number inputs have no quotation marks.
Brackets means that there cannot be a variable in there. It's either a defined object or an object from a set list.
repeat ("num") {
} - (Repeat everything in the braces for (num) times.)
forever {
} - (Repeat everything in the braces forever.)
var=string - (Define [or set] a variable)
list=item1,item2,item3,etc - (No spaces, and for an empty list, just add a comma after the equal sign.)
move ("num") steps (Move an amount of steps.)
wait ("num") seconds - (Wait for an amount of seconds.)
switch backdrop to ("backdrop") - (Changes backdrop.)
switch backdrop to ("backdrop") and wait - (Changes backdrop and waits.)
next backdrop - (Changes backdrop by 1.)
change [EFFECT #has to be in caps] effect by ("num") - (Change an effect by an amount.)
set [EFFECT] effect to ("num") - (Sets an effect to an amount.)
clear graphic effects - (Clears all effects applied to the stage or sprite.)
(backdrop [number/name]) - (Reports the number or name of the backdrop.)
play sound ("sound") until done - (Play a sound until done.)
start sound ("sound") - (Start a sound.)
stop all sounds (Stop all sounds.)
change [EFFECT] effect by ("num") (Change an effect by an amount.)
set [EFFECT] effect to ("num") - (Sets an effect to an amount.)
clear sound effects - (Clear sound effects.)
change volume by ("num") - (Change the volume by an amount.)
set volume to ("num") % - (Set the volume to an amount.)
(volume) - (Reports the volume.)
when flag clicked - (When green flag clicked.)
when [key] key pressed - (Runs the script when a certain key is pressed.)
when stage clicked - (Runs the script when the stage is clicked.)
when backdrop switches to [backdrop] - (Runs the script when the stage changes to a certain backdrop.)
when [THING] > ("num")
when i receive [broadcast] - (Runs the script when a certain message is broadcasted.)
turn cw () deg
turn ccw () deg
go to ()
go to x () y ()
glide () secs to ()
glide () secs to x () y ()
point in direction ()
point towards ()
change x by ()
set x to ()
change y by ()
set y to ()
if on edge, bounce
set rotation style []
(x position)
(y position)
(direction)
say () for () seconds
say ()
think () for () seconds
think ()
switch costume to ()
next costume
change size by ()
set size to ()
show
hide
go to [] layer
go [] () layers
(costume [])
(size)
if <> then {
}
if <> then {
}
else {
}
wait until <>
repeat until <> {
}
while <> {
}
for each [] in () {
}
stop []
when i start as a clone
create clone of ()
delete this clone
<touching ()>
<touching color (#hex)>
<color (#hex) is touching (#hex)>
(distance to ())
ask () and wait
(answer)
<key () pressed?>
<mouse down?>
(mouse x)
(mouse y)
set drag mode []
(loudness)
(timer)
reset timer
([] of ())
(current [])
(days since 2000)
(username)
(() + ())
(() - ())
(() * ())
(() / ())
(pick random () to ())
<() > ()>
<() < ()>
<() = ()>
<<> and <>>
<<> or <>>
<not <>>
(join ()())
(letter () of ())
(length of ())
<() contains ()?>
(() mod ())
(round ())
([] of ()) #abs of block
(my variable)
change [] by ()
show variable []
hide variable []
(my list)
add () to []
delete () of []
delete all of []
insert () at () of []
replace item () of [] with ()
(item () of [])
(item # of () in [])
(length of [])
<[] contains ()?> #list contains block
show list []
hide list []
def example {
}
def example -sr { #run without screen refresh
}
example
pen|erase all
pen|stamp
pen|pen down
pen|pen up
pen|set pen color to (#hex)
pen|change pen () by ()
pen|set pen () to ()
pen|change pen size by ()
pen|set pen size to ()
The variable or list is probably long.
The decompiler is not complete yet, which means stuff like that may happen.
Your .ss1 file is probably big.
Run editor_calibrate.py (or py editor.py --calibrate) to hopefully fix that issue.
- Load broadcasts even if there are none. (Try decompiling decompilertest.sb3 which is in the resources folder.)
-
Sometimes (in the project.json) when decompiling a "switch backdrop to" block, the backdrop name is replaced with a number, causing some bugs.
-
Sometimes blocks don't compile at the right place if it's after a c-block.
- Some decompilation bugs, too lazy to list.
The devlog will be in the Releases section from now on. Format: MM.DD.YY - VERSION
- Started editor, and other things.
- ScratchLang is not almost 100% Python.
- Forgot to make a devlog for this day, so I forgot what I added in this version
- Added some more blocks to the python port.
- Added some blocks to the python port.
- Started the Python port.
- Using shellcheck, I optimized the scripts to go faster.
-
repeat until block added.
-
while block added.
- wait until <> block added.
- If/elses inside if/elses work perfectly.
- Nothing major, forgot what I added.
-
Added a Devlog :)
-
added if/else blocks and not operator