TheBrokenRail
/
ScriptCraft
Archived
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/FILE_STRUCTURE.md
View File

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

11
examples/typescript/README.md
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```. The ```typescript``` gradle configuration will extract the specified API JAR into ```src/main/ts/build/dependencies```.
#### API JAR Format #### API JAR Format
```$xslt ```
- src/ - API JAR Root
- DTS, TS, JS, or JSON files and folders - src/
- types/ - Source Root
- File structure of node_modules/@types - types/
- File structure of node_modules/@types
``` ```