hetu_script 0.3.0+1 copy "hetu_script: ^0.3.0+1" to clipboard
hetu_script: ^0.3.0+1 copied to clipboard

outdated

Hetu is a lightweight script language for embedding in Flutter apps.

Hetu Script #

Warning #

Hetu is early WIP! We are focusing on making Hetu stable and feature complete right now.

Discussion group:

Discord: https://discord.gg/Q8JWQYEw

QQ 群: 812529118

Introduction #

Hetu is a lightweight script language purely written in Dart for embedding in Flutter apps. The main goal is to enable Flutter apps to have hotfix and scripting ability.

We did not choose to use another existing language to achieve the goal. Because we want to keep the language simple, and keep it away from interference of other language's complex implementation and their irrelative-to-Flutter eco-system, and make the debug process pain-free and remain in Dart realms.

It takes very little time to bind almost anything in Dart/Flutter into Hetu, makes communicating with your existing Dart code very easy.

Installation #

For pure dart project, just add 'hetu_script: 0.3.0+1' in your pubspec.yamal and import the package. For handling module import from physical disk within the script, and REPL tool, there's another package called: 'hetu_script_dev_tools'. For Flutter project, use package 'hetu_script_flutter' along with 'hetu_script', then you can easily read script from assets. Note that in Flutter, the [init] method is changed:

import 'package:hetu_script/hetu_script.dart';
import 'package:hetu_script_flutter/hetu_script_flutter.dart';

final hetu = Hetu();
await hetu.initFlutter();
// do something

Quick start #

Hetu's grammar is close to typescript/kotlin/swift and other modern languages, need very little time to get familar with.

  • Optional semicolon.
  • Function is declared with 'fun, get, set, construct'.
  • Optional type annotation. Variable declared will infer its type from its initializer expression.

Syntax referrence

In your Dart code, you can interpret a script file:

import 'package:hetu_script/hetu_script.dart';

void main() {
  var hetu = Hetu();
  hetu.init();
  hetu.evalFile('hello.ht', invokeFunc: 'main');
}

While [hello.ht] is the script file written in Hetu, here is an example:

// Define a class.
class Person {
  var name: str
  construct (name: str) {
    this.name = name
  }
  fun greeting {
    print('Hi! I\'m', name)
  }
}

// This is where the script starts executing.
fun main {
  var ht = Person('Hetu')
  ht.greeting()
}

Binding #

Hetu script is purely written in Dart, so passing object to and from script is extremely easy.

Check this page for more information about how to bind external classes, functions, enums and how to passing object and functions between Dart and script.

import 'package:hetu_script/hetu_script.dart';

void main() {
  var hetu = Hetu();
  hetu.init(externalFunctions: {
    'hello': () => {'greeting': 'hello'},
  });
  hetu.eval(r'''
      external fun hello
      fun main {
        var dartValue = hello()
        print('dart value:', dartValue)
        dartValue['foo'] = 'bar'
        return dartValue
      }''');

  var hetuValue = hetu.invoke('main');

  print('hetu value: $hetuValue');
}

Referrences: #

Apps that embedded Hetu: #

Name Author Description Download Source
Monster Hunter Otomo: Rise rockingdice A unofficial game companion app for Capcom's Monster Hunter: Rise iOS Closed Source
48
likes
0
pub points
63%
popularity

Publisher

verified publisherhetu.dev

Hetu is a lightweight script language for embedding in Flutter apps.

Repository (GitHub)
View/report issues

License

unknown (license)

Dependencies

args, characters, meta, path, pub_semver, quiver, recase

More

Packages that depend on hetu_script