Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/commandcracker/craftos-pc-tweaks
Quality of live tweaks for craftos-pc headless.
https://github.com/commandcracker/craftos-pc-tweaks
computercraft computercraft-tweaked lua
Last synced: 17 days ago
JSON representation
Quality of live tweaks for craftos-pc headless.
- Host: GitHub
- URL: https://github.com/commandcracker/craftos-pc-tweaks
- Owner: Commandcracker
- License: unlicense
- Created: 2023-06-04T11:41:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-16T23:18:49.000Z (over 1 year ago)
- Last Synced: 2024-11-10T15:49:42.599Z (3 months ago)
- Topics: computercraft, computercraft-tweaked, lua
- Language: Lua
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# CraftOS-PC Tweaks
Quality of live tweaks for [craftos-pc] headless. \
Tweaks:
- Color Output
- Disable word wrapping
- Exit on completion
Individual tweaks can currently only be disabled by removing their lua script inside [./lua](./lua/).
**Disabling some tweaks might break something because they are made to work together.**
## Usage
The tweaks can be applied by adding the following arguments after the craftos command:
### Enable headless renderer mode
```bash
--headless
```
_Outputs only text straight to stdout_
### Enable single window mode
```bash
--single
```
_Forces all screen output to a single window_
### Mount your root file system
```bash
--mount-ro /=./src
```
_Change the path (`./src`) accordingly._
### Apply tweaks
```bash
--mount-ro /rom/autorun=./lua
```
_Change the path (`./lua`) accordingly._
### GUI applications / Data folder
Don't try to load any GUI applications, it won't work!
You might want to change your data folder or your computer ID in order to not load anything you don't want to load.
You could use `--id ` to change the computer you're using, or `--directory ` in order to change the directory where [craftos-pc] stores files.
### Example
```bash
craftos --id 42 --headless --single --mount-ro /=./src --mount-ro /rom/autorun=./lua
```
#### Output
```bash
CraftOS 1.8
Hello, world!
```
## CraftOS settings
**It is important to set the setting `bios.use_multishell` to `false` in order to ensure proper logging.** Additionally, setting `motd.enable` to `false` is recommended, although not necessary. Disabling the MOTD will reduce the number of messages displayed during startup.
Here is an example of how to properly configure the [settings] file:
```conf
{
["motd.enable"] = false,
["bios.use_multishell"] = false
}
```
[craftos-pc]: https://github.com/MCJack123/craftos2
[settings]: https://tweaked.cc/module/settings.html