{"id":13678106,"url":"https://github.com/sandrofigo/VoxReader","last_synced_at":"2025-04-29T12:33:33.213Z","repository":{"id":46857852,"uuid":"207095819","full_name":"sandrofigo/VoxReader","owner":"sandrofigo","description":"A C# library to read .vox files created with MagicaVoxel","archived":false,"fork":false,"pushed_at":"2023-05-20T14:53:16.000Z","size":187,"stargazers_count":63,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2024-10-30T00:04:35.738Z","etag":null,"topics":["magica-voxel","magicavoxel","openupm","parser","parser-library","reader","unity","unity-3d","unity-scripts","unity3d","unity3d-plugin","vox","vox-files","voxel"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sandrofigo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-09-08T10:25:07.000Z","updated_at":"2024-09-19T13:04:58.000Z","dependencies_parsed_at":"2024-01-17T04:51:29.846Z","dependency_job_id":null,"html_url":"https://github.com/sandrofigo/VoxReader","commit_stats":{"total_commits":180,"total_committers":2,"mean_commits":90.0,"dds":0.005555555555555536,"last_synced_commit":"3c9a04095bb1d33d29b962a247c07ef68c690a1b"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandrofigo%2FVoxReader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandrofigo%2FVoxReader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandrofigo%2FVoxReader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandrofigo%2FVoxReader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sandrofigo","download_url":"https://codeload.github.com/sandrofigo/VoxReader/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224173547,"owners_count":17268128,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["magica-voxel","magicavoxel","openupm","parser","parser-library","reader","unity","unity-3d","unity-scripts","unity3d","unity3d-plugin","vox","vox-files","voxel"],"created_at":"2024-08-02T13:00:50.184Z","updated_at":"2025-04-29T12:33:33.203Z","avatar_url":"https://github.com/sandrofigo.png","language":"C#","readme":"# VoxReader \u003cimg src=\"https://media.githubusercontent.com/media/sandrofigo/VoxReader/main/images/icon.png\" alt=\"VoxReader Icon\" width=\"28\" style=\"margin: -4 0;\"\u003e\n\n[![latest](https://img.shields.io/nuget/v/VoxReader)](https://www.nuget.org/packages/VoxReader/)\n[![openupm](https://img.shields.io/npm/v/com.sandrofigo.voxreader?label=openupm\u0026registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.sandrofigo.voxreader/)\n[![downloads](https://img.shields.io/nuget/dt/VoxReader?color=blue)](https://www.nuget.org/packages/VoxReader/)\n[![test](https://github.com/sandrofigo/VoxReader/actions/workflows/test.yml/badge.svg)](https://github.com/sandrofigo/VoxReader/actions/workflows/test.yml)\n\nA C# library to read .vox files created with [MagicaVoxel](https://ephtracy.github.io/index.html?page=mv_main)\n\n---\n\n## Currently supported features\n\nAt the moment it is possible to read:\n- the name, size, position and rotation of all models\n- all individual voxels including their color and position\n- the palette that was used for the model\n- the notes stored in the palette\n- all raw data related to the scene\n- miscellaneous raw data\n\n## Usage\n\n```csharp\n// Read .vox file\nIVoxFile voxFile = VoxReader.Read(\"my_awesome_model.vox\");\n\n// Access models of .vox file\nIModel[] models = voxFile.Models;\n\n// Access voxels of first model in the file\nVoxel[] voxels = models[0].Voxels;\n\n// Access properties of a voxel\nVector3 position = voxels[0].GlobalPosition;\nColor color = voxels[0].Color;\n\n// Access palette of .vox file\nIPalette palette = voxFile.Palette;\n\n// Access raw data of a chunk\nbyte[] rawData = voxFile.Chunks[0].Content;\n```\n\n## Unity\n\nThe package is also available on [OpenUPM](https://openupm.com/packages/com.sandrofigo.voxreader/) for the Unity game engine.\nFollow the [manual installation](https://openupm.com/packages/com.sandrofigo.voxreader/?subPage=readme#modal-manualinstallation) or the [CLI installation](https://openupm.com/packages/com.sandrofigo.voxreader/?subPage=readme#modal-commandlinetool) instructions on the OpenUPM page to install the package in your project.\n\n## Extending the library\n\nThe file format specification made by [ephtracy](https://github.com/ephtracy) is available at [.vox file format](https://github.com/ephtracy/voxel-model)\n\nSupport this project with a ⭐️, report an issue or if you feel adventurous and would like to extend the functionality open a pull request.\n","funding_links":[],"categories":["Open Source Repositories","Voxel","Open Source Packages"],"sub_categories":["Meshes","Voxel"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsandrofigo%2FVoxReader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsandrofigo%2FVoxReader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsandrofigo%2FVoxReader/lists"}