This repository has been archived on 2023-11-26. You can view files and clone it, but cannot push or open issues or pull requests.
ScriptCraft/examples/typescript/README.md
TheBrokenRail 37f11a92f0
All checks were successful
ScriptCraft/pipeline/head This commit looks good
Add Documentation
2020-05-24 14:09:25 -04:00

752 B

TypeScript Example

This is an example of a Minecraft mod made in TypeScript using ScriptCraft.

Files

  • src/main/ts: Contains TypeScript Code
  • src/main/java: Contains Bootstrap Java Code

Notes

  • This will also work with JavaScript if you set compilerOptions.allowJs and optionally compilerOptions.checkJs in src/main/ts/tsconfig.json to true
  • NPM dependencies are not bundled
  • API JARs are not bundled

typescript Gradle Configuration

The typescript gradle configuration will extract the specified API JAR into src/main/ts/build/dependencies.

API JAR Format

- src/
  - DTS, TS, JS, or JSON files and folders
- types/
  - File structure of node_modules/@types