Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hugeblank/RoundJay
CLI Based Inventory Management Solution for ComputerCraft
https://github.com/hugeblank/RoundJay
Last synced: 3 months ago
JSON representation
CLI Based Inventory Management Solution for ComputerCraft
- Host: GitHub
- URL: https://github.com/hugeblank/RoundJay
- Owner: hugeblank
- License: mit
- Created: 2023-01-26T10:11:57.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-22T07:15:11.000Z (8 months ago)
- Last Synced: 2024-04-16T21:24:59.240Z (7 months ago)
- Language: Lua
- Homepage:
- Size: 158 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-switchcraft - RoundJay - Extendable item system, with great addon/module support (Programs / Storage Systems)
README
# RoundJay
RoundJay is an in development Inventory Management Solution.
It's goal is to be as modular and well documented as possible so the user is able to easily tailor it to their needs.
The target audience is someone that wants to program their way around their storage system.
The server is broken up into "devices" that control one or more inventory, serving one of four functional roles:
1. `storage`: Buffer for items moving through the network.
2. `import`: Move items from outside the network, into it.
3. `export`: Move items from within the network, out from it.
4. `convert`: Move items from within the network, out, with the intention of eventually getting back different items. These can be thought of as a volatile storage.
5. `dummy`: A device that fulfils some other purpose besides storing items. This could be something like a monitor that displays network statistics.
Out of the box it comes with:
1. The `base` module that provides some basic input and output devices on the server, and the necessary commands to take advantage of them on the client.
2. `server.lua`, Server program that handles parsing of the provided network file, and management of devices.
3. `client.lua`, A CraftOS inspired CLI client. Can be run on the same computer as the server, or a different one when using the base module.
Check out the `rj_example` directory for an explanation on configuration, and storage network setup.
## Install
Server & Client
```
wget run https://raw.githubusercontent.com/hugeblank/qs-cc/master/src/gget.lua hugeblank roundjay main /roundjay
```
Server Only
```
wget run https://raw.githubusercontent.com/hugeblank/qs-cc/master/src/gget.lua hugeblank roundjay server /roundjay
```
Client Only
```
wget run https://raw.githubusercontent.com/hugeblank/qs-cc/master/src/gget.lua hugeblank roundjay client /roundjay
```
## Develop
It's recommended to use vscode and the [ComputerCraft Extension Pack](https://marketplace.visualstudio.com/items?itemName=lemmmy.computercraft-extension-pack). Documentation and metadata will immediately load and be navigable with ctrl+click.