-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Various changes, preparing for release
- Loading branch information
Showing
6 changed files
with
65 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,37 @@ | ||
# Blue Shiny rocks | ||
|
||
Blue Shiny Rocks, or BSRocks for short serves two purposes: | ||
- Emulation of the Lua 5.1 environment | ||
- Lightweight implementation of [LuaRocks](https://luarocks.org/) | ||
|
||
Most functionality of Lua 5.1 is implemented, with the following caveats: | ||
- The [debug library](http://www.lua.org/manual/5.1/manual.html#5.9) is only partially implemented. | ||
- `debug.traceback` does not accept threads | ||
- `debug.getinfo` only accepts a numeric value | ||
- `.getmetatable`, `.setmetatable`, `.getfenv` and `.setfenv` are just their normal versions | ||
- Everything else is not implemented | ||
- `string.gmatch` will infinitely loop on the `*` pattern (e.g. `\n*`) | ||
- `os` library is only partially implemented | ||
|
||
The LuaRocks implementation is very minimal: | ||
- Currently only supports downloading GitHub repositories | ||
- Only pure Lua libraries are supported | ||
|
||
## Patchspec | ||
The LuaRocks library also downloads "patchspec"s. These define modifications | ||
required for a library to work in CC. The next big stage of this project is to | ||
write ports and patches for key libraries: | ||
- [LuaFileSystem](https://keplerproject.github.io/luafilesystem/) | ||
- [Penlight](https://github.com/stevedonovan/Penlight) | ||
|
||
The ultimate aim is to be able to run most pure Lua libraries with minimal, or no | ||
patching. The repository for custom Lua ports and patchspecs is on a | ||
[separate branch](https://github.com/SquidDev-CC/Blue-Shiny-Rocks/tree/rocks). | ||
# Blue Shiny rocks | ||
|
||
Blue Shiny Rocks, or BSRocks for short serves two purposes: | ||
- Emulation of the Lua 5.1 environment | ||
- Lightweight implementation of [LuaRocks](https://luarocks.org/) | ||
|
||
Most functionality of Lua 5.1 is implemented, with the following caveats: | ||
- The [debug library](http://www.lua.org/manual/5.1/manual.html#5.9) is only partially implemented. | ||
- `debug.traceback` does not accept threads | ||
- `debug.getinfo` only accepts a numeric value | ||
- `.getmetatable`, `.setmetatable`, `.getfenv` and `.setfenv` are just their normal versions | ||
- Everything else is not implemented | ||
- `string.gmatch` will infinitely loop on the `*` pattern (e.g. `\n*`) | ||
- `os` library is only partially implemented | ||
|
||
The LuaRocks implementation is very minimal: | ||
- Currently only supports downloading GitHub repositories | ||
- Only pure Lua libraries are supported | ||
|
||
## Getting started | ||
- First install with Howl's webbuild: `pastebin run RcfW98XL SquidDev-CC/Blue-Shiny-Rocks -t build --once` | ||
- Grab either `build/bsrocks.lua` or `build/bsrocks.min.lua`. We'll call this file `bsrocks`. | ||
- Look for a package: `bsrocks search colours` | ||
- Check it is the one you want: `bsrocks desc ansicolors` | ||
- Install it: `bsrocks install ansicolors` | ||
- Use it: `bsrocks repl` or `bsrocks exec myFile.lua` | ||
|
||
You can also run `bsrocks help` for more information. | ||
|
||
## Patchspec | ||
The LuaRocks library also downloads "patchspec"s. These define modifications | ||
required for a library to work in CC. The next big stage of this project is to | ||
write ports and patches for key libraries. | ||
|
||
The ultimate aim is to be able to run most pure Lua libraries with minimal, or no | ||
patching. The repository for custom Lua ports and patchspecs is on a | ||
[separate branch](https://github.com/SquidDev-CC/Blue-Shiny-Rocks/tree/rocks). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters