https://github.com/invisibleup/sonicr-blenderutils-2
Version 2 of the Sonic R Blender utilities
https://github.com/invisibleup/sonicr-blenderutils-2
blender blender-addon sonicr
Last synced: 4 months ago
JSON representation
Version 2 of the Sonic R Blender utilities
- Host: GitHub
- URL: https://github.com/invisibleup/sonicr-blenderutils-2
- Owner: InvisibleUp
- License: gpl-3.0
- Created: 2025-01-13T05:31:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-27T05:42:31.000Z (about 1 year ago)
- Last Synced: 2025-06-03T19:25:02.116Z (about 1 year ago)
- Topics: blender, blender-addon, sonicr
- Language: Python
- Homepage:
- Size: 9.55 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Sonic R Blender Utilities v2
This is an updated version of the Sonic R importers for Blender. This add-on requires Blender 4.2 or greater, and has been tested with 4.3.
Because this is a Blender add-on, it is licensed under the GPLv3.
Builds are provided for:
- Windows on x86-64
- Linux on x86-64
- macOS 11+ on ARM
If you're using another operating system or architecture, you will need to build the extension yourself.
## Usage
First, download the add-on from the Releases tab on GitHub. You can also build it yourself using the instructions below.
In Blender's Preferences window, navigate to "Add-ons" and select "Install from Disk" from the drop-down menu in the top right. Select the .ZIP file you downloaded or built.
One the plug-in is installed and activated, go to File > Import, and select "Sonic R Track (.bin)". Select a track .bin file from your Sonic R install directory. In the sidebar on the right, you can select the weather and time of day to enable custom lighting. You can also override the track metadata file to use, if needed.
As of right now, only track imports are supported. Character imports will be worked on next. It is unlikely that exporting will be supported in the near future due to the complexity of the file formats.
## Building
Install Python 3.11 or greater, and ensure Blender is on your path.
After that, you'll need to acquire the Python wheels listed in `blender_manifest.toml` from PyPI. This is not currently automated; you can either download them via your web browser or via `pip`. See https://docs.blender.org/manual/en/latest/advanced/extensions/python_wheels.html for details.
Then run `blender --command extension build` to create the .ZIP file for the add-on.
You can also try running `blender --command extension build --split-platforms`. This will generate one .ZIP file for each platform. This will reduce the file size of the extension by a considerable margin.