rexfile

package module
v0.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 5, 2020 License: Apache-2.0 Imports: 0 Imported by: 0

README

Godoc Reference Build Status Go Report Card

goREX logo

GoREXFile

The gorexfile library implements a Go reader and writer for the REXfile binary format. The REXfile is used for rexOS. The library can easily be integrated into your Go project. It can help you to get started with REX as a developer. For details about the binary file format, please see the format specification document.

Installation

You can install Go by following these instructions. Please note that Go >= 1.13. is required!

First, clone the repository to your local development path, and let go download all dependencies:

go mod tidy

This should download all required packages. To build all tools, you simple use the attached Makefile and call

make

Usage

Make sure that you just include the gorexfile library in your application:

package main

import (
    "github.com/roboticeyes/gorexfile/encoding/rexfile"
)

Please see the examples folder for further samples.

Tools

rxi

rxi is a simple command line tool which simply dumps REX file informations to the command line. It also allows to extract images from the file directly. For more information, please call rxi directly.

rxi --help
obj2rex

Simple OBJ to REX converter.

obj2rex --help

References

Documentation

Overview

Package rexfile implements a reader and writer for the REXfile binary file

Source code and other details for the project are available at GitHub:

https://github.com/roboticeyes/gorexfile

Please see the file specification for the REXfile at https://github.com/roboticeyes/openrex/blob/master/doc/rex-spec-v1.md

Directories

Path Synopsis
cmd
rxi
This binary can be used to work with a REXfile on the command prompt.
This binary can be used to work with a REXfile on the command prompt.
encoding
examples
loader
obj
Package obj is used to parse the Wavefront OBJ file format (*.obj), including associated materials (*.mtl).
Package obj is used to parse the Wavefront OBJ file format (*.obj), including associated materials (*.mtl).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL