Fix File Structures in Documentation
ScriptCraft/pipeline/head This commit looks good Details

This commit is contained in:
TheBrokenRail 2020-05-24 15:09:14 -04:00
parent 09015c0b20
commit 105d3b0933
2 changed files with 13 additions and 12 deletions

View File

@ -1,16 +1,16 @@
# File Structure
```
Jar Root/
- scriptcraft
- JS or JSON files
- Jar Root
- scriptcraft/
- Source Root
```
## Recommended Source Structure
```
Source Root/
- ModID
- index.js/index.ts
- Other Modules
- Source Root
- ModID/
- index.js/index.ts
- Other Modules
```
### Why is an index file necessary?

View File

@ -14,9 +14,10 @@ This is an example of a Minecraft mod made in TypeScript using ScriptCraft.
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
```
- API JAR Root
- src/
- Source Root
- types/
- File structure of node_modules/@types
```