loreline 0.5.0 → 0.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,10 +1,18 @@
1
- # Loreline
1
+ ![Loreline](og-banner.png)
2
2
 
3
- Loreline is a modern and open-source scripting language for writing interactive fictions.
3
+ A modern and open-source scripting language for writing **interactive fiction**.
4
4
 
5
- https://loreline.app
5
+ Designed so writers can focus on story and dialogue while still having real programming tools (branching, state, functions) when they need them. If you write for games, visual novels, or any kind of branching narrative, this is for you.
6
6
 
7
- ## Development
7
+ Loreline works everywhere: game engines, web apps, or standalone projects. It adapts to your tools, the stories you write stay portable.
8
+
9
+ ### Get started
10
+
11
+ The documentation and an interactive playground are available on **[loreline.app](https://loreline.app)**.
12
+
13
+ ## Building Loreline
14
+
15
+ What follows is only needed if you want to modify Loreline from source. If you just want to use Loreline with your favourite engine, check out [the integrations guides](https://loreline.app/en/docs/).
8
16
 
9
17
  ### Prerequisites
10
18
 
@@ -21,7 +29,10 @@ npm install # Install Node.js dependencies (esbuild, tsx, etc.)
21
29
  node ./setup --js # Build JavaScript library (js/loreline.js)
22
30
  node ./setup --cs # Export C# source files (cs/Loreline/)
23
31
  node ./setup --cs --cs-dll # Export C# + build Loreline.dll
32
+ node ./setup --py # Build Python package (py/loreline/)
33
+ node ./setup --lua # Build Lua module (lua/loreline/)
24
34
  node ./setup --cpp # Build native CLI (loreline / loreline.exe)
35
+ node ./setup --cpp-lib # Build C++ shared library
25
36
  ```
26
37
 
27
38
  ### Setting up samples
@@ -31,17 +42,25 @@ node ./setup --sample # Set up all sample projects
31
42
  node ./setup --sample web # Set up loreline-web only
32
43
  node ./setup --sample unity # Set up loreline-unity only
33
44
  node ./setup --sample cpp # Set up loreline-cpp only
45
+ node ./setup --sample python # Set up loreline-python only
46
+ node ./setup --sample lua # Set up loreline-lua only
34
47
  ```
35
48
 
36
49
  This copies the built runtime and story files into the sample directories.
37
50
  For loreline-web, run `--js` first. For loreline-unity, run `--cs` first.
38
- For loreline-cpp, run `--cpp` first.
51
+ For loreline-cpp, run `--cpp` first. For loreline-python, run `--py` first.
52
+ For loreline-lua, run `--lua` first.
39
53
 
40
54
  ### Testing
41
55
 
56
+ Python, Lua, and JS tests require running the corresponding build step first (e.g. `node ./setup --py` before Python tests).
57
+
42
58
  ```sh
43
- node run test ./test # Run Neko tests only
44
- node ./setup --test # Run all test suites (Neko + C# + C# AOT + JS)
59
+ node run test ./test # Run Neko tests only
60
+ python3 py/test-runner.py ./test # Run Python tests only
61
+ lua5.4 lua/test-runner.lua ./test # Run Lua tests only
62
+ npx tsx js/test-runner.ts ./test # Run JS tests only
63
+ node ./setup --test # Build and run all test suites (Neko + C# + C# AOT + JS + C++ lib + Python + Lua)
45
64
  ```
46
65
 
47
66
  ## License