cc-haxe/README.md

47 lines
1.5 KiB
Markdown
Raw Normal View History

2022-02-21 01:44:45 +00:00
General purpose "operation system" for [ComputerCraft](https://tweaked.cc/) build with [Haxe](https://haxe.org/).
# Features
- TCP like rednet messages
- Rednet message routing
- Hardware abstraction
- Virtual screens to switch between multiple GUI apps
2022-03-01 11:58:37 +00:00
- Reactive UI framework
2023-03-21 23:57:41 +00:00
- Solid base to easily add applications
2022-02-21 01:44:45 +00:00
# Building
Requirements:
- `haxe` compiler
- `haxelib` for dependencies
- `nodejs` and package manager like `yarn`
- `make`
run `make deps && make`. The `bundle.min.lua` inside the `build` dir is the final file.
2022-03-01 11:58:37 +00:00
# Useful links
2023-11-07 17:14:56 +00:00
[CC lua code](https://github.com/cc-tweaked/CC-Tweaked/tree/mc-1.20.x/projects/core/src/main/resources/data/computercraft/lua)
2022-03-01 11:58:37 +00:00
[CC wiki](https://tweaked.cc/)
2022-03-01 15:59:06 +00:00
[Tinkerbell Core Library](https://haxetink.github.io/tink_core/#/)
2022-02-21 01:44:45 +00:00
# Development
There are a couple of tool to your disposal that makes working easier.
## Watch
Run `make watch` to recompile when a file changed.
## Emulator
2022-03-01 11:58:37 +00:00
You could use Minecraft to run the program or you could use [craftos pc](https://www.craftos-pc.cc/) as an emulator. Just install it and run `make emulator`.
2023-04-08 01:42:10 +00:00
There is an AppImage available [here](https://github.com/MCJack123/craftos2/releases).
2022-02-21 01:44:45 +00:00
## Websconsole
2022-03-01 11:58:37 +00:00
Use `make webconsole` to run a http server that prints the log output of the program to the terminal. Run `haxe` with the `-D webconsole` flag.
2022-02-21 16:47:17 +00:00
You may need to [allow connections](https://github.com/cc-tweaked/CC-Tweaked/wiki/Allowing-access-to-local-IPs) to any ip when using webconsole ingame.