TeaVM-WASI

This repo contains a friendly fork of TeaVM, modified to support WASI and the WebAssembly Component Model proposal. We hope to eventually merge this work upstream if there is interest from the TeaVM maintainers. In the meantime, we have published the relevant packages to the Maven Central Repository under the groupId com.fermyon.

See here for an example of how to use the Maven plugin in your project.

See tests/wasi for an example command line app which exercises various WASI features.

The remainder of this document consists of the original TeaVM README.md.

TeaVM

See documentation at the project web site.

Useful links:

• Getting started
• Gallery
• Site source code repository
• Discussion on Google Groups

Building TeaVM

Simply clone source code (git clone https://github.com/konsoletyper/teavm.git) and run Gradle build (./gradlew publishToMavenLocal or gradlew.bat publishToMavenLocal). You should build samples separately, as described in corresponding readme file.

Preview builds

You may want to access new features and don't want to wait until stable release is published on Maven Central. In this case you can get latest development build from bintray. All you need is to put the following in your pom.xml:

  <repositories>
    <repository>
      <id>teavm-dev</id>
      <url>https://teavm.org/maven/repository</url>
    </repository>
  </repositories>
  <pluginRepositories>
    <pluginRepository>
      <id>teavm-dev</id>
      <url>https://teavm.org/maven/repository</url>
    </pluginRepository>
  </pluginRepositories>

IDEA plugin is also available in preview builds. You need to add corresponding repository manually to IDEA. Open Settings -> Plugins -> Browse repositories... -> Manage repositories..., click Add button and enter https://teavm.org/idea/dev/teavmRepository.xml. Then get back to Browse repositories and pick TeaVM plugin from list.

Embedding TeaVM

If you are not satisfied with Maven, you can embed TeaVM in your program or even create your own plugin for any build tool, like Ant or Gradle. The starting point for you may be org.teavm.tooling.TeaVMTool class from teavm-tooling artifact. You may want to go deeper and use org.teavm.vm.TeaVM from teavm-core artifact, learn how TeaVMTool initializes it. To learn how to use TeaVMTool class itself, find its usages across project source code. You most likely encounter Maven and IDEA plugins.

Please, notice that these APIs for embedding are still unstable and may change between versions.

WebAssembly

WebAssembly support is in experimental status. It may lack major features available in JavaScript backend. There's no documentation yet, and you should do many things by hands (like embedding generated wasm file into your page, importing JavaScript objects, etc). Look at samples/benchmark module. You should first examine pom.xml file to learn how to build wasm file from Java. Then you may want to examine index-teavm.html and index-teavm.js to learn how to embed WebAssembly into your web page.

License

TeaVM is distributed under Apache License 2.0. TeaVM does not rely on OpenJDK or code or other (L)GPL code. TeaVM has its own reimplementation of Java class library, which is either implemented from scratch or based on non-(L)GPL projects:

• Apache Harmony (Apache 2.0)
• Joda-Time (Apache 2.0)
• jzlib (BSD style license)

If you want to contribute code to implementation of Java class library, please make sure it's not based on OpenJDK or other code licensed under (L)GPL.

Feedback

More information is available at the official site: https://teavm.org.

Ask your questions by email: [email protected]. Also, you can report issues on a project's issue tracker.