@tilua-types/roblox 10.0.0 → 10.0.1

package/README.md

@@ -73,21 +73,40 @@ wrapped.
 
 ## A game through Rojo
 
-In a Rojo project as `rojo init` makes it, nothing of Rojo's changes:
+In a Rojo project as `rojo init` makes it:
 
 ```bash
 npm i -D @tilua/compiler @tilua-types/roblox
-npx tilua init          # tilua.config.json, read off default.project.json
+npx tilua init          # src is what you write, out what Rojo reads
 npx tilua --watch       # beside `rojo serve`
 ```
 
-`tilua init` writes `{ "types": ["roblox"], "output": "files", "rootDir": "src" }`
-— `src` being the folder the project's `$path`s share. Each `.tilua` under
-it then compiles to a `.luau` beside it, where the project already reads
-files, and `rojo serve` syncs that into Studio as you save. `--watch` builds
-again on every change, removes the `.luau` of a `.tilua` that is gone, and
-never replaces a `.luau` written by hand: every file tilua writes says so on
-its last line.
+```
+src/                     what you write
+  shared/Greet.tilua
+  shared/Hello.luau      Luau written by hand
+out/                     the build's: compiled, copied, and nothing else
+  shared/Greet.luau
+  shared/Hello.luau
+  shared/_tilua.luau     the runtime
+```
+
+`tilua init` writes `{ "types": ["roblox"], "output": "files", "rootDir": "src", "outDir": "out" }`
+— `src` being the folder the project's `$path`s share — points those `$path`s
+at `out`, and adds `/out` to `.gitignore`. Each build makes `out` a mirror of
+`src`: every `.tilua` compiled, every other file (Luau written by hand,
+`.meta.json`, models) copied as it is, every folder there even when empty,
+and nothing else — what is in `out` and no longer in `src` is removed.
+`--watch` does that again on every change under `src`, and `rojo serve`
+syncs it into Studio. A project set up the older way, each `.luau` compiled
+beside its `.tilua`, is moved over by `tilua init` the same way, and the first
+build removes those `.luau` from `src`.
+
+The tree the project builds is typed as you write, read straight off
+`default.project.json` and the files in `src` — nothing else to run:
+`game.Workspace.Baseplate` is the project's part, `script` is the file's own
+instance (`script.Parent` its folder), and `FindFirstChild("")` and
+`WaitForChild("")` offer the children's names.
 
 Where each file goes is read off the Rojo project — `default.project.json`
 beside the config, or the one `"rojo"` names — and the files require each
@@ -139,11 +158,11 @@ luau-lsp is MIT licensed. Its notice is in
 <!-- compatibility:start -->
 ## Compatibility
 
-`@tilua-types/roblox@10.0.0` works with these tilua packages. *Released with* is the
+`@tilua-types/roblox@10.0.1` works with these tilua packages. *Released with* is the
 version it was built and tested against.
 
 | Package | Range | Released with | |
 | --- | --- | --- | --- |
-| `@tilua-types/luau` | `^9.0.0` | 9.0.0 | dependency |
-| `@tilua/parser` | `^9.0.0` | 9.0.0 | peer |
+| `@tilua-types/luau` | `^9.0.1` | 9.0.1 | dependency |
+| `@tilua/parser` | `^9.0.0` | 9.0.1 | peer |
 <!-- compatibility:end -->

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tilua-types/roblox",
-  "version": "10.0.0",
+  "version": "10.0.1",
   "description": "Luau and the whole Roblox API as tilua types: every class, enum, data type, service and global",
   "license": "ISC",
   "files": [
@@ -23,7 +23,7 @@
     }
   },
   "dependencies": {
-    "@tilua-types/luau": "^9.0.0"
+    "@tilua-types/luau": "^9.0.1"
   },
   "peerDependencies": {
     "@tilua/parser": "^9.0.0"