Code Monkey home page Code Monkey logo

WurstScript

Wurstscript is a delicious programming language which compiles to Jass or Lua code that is used to power WarCraft III maps.

Build Status CircleCI GitHub issues GitHub pull requests Coverage Status

User Documentation

Using WurstScript to build a map is easy! Check out the Setup Guide on how to get started. For a formal description of all language features, visit the Manual.

Consider joining the WurstScript community on Discord.

Reporting Bugs

Please report any bugs your encounter with our Issue Tracker. Include as much information as possible, ideally with logs. Logfiles are located in your home folder under ~/.wurst/logs. Find the last modified file and pastebin it's contents.

Contributing

See https://github.com/wurstscript/WurstScript/blob/master/CONTRIBUTING.md

System Overview

This repository contains the following sub-projects:

  • de.peeeq.wurstscript
    • The core wurstscript compiler and directly related tools
  • Wurstpack
    • (deprecated) Wurst integration for the Warcraft III World Editor
  • HelperScripts
    • Some external scripts used for generating data e.g. for StdLib

IDE support is provided via a VSCode plugin: https://github.com/wurstscript/wurst4vscode

The source for the wurstscript website can be found here: https://github.com/wurstscript/wurstscript.github.io

Compiler Build Process

Java 11+ is required to build the project. Clone the repository and open the de.peeeq.wurstscript folder which contains the compiler project.

Using Gradle

Use the gradle wrapper to run required tasks, it will download gradle automatically. Replace [task_name] with the desired task.

.\gradlew [task_name]

Examples

To update the local compiler installation used by vscode run

.\gradlew make_for_userdir

For deploying .jars and .zips see tasks in deploy.gradle

.\gradlew create_zip_wurstpack_compiler

Import into IDE

You can import the compiler project into any IDE that provides a gradle plugin. For IntelliJ IDEA, you can simply execute ./gradlew openIdea. To run the Test Suite, execute AllTests.xml with TestNG.

Publishing a new release

Jenkins auto-releases versions as major.minor.patch.hotfix-jenkins-Wurst-buildNumber - e.g. 1.8.1.0-jenkins-Wurst-1248.

The version string can be updated in build.gradle.

WurstScript's Projects

wurstscript icon wurstscript

Programming language and toolkit to create Warcraft III Maps

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.