Project

tiny_gltf

0.0
The project is in a healthy, maintained state
Provides a Ruby extension for TinyGLTF, a C++ glTF 2.0 library.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

>= 2.1.0
~> 5.0
~> 13.0
~> 0.9
 Project Readme

TinyGLTF

Provides a Ruby extension for TinyGLTF, a C++ glTF 2.0 library.

Installation

Add this line to your application's Gemfile:

gem 'tiny_gltf'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tiny_gltf

Usage

Use the same interface for loading a binary or JSON glTF file, from a file on disk or from memory:

    require 'tiny_gltf'

    str = File.read('path/to/model.gltf')
    gltf = TinyGLTF.load(str)

    binstr = File.open('path/to/model.glb', 'rb').read
    gltf = TinyGLTF.load(binstr)

    gltf = TinyGLTF.load('path/to/model.gltf')

In all forms, an optional second argument provides the path to any external resources needed by the model file. It defaults to either the path to the model (if the first argument is a filename), or '.' (if the first argument is a blob).

    gltf = TinyGLTF.load(binstr, 'path/to/assets')

The return value is an instance of TinyGLTF::Model.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sinisterchipmunk/tiny_gltf-ruby.

License

The gem is available as open source under the terms of the MIT License.