https://github.com/acalephstorage/spriteful
spriteful is an API that provides configuration for pixiecore
https://github.com/acalephstorage/spriteful
pxe pxixiecore
Last synced: 10 months ago
JSON representation
spriteful is an API that provides configuration for pixiecore
- Host: GitHub
- URL: https://github.com/acalephstorage/spriteful
- Owner: AcalephStorage
- License: apache-2.0
- Created: 2015-11-17T07:00:59.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-10-25T14:44:33.000Z (over 7 years ago)
- Last Synced: 2025-04-30T03:49:50.991Z (about 1 year ago)
- Topics: pxe, pxixiecore
- Language: Go
- Size: 16.6 KB
- Stars: 4
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Spriteful
=========
Spriteful is an API that provides server boot configuration for pixiecore.
See [pixiecore](https://github.com/danderson/pixiecore).
## Building
To build spriteful, [gb](http://getgb.io/) is needed.
``` sh
go get github.com/constabulary/gb/...
```
then, clone the repo:
```shell
git clone https://github.com/AcalephStorage/spriteful.git
cd spriteful
```
then, restore dependencies:
```shell
gb vendor restore
```
and finally, build the binary:
```shell
gb build
```
Binary can be found in `bin/` directory.
## Running
To run spriteful, use the following command:
```shell
spriteful -config /path/to/config/file
```
a sample config file is provided [here](config.json.example).
## pixiecore integration
To integrate with `pixiecore`, point the `-api` argument to this api:
```
$ pixiecore -api http://{bindHost}:{bindPort}/api
```