/Clue-wasm

Version of Clue made to be compilable in WebAssembly (OBSOLETE)

Primary LanguageRustMIT LicenseMIT

This repository is now obsolete, wasm bindings can be found here

image

Clue is a programming language that compiles into Lua code with a syntax similar to languages like C or Rust.

Clue tries to be almost as simple as Lua (with only a slightly more advanced syntax) but adds many optional features that can make code look better or make some things (like metatables) easier to code.

Clue does not compile to a specfic version of Lua: flags can be toggled to alter the output to allow most if not all versions or modifications of Lua to be compiled to with Clue.

General syntax differences

  • Code blocks are now inside {} instead of then/do/repeat and end/until
  • Comments are made with // ... or /* ... */

If you want a complete documentation of every change and addition in Clue check the wiki.

Example code

print("Hello world!")

local fn add(x, y) {
    return x + y
}

global n = 1

while n < 10 {
    n += add(n, n)
    if n == 3 {continue}
    print(n)
}

More examples can be found in the wiki or you can check an example program made with LOVE using Clue. More examples will be added soon.

How to install

Using PowerShell (admin perms required)

  1. Paste and run the below line in your PowerShell
md $Env:ProgramFiles\Clue -f >$null&&iwr((iwr https://api.github.com/repos/ClueLang/Clue/releases?per_page=1).Content|ConvertFrom-Json).assets[0].browser_download_url -o "$Env:ProgramFiles\Clue\clue.exe"&&[Environment]::SetEnvironmentVariable('Path',$Env:PATH+";$Env:ProgramFiles\Clue",'Machine')
  1. Type clue in your PowerShell to run the compiler, it will explain the rest

Linux (cargo required)

  1. Paste and run this command in the console: git clone https://github.com/ClueLang/Clue.git && cd clue && cargo install --path .
  2. Type clue in the console to run the compiler, it will explain the rest

Manual insallation

  1. Download the latest release and save it somewhere
  2. Open your system environment variables
  3. Add the path to the directory that contains clue.exe in the PATH variable
  4. Type clue in your cmd/PowerShell to run the compiler, it will explain the rest

More coming soon!

There are still some features that I'm considering adding and others that will be added soon. The most likely ones to be added in the future are:

  • macro
  • struct

For any suggestion or bug you can make a github issue. If you need help with the language itself, you can check out the new Discord server.

I hope Clue will be useful to you :)

Why is Clue named Clue?

I have no clue.