Advanced Customization
This chapter covers power-user features for customizing and extending Anukari beyond what the built-in options offer: creating your own skybox environments, building custom 3D model skins, and generating presets programmatically.
Creating a Custom Environment (Skybox)#
Anukari can turn any .hdr or .exr panorama in the equirectangular format into an environment. There are many websites that offer free skyboxes in this format.
To import one, open the 3D Visuals preferences, choose Import HDRI (.hdr or .exr) file... from the Environment drop-down, and select the image file. Then pick a skybox resolution (512, 1024 or 2048) and click Import. Higher resolutions give a sharper sky, at the expense of larger files and a longer conversion; 1024 is what the factory environments use. When the conversion finishes, the new environment is selected.
The imported environment is saved as <image name> <resolution>.env.zip in your UserEnvironments directory, so you only have to import an image once: to use it again later, choose Choose *.env.zip file... from the Environment drop-down and select that file.
- Windows:
C:\Users\<username>\Documents\Anukari\UserEnvironments - macOS:
/Users/<username>/Documents/Anukari/UserEnvironments - Linux:
~/Documents/Anukari/UserEnvironments
An .env.zip file is a plain zip file. Besides the skybox and lighting data that the import writes, it may contain one optional file, model.glb, a 3D model that will be rendered at 1:1 scale at the origin (see the Vaporwave environment for an example). To add one, see the next section on how to create .glb files, then give the file that exact name and add it to the top level of the .env.zip file, with no subdirectories. You can look at the factory environments in the following directories:
- Windows:
C:\ProgramData\Anukari\FactoryEnvironments - macOS:
/Library/Application Support/Anukari/FactoryEnvironments - Linux:
~/.local/share/Anukari/FactoryEnvironments(or/opt/anukari/FactoryEnvironmentsfor a system-wide install)
Creating a Custom Skin (3D Models)#
Custom skins are loaded from the 3D Visuals preferences alongside the factory skins.
An Anukari skin preset is a file with the extension .skin.zip, which is a plain zip file that contains all of the 3D model files that Anukari needs in the open glTF 2.0 format. Specifically, the files are in the .glb binary format. To see a list of all the .glb files that are required, you can look at the factory skins in the following directories:
- Windows:
C:\ProgramData\Anukari\FactorySkins - macOS:
/Library/Application Support/Anukari/FactorySkins - Linux:
~/.local/share/Anukari/FactorySkins(or/opt/anukari/FactorySkinsfor a system-wide install)
There are many tools you can use to edit the .glb files, but the simplest starting point is the free Blender tool. Technically you can import the .glb files directly into Blender via the File > Import > glTF 2.0 menu, but most of Anukari's .glb files have been compressed using EXT_meshopt_compression, which Blender does not yet support. If you really want to import such a .glb, you can use a tool like gltfpack to output the .glb in a non-compressed format, which you can then import into Blender.
However, a much simpler place to start is with the actual .blend source files for one of the factory presets, which have been made available for the Pre-Alpha Classic skin. This simple skin has everything you need to get started. Be sure to carefully examine the orientation and scale of the 3D models, and note that Anukari's renderer is limited to simple PBR materials. Also, look carefully at the animation timelines: all the animations are done from t=0 to t=1, but some of them (like the oscillator or bow) require that the animation loops, while others (like the mallet) do not.
Once you have made a 3D model, you can export it via Blender's File > Export > glTF 2.0 menu. Be sure to choose the glTF Binary (.glb) output format, and give the file the right name for the object it is associated with. Finally, zip up all your .glb files, making sure that they are at the top level of the zip with no nested directories, and rename the zip file to end in .skin.zip. Place that file in the appropriate UserSkins directory and then you can load it in Anukari:
- Windows:
C:\Users\<username>\Documents\Anukari\UserSkins - macOS:
/Users/<username>/Documents/Anukari/UserSkins - Linux:
~/Documents/Anukari/UserSkins
Note that Anukari does NOT support all valid glTF 2.0 files. If Anukari is unable to load your model, it will render it as a pink cube. In some cases, Anukari may be able to log information about why it could not load your model. Log files are in these directories:
- Windows:
C:\Users\<username>\AppData\Roaming\Anukari\logs - macOS:
/Users/<username>/Library/Logs/Anukari/logs - Linux:
~/.config/Anukari/logs
Creating Presets Programmatically#
Anukari .ank preset files are represented as Google Protocol Buffers, and the public definitions for those protobufs are available in the anukari-preset-api GitHub repo. These definitions can be used to programmatically create Anukari presets in any language that supports Protocol Buffers, such as Python.
However, the raw Protocol Buffers are quite difficult to work with, so we strongly recommend using the anukaribuilder library by 312ears instead. This library provides a much more user-friendly API for creating presets, along with a bunch of examples, including some extremely fun stuff like a preset that morphs between a sphere and a pyramid.
Another way to build presets without placing every object by hand is to ask an AI assistant. With AI assistant support turned on, Claude Code and other AI assistants on your computer can inspect and edit the preset that is open in Anukari, with every change they make undoable.