Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/commandcracker/craftos-pc-action
GitHub Action for CraftOS-PC.
https://github.com/commandcracker/craftos-pc-action
computercraft computercraft-tweaked lua
Last synced: 4 days ago
JSON representation
GitHub Action for CraftOS-PC.
- Host: GitHub
- URL: https://github.com/commandcracker/craftos-pc-action
- Owner: Commandcracker
- License: gpl-3.0
- Created: 2023-06-02T21:17:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-14T18:15:23.000Z (about 1 year ago)
- Last Synced: 2024-10-31T00:51:17.407Z (14 days ago)
- Topics: computercraft, computercraft-tweaked, lua
- Language: Lua
- Homepage:
- Size: 67.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# CraftOS-PC-Action
GitHub Action for [CraftOS-PC].
## CraftOS-PC Tweaks
CraftOS-PC-Action runs some tweaks in order to improve the styling of the output.
The tweaks can be seen at [craftos-pc-tweaks].
## Default CraftOS settings
Please note that CraftOS-PC-Action comes with default CraftOS [settings]. However, you have the option to override them by creating a `/.settings` file. **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
}
```
[settings]: https://tweaked.cc/module/settings.html
[CraftOS-PC]: https://github.com/MCJack123/craftos2
[craftos-pc-tweaks]: https://github.com/Commandcracker/craftos-pc-tweaks
## Example workflow
```yml
name: CraftOS-PC Action
on:
workflow_dispatch:
push:
#branches:
#- main
jobs:
publish:
runs-on: ubuntu-latest
steps:
- name: Checkout 🛎️
uses: actions/checkout@v4
- name: CraftOS-PC >_
uses: Commandcracker/craftos-pc-action@v1
#with:
# Example inputs ordered by usefulness
#root: ./src
#timeout: 1m
#disable_root: true
#directory: ./cc
#luajit: true
#options: --exec print('Hello, World!')
#disable_tweaks: true
#disable_default_settings: true
#id: 42
#timeout_signal: "KILL"
#disable_timeout_verbose: true
#timeout_arguments: "--preserve-status"
#disable_single: true
#disable_headless: true
```
## Inputs
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|----------------------------------------------------------------------------------------------------------|--------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [directory](#input_directory) | string | false | | Sets the directory that stores
user data. Use disable_root if
you want to use the
user data computer directory as
root! |
| [disable_default_settings](#input_disable_default_settings) | string | false | | Setting this will dsiable all
default CraftOS-PC settings. This is
required if you want to
delete .settings for some odd
reason. |
| [disable_headless](#input_disable_headless) | string | false | | Setting this will disable the
headless render mode. It is
not recommended to do this
unless you know what you
are doing. |
| [disable_root](#input_disable_root) | string | false | | This will disable mounting the
root directory making the root
input useless. Use this if
root files should be mounted
to user data directory. |
| [disable_single](#input_disable_single) | string | false | | Setting this will disable the
single window render mode. It
is not recommended to do
this unless you know what
you are doing. |
| [disable_timeout_verbose](#input_disable_timeout_verbose) | string | false | | This will disable verbose timeout,
not printing if a timeout
accoured. |
| [disable_tweaks](#input_disable_tweaks) | string | false | | Setting this will dsiable all
CraftOS-PC-Tweaks |
| [id](#input_id) | string | false | | Sets the ID of the
computer that will launch |
| [luajit](#input_luajit) | string | false | | Setting this will use CraftOS-PC
Accelerated (with LuaJIT) instead of default
CraftOS-PC (with PUC Lua) |
| [options](#input_options) | string | false | | These are the options that
will be passed to CraftOS-PC |
| [root](#input_root) | string | false | `"./"` | The root directory of the
craftos-pc containg a startup.lua |
| [timeout](#input_timeout) | string | false | `"60"` | Specifies the maximum amount of
time that the action will
run before timing out. "timeout
is a floating point number
with an optional suffix:" 's'
for seconds (the default), 'm' for
minutes, 'h' for hours or
'd' for days. A duration
of 0 disables the associated
timeout. |
| [timeout_arguments](#input_timeout_arguments) | string | false | | Defines additional timeout arguments. |
| [timeout_signal](#input_timeout_signal) | string | false | `"HUP"` | specify the signal to be
sent on timeout; SIGNAL may
be a name like 'HUP'
or a number; see 'kill
-l' for a list of
signals |