Back to mods
Scarlet project artwork

CurseForge · Minecraft mod

Scarlet

A fun interpreted programming language built for Minecraft

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which Scarlet release should I use?

Updated 3 years ago
beta file scarlet-0.1.0+1.18.2-alpha.jar
Game version 1.18.2
Loader Fabric

scarlet-0.1.0+1.18.2-alpha.jar targets 1.18.2 with Fabric. The project page does not say whether this file belongs on the client, dedicated server, or both. No extra mods listed for this file.

Where it goes

Is Scarlet required on the client, server, or both?

The project page does not say whether this file belongs on the client, dedicated server, or both.

Client Source doesn’t say
Dedicated server Source doesn’t say
Loader for this release Fabric
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

The source does not explicitly classify this release as client-only or server-only.

What else does scarlet-0.1.0+1.18.2-alpha.jar need?

scarlet-0.1.0+1.18.2-alpha.jar. Change the file and its required mods may change too.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional mods.

Before you install it

Add Scarlet without breaking your instance.

Built for scarlet-0.1.0+1.18.2-alpha.jar. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use scarlet-0.1.0+1.18.2-alpha.jar. It targets 1.18.2 with Fabric; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    The project page does not say whether this file belongs on the client, dedicated server, or both.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside scarlet-0.1.0+1.18.2-alpha.jar. It opens that exact file at the source.

About this project

What does Scarlet add?

drawing

Scarlet is an interpreted programming language built for Minecraft on the Fabric Loader. It is designed to allow quick prototyping for server scripting & content creation.


What is Scarlet used for?

Scarlet makes it easy to add new scripted content to the game without prior Java experience. My primary target audience is (1) people looking to have fun with friends on private servers, and (2) people who need a tool for scripting Minecraft video content or minigames (which isn't a strong point of Java).

Scarlet is also a viable option for modpack event scripting, but for anything serious being shipped to production, I would recommend KubeJS instead.


Give me an example!

Scarlet code goes in your /run/scarlet/ directory with the .scarlet file extension. Reload all Scarlet code by pressing the 'R' key. How about we print a simple greeting when a player joins the server?

join_script_example.png

Oops! I made a mistake while typing this out and wrote "on join server" instead, you say, wondering how Scarlet will handle it. Scarlet has a friendly error logging system that will show you exactly where the offending code lies:

scarlet_error.png


Give me more examples!

You can find a collection of Scarlet example scripts in the /example_scripts/ directory of this repository. Here are a few of our favorites:


A Note on Stability

Scarlet is, first and foremost, a fun educational exercise for me in the art of language design. I make no promises about the stability of your scripts or API interactions at the current stage of the project, because the status of the project is based off my personal quest for enjoyment.

My personal gesture regarding stability is that Scarlet will stay in the 0.x.x version scheme while it is unstable and prone to changes. Once 1.x.x arrives, I will focus on keeping API stable, so you can update without worrying about me breaking every script you have ever written. :)


Licensing

Scarlet started out as an educational project based on Crafting Interpreters and other compiler resources, which is why it is licensed as MIT. You can read the LICENSE file for more information, but the tl;dr is that you can use the code inside this repository as long as any significant chunks are accompanied by the license file.

Project description from CurseForge.

Pick your setup

Scarlet by Minecraft version and loader

Choose the version and loader you play, then open the matching release.

1 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

Scarlet versions and loaders

1 of 1 releases match

Looking for an older file? The official CurseForge project page is in Resources.