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

22 lines
752 B
Markdown
Raw Normal View History

2020-04-29 23:41:08 +00:00
# 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
2020-04-30 00:32:07 +00:00
#### Notes
2020-05-05 00:40:06 +00:00
- This will also work with JavaScript if you set ```compilerOptions.allowJs``` and optionally ```compilerOptions.checkJs``` in ```src/main/ts/tsconfig.json``` to ```true```
2020-05-24 18:09:25 +00:00
- 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
```$xslt
- src/
- DTS, TS, JS, or JSON files and folders
- types/
- File structure of node_modules/@types
```