Petrichorian hopscript

This is an idea for hopscript inspired by Tri-Angle's Hopscotch Textual Notation.

Currently, there are three major elements in this repository:

• hopscotchify.js – A program to convert hopscript to a hopscotch project. Just run node hopscotchify.js <hopscriptfile.htn> and it will output the hopscotch json (or an error message.) You can add a --output option to set a file for the output project to go to – for example, node hopscotchify.js main.htn --output ~/hsjp/13qd081dr9.hopscotch.

• dehopscotchify.js – An unmaintained program to convert hopscotch projects to hopscript. Just run node dehopscotchify.js <hopscotchfile.hopscotch> and it will output the hopscript code. It probably won't work with the current code

• vscode/petrichorianhopscript – An unmaintained extension for visual studio code to provide some basic syntax highlighting and limited completions. It will not work currently, I intend to update it later when there are less big changes being made to the language.

For any of these to work, you first need to run npm install to install some dependencies used for parsing the hopscript. Then inside of core run tsc to compile the typescript used there.

Future plans

• Convert core/secondPass.js and core/hopscotchify.js to typescript
• Re-evaluate certain elements of the language for consistency:
  • Should else: be Else:?
• Add optional type checking
• Make the vscode extension work
• Add ways to extend the language

A short tutorial

The examples in test/samples/shouldHopscotchify should contain examples of pretty much every feature currently supported, if it is not covered here.

Objects

To create an object, start by specifying the type of object you are creating, followed by its name and a colon:

bear phillip:

You can also specify things such as the location, rotation, size, and text content of text objects using parentheses:

text super_cool_message(x_position: 300, y_position: 200, rotation: 30, resize_scale: 3, text: "Hello, this is a super cool message!"):

On the next line after this, indent one level and include the object's code:

monkey monkey:
	#Empty objects are not allowed, so at the very least include a comment!

In objects, you can include comments, rules, custom rules, and, as long as it is before any rules or custom rules, set blocks:

banyan tree:
	Self.vertical_velocity = 0
	#You can include variable assignments here because it is before any rules
	local_variable = 10
	When game_starts:
		set_angle(10)
	#You can no longer include assignment blocks here, but you can still add comments, they just won't show up in
	#    the final Hopscotch project!

Custom rules

To create custom rules, which you can include inside of objects, other custom rules, or as their own top-level container (as long as you are defining their contents), start a line with custom_rule followed by the custom rule's name:

custom_rule draw_like_a_pen

You can give the custom rule parameters using parentheses:

custom_rule gradient_between(color1: "yellow", color2: "blue")

To define the custom rule's content, which you must do exactly once for each custom rule, end the line with a colon and indent the next lines. Custom rules can contain exactly the same things as objects:

custom_rule ensure_clone_count(clone_count: 7):
	#The values of parameters in the definition of custom rules will become their default values
	#    in the final Hopscotch project!
	When Self.total_clones < clone_count:
		create_a_clone_of_this_object

Rules

To create rules, which you can include inside of objects or custom rules, start the line (after indentation) with When followed by the condition and a colon.

When game_starts:

You can also include parameters with parentheses:

When is_tapped(Self):

After this, indent the next line and include blocks.

Blocks

To create blocks, just put the block name, in snake_case:

create_a_clone_of_this_object

You can provide arguments to blocks with parentheses:

join("Hello, ", with: "world!")

By default it is important that you use the correct label for arguments, however you can provide the --ignoreParameterLabels to hopscotchify.js to disable this, though that is not recommended.

Some blocks also have binary operator forms:

72 + Self.scroll_offset

Custom images

To include custom images, just add a custom_image type object with the file attribute set:

custom_image cool_image(file: "coolimage.png"):
	# ...

Do note that the filename of the image must be unique, and multiple images with the same filenames will merge even if they are in different directories.

custom_image image(file: "coolimage.png"):
	# ...
custom_image image_2(file: "subdirectory/coolimage.png"):
	# `coolimage.png` and `subdirectory/coolimage.png` will 
	# be the same image in the final project, even though 
	# they are from different directories.

hopscotchify.js can automatically copy all the used images to a directory using the --customImageDirectory option. For example:

hopscotchify.js project.htn --customImageDirectory ~/hopscotchDocuments/custom_images

Otherwise, you will have to handle this yourself.

If you output the hopscotchified json to a file using the --output option, it will print a list of the source path of every image you need to copy.

To set image to a custom image, just put the file attribute in parentheses after the custom_image type.

set_image(custom_image(file: "coolimage.png"))