Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 2.53 KB

devtool.md

File metadata and controls

60 lines (43 loc) · 2.53 KB
Raw

Developer Tools

Similer to layer0, the developer tools are designed as an executable with multiple feature plugins (found in the Plugins/ folder). The following executables exist:

Executable Details Image
RuyiDev.exe Double-click or run without an argument
RuyiDev.exe Run with any argument (e.g. RuyiDev.exe -h)

Plugins

All plugins are used via RuyiDev.exe <plugin> <arguments>. Assistance for any plugin is available via RuyiDev.exe <plugin> -h.

Name Functionality
API Tool Process Thrift files and generate API (see building SDK source)
App Runner Installation and starting/stopping of apps
Localization Tool
Setting Tool Get/set configuration parameters
Sign Tool Sign applications
TRC Tool Both static and runtime checking of app conformance to Ruyi platform requirements

App Runner

Applications can be installed, started, and stopped with App Runner.

  1. Select AppRunner
  2. Host Address: blank for local machine or IPv4 address of console
  3. Working Channel: always select dev
  4. App's RuyiManifest: select the app's RuyiManifest.json
  5. Press Install App button and wait for installation to complete (duration depends on size of your application)
  6. If successful, you should see your app listed in Installed Apps list
  7. Select it and press Run App button to launch it
  • You can stop your app by selecting it from Running Apps and pressing Stop App button
  • To uninstall an app, select it from Installed Apps and press Uninstall App button, note it can't be running if you want to uninstall it
  • Press Force Refresh to update Running Apps and Installed Apps lists

Also see Running Apps.

Sign Tool

As described in the security section, unsigned apps are only permitted in PC mode. In console mode, apps must be signed. Sign tool is used to sign an app so it can run on the console when "developer mode" is enabled.

Pfx file and Pfx Password are preset so you can self-sign applications during development.

App RuyiManifest is the app's RuyiManifest.json. Click Sign App to sign all files matching the following patterns:

  • *.exe
  • *.dll
  • *.sys
  • *.cat
  • *.ocx

Later you will be able to customize this via a section in RuyiManifest.