Join our online forum to talk to Roku developers and fellow channel creators. Ask questions, share tips with the community, and find helpful resources.
Hello All, I'm interesting in feedback on my new Unity + Roku project.
Whole idea is to make Unity3d Editor as main asset editor with support of animations and object tree (scenes/prefabs).
I will put part of my project guide pdf, I need your opinion how to push this project! thank you.
How many of you know Unity3d?
Abstract
After few projects on Roku platform it was clear that making robust animation is really complex and some even impossible. Unity3D provide great platform to create game assets as well as re-import existing assets from massive Unity Assetstore. Roku Yov – is unity editor plugin which provide set of tools to re-import existing “pure” unity assets including animation and export to resources which will used on Roku device. The “Roku Yov” unity package provided with code on BrightScript which load and execute exported resources on Roku device.
Environment
Roku device
Please follow official guide: https://developer.roku.com/docs/developer-program/getting-started/developer-setup.md. After you complete the setup of your Roku device make sure that your developer PC or Mac connected to the same WiFi network as Roku device and you know Roku device IP address.
Developer PC or Mac
On your developer machine you will require to installed: Unity 19.4.0.f1, latest VSCode from https://code.visualstudio.com. Inside VSCode you have to install “BrightScript Language” extension to support debugger and deploy to your Roku device.
Package setup
After you did receive/install the Roku Yov and import into your Unity Editor (19.4.0.f1) you would have already setup project which you could learn from about provided tools of Roku Yov.
First step which you need to be done is to unpack `Assets/Roku/roku.zip` to any folder out of unity project for example to user `Documents` folder. As result you will get folder `~/Documents/roku` which contain pre-setup Roku project folder. This folder need to be open with VSCode. Next step is VSCode `launch.json` file modification of host and password fields shown at image below with IP address of your Roku device, in my case it’s 192.168.2.185 your Roku device IP address you could find on Roku device itself (Settings→Network→About→ IP address).
Setup is done. Now you could hit Run (F5) and run build on Roku device.
BrightScript Code Archive Explain (roku.zip)
This part of this document explain content of archive which you unpack from Assets/Roku/roku.zip.
roku/ - root folder
----/.vscode/
------------/launch.json – vscode configuration file which explain how to build and run project
----/animations/ – contain exported animations from Unity Roku plugin.
---------------/game_hide.json – UI animation controls show/hide game root node.
---------------/kid_idle.json, kuzya_eye.json, kuzya_idle.json etc…
----/fonts/
----------/yov.ttf - game font exported from Unity plugin.
----/icons/ - not exported part which used in manifest file
----------/icon_fhd.jpg
----------/icon_hd.jpg
----------/icon_sd.jpg
----------/loadings.jpg
----------/splash.jpg
----/out/ - authogenerated build output, set in launch.json.
----/prefabs/ - roku plugin exported semi-objects with the same idea as Unity prefabs
behind – create/clone an object from it on fly.
------------/Border0.json - as example prefab of border section which created multiple times to create
a line
----/scenes/ - exported unity scenes to load in game
-----------/MainScene.json – main scene of the game.
----/source/ - not exported part, contains BrighScript code for game and engine.
-----------/Functions/ - behavior function attached on node objects (aka GameObject in Unity)
---------------------/GameFunc.brs – game logic and UI part.
---------------------/ActorsFunc.brs, MenuFunc.brs, etc…
-----------/RokuEngine/ - roku engine code
----------------------/RokuEgine.brs
----------------------/RokuNode.brs
----------------------/RokuScene.brs
-----------/App.brs - application code
-----------/Main.brs - main file, roku start from here!
----/sprites/ - exported sprite files.
------------/allsprites.png – atlas image
------------/splash.png
----/collection.json - exported file, has all descriptors of all exported resources like
aniamtions, sprites, fonts, prefabs and scenes.
----/config.json - Roku native config file.
----/manifest - Roku native deploy manifest.
