Mobile Studio tool integration with C# scripting for the Unity game engine.

Last update: Dec 7, 2022

Overview

Mobile Studio Package

This project is a Unity package for integrating the Mobile Studio tool suite into game development workflows. This version of the package has the following features for integrating with the Streamline profiler.

C# language bindings for emiting event annotations.
C# language bindings for emiting software counters.

License

Most files in this library are licensed under the BSD-3 Clause License, provided in LICENSE.md.

The Unity native plugin interface header, IUnityInterface.h, is licensed under the Unity Companion License, provided in LICENSE_UNITY.md.

Technical details

Requirements

This version of the package is compatible with the Unity Editor version 2018.4 LTS and later.

Building

This package is built using the Unity bee compiler.

Set the environment variable ANDROID_NDK_ROOT to a local Android NDK install. Android NDK can usually be found in: \Editor\Data\PlaybackEngines\AndroidPlayer\NDK
Locate the bee compiler in your Unity install. It is usually found in: \Editor\Data\il2cpp\build\BeeSettings\offline\bee.exe
To trigger a build, run bee.exe in the Native~ directory.

Installing and using

For instructions on how to install and use this package, see the full documentation page.

Comments

Counter value bindings are only 32-bits

The latest Streamline annotation native code has extended the client-side counter helper to use 64-bit types. We should do the same here because there are common use cases needing more than 32-bit values, such as system memory sizes, and _SCALE counters burn dynamic range due to the fixed-point fractional encoding.

opened by solidpixel 2
Package counter ID assignments collide with Mobile Studio layers

Streamline annotation IDs are application managed, so can collide if different users allocate the same IDs. Currently both this package and the Mobile Studio layer drivers locally assign IDs from zero, so they collide.

We should offset (and document the offset) the annotation handle IDs allocated by this package to avoid collisions with other users.
bug

opened by solidpixel 2
CAM bindings don't allow any track hierarchy

The raw CAM bindings allow users to specify a parent track to allow a hierarchy to be built. We don't current expose this in the C# bindings - it would be good to hit parity.

opened by solidpixel 1
Use Int64 raw counter values
Streamline allows 64-bit counter values, but the version of the helper bindings that we are currently using have 32-bit counters.

This causes two problems:

32-bit counters are too small for some types of data (e.g. memory size reporting).

Scaled fixed-pointer counters consume bits, further reducing the max value range even further.

enhancement
opened by solidpixel 1
Complete set of CAM bindings
This PR adds additional CAM annotation bindings, making it a closer match to the Streamline native API.

CAMTracks can be nested.

CAMJobs can express dependencies.

Known issue: Streamline is currently ignoring CAM Job colors (confirmed Streamline bug).
opened by solidpixel 0
Reduce log verbosity
Logcat logs are verbose and repeatedly spam the same message. This PR reduces the log verbosity.

The FILE prefix is no longer used for log messages.

The warning for gator not running is only emitted once.
opened by solidpixel 0
Add software counter API

This PR adds support for an annotation software counter API. A simplified version of the underlying gator API is used, exposing float absolute and delta counters only.

opened by solidpixel 0
Add missing metadata file

Without the missing metadata file, Unity 2021.1 gets very unhappy, since it is not allowed to create metadatafiles for included packages: Asset Packages/com.arm.mobile-studio/LICENSE_UNITY.md has no meta file, but it's in an immutable folder. The asset will be ignored.

This fix simply adds the missing metadata file

opened by JohannesDeml 0
Channel annotations cannot be used from the Job system

CAM annotations support the jobRegister() interface which allows a script to add a Job with a specified start/end time in the past. This is useful for logging tasks processed by the Unity batch Job Scheduler, as batch jobs have restrictions on the API they can use.

We don't have the same interface for the simpler Channel annotations, but I suspect it would be useful to have.
enhancement

opened by solidpixel 1

Releases(1.5.0)

1.5.0(Sep 27, 2022)
CAM annotations to support nested tracks.

CAM annotations to support Job dependencies.

Counter set_value() renamed to setValue().

Source code(tar.gz)
Source code(zip)
1.4.0(Sep 27, 2022)
Support 64-bit counter values.

Source code(tar.gz)
Source code(zip)
1.3.0(Sep 27, 2022)
Namespace Streamline annotation IDs to minimize collisions with other tools.

Source code(tar.gz)
Source code(zip)
1.2.0(Sep 27, 2022)
Export Unity profiler metrics as Streamline counters

Source code(tar.gz)
Source code(zip)
1.1.0(Jun 28, 2021)
New software counter API

Made package thread safe

Source code(tar.gz)
Source code(zip)
1.0.0(Apr 14, 2021)
This is the first release of the Mobile Studio package for Unity. This release includes:

C# bindings for Streamline event annotations.

C# bindings for Streamline software counter annotations.

Source code(tar.gz)
Source code(zip)

Owner

Arm Software

GitHub

Design-agnostic node editor for scripting game’s flow in Unreal Engine

Flow plug-in for Unreal Engine provides a graph editor tailored for scripting flow of events in virtual worlds. It's based on a decade of experie

555 Jan 4, 2023

Improved version of the X-Ray Engine, the game engine used in the world-famous S.T.A.L.K.E.R. game series by GSC Game World.

OpenXRay OpenXRay is an improved version of the X-Ray Engine, the game engine used in the world-famous S.T.A.L.K.E.R. game series by GSC Game World. S

2.2k Jan 1, 2023

GB Studio is a quick and easy to use retro adventure game creator for Game Boy available for Mac, Linux and Windows

6.8k Jan 8, 2023

Multiplayer ludo game made in Unity

LUDO Multiplayer ludo game made in Unity This a multi-plaayer game. But due to lack of budget I am not able to make it online multi-player. So users h

26 Sep 23, 2022

Dialogue scripting language for Unreal Engine

Supertalk Welcome to Supertalk! This is a simple dialogue scripting language for Unreal Engine created due to frustration with visual dialogue tree wo

41 Nov 18, 2022

python scripting engine for the gd editor

Python interpreter embedded into the game Geometry Dash, designed for helping people automate tasks for creating

8 Feb 24, 2022

A scripting language created mainly for game engines

HCode Hammurabi's Code A scripting language created for the use in games and game engines. Currently supported features and roadmap Structs Functions

4 Oct 11, 2020

Game Scripting Languages benchmarked

Scriptorium ?? Game Scripting Languages benchmarked. Using latest versions at the time of writing (Jul 2015) Total solutions evaluated: 50 Results Ran

482 Jan 7, 2023

CLUSEK-RT is a complex game engine written in C++ and the successor of the CLUSEK game engine

CLUSEK-RT is a complex game engine written in C++ and the successor of the CLUSEK game engine. This engine has been designed with a cross-platform design in mind. Thanks to Vulkan API it delivers a next-gen experience with ray tracing to both Linux and Windows platforms