Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oreal-solutions/night-script
https://github.com/oreal-solutions/night-script
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/oreal-solutions/night-script
- Owner: oreal-solutions
- License: mit
- Created: 2021-05-29T16:40:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-23T15:33:18.000Z (over 2 years ago)
- Last Synced: 2023-11-20T09:28:53.703Z (about 1 year ago)
- Language: Dart
- Size: 93.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Night Script
A command-line application with an entrypoint in `bin/`, library code
in `lib/`, and unit tests in `test/`.
Night Script is a 3d graphics scripting language that is designed to be simple, easy to read and interoperable with JavaScript and C++ by compiling source to source to these languages. During compilation, a night script file is compiled to one javascript or one .hpp and one .cxx file.
We aim to use Night Script as the scripting language for the Linyard Game Engine, which targets KaiOS devices via JavaScript and mobile devices via C++.
> TODO: Explore the idea of targeting mobile devices via Flutter or Web Assembly.
## Running the parser
First resolve all packages with `pub get`.
Then in the root folder of this folder run:
```bash
$ dart run night_script "path-to-your-script-file"
```
To parse the [hello_world](example_scripts/hello_world.nc) script, for example, run the following command:
```bash
$ dart run night_script "example_scripts/hello_world.nc"
```
## Q: If we don't intepret Night Script, how are we going to implement Flutter-like hot reload in Linyard
A: For javascript, we will explore [this](https://github.com/michaellee8/flutter_web_hot_reload) method. For C++ we will compile night script sources to .so file and just remap the procedures from a global lookup table, meaning it will be similar to the JS implementation.
## Q: Can night script programms be run as standalone
A: No, you need to compile them to JavaScript or Cpp and then run the output with your compiler tools for these two targets. We have designed the compilation process for night script with the assumption that generated files will be imported in an already setup project.
## Q: Besides the compiler, which other tools does the night script SDK provide
A: We plan to provide the following:
1. A package manager to allow for distribution and reusing of night scripts
2. IDE extension for VSCode
3. A formatter
## Q: Will night script have a standard library
A: Yes, A library that provides packages and algorithms common to both JS and Cpp environments. for example JSON encoding and decoding, a math library, typed buffers, data structures and collections, printing to console, extensions to the basic types, etc.