Skip to content

Latest commit

 

History

History
104 lines (70 loc) · 3.08 KB

README.md

File metadata and controls

104 lines (70 loc) · 3.08 KB
Raw

AbcConsole

Mobile-friendly debug console!

output

Features

Check and copy logs

Autocomplete for mobile comfort

Description

It is simple, but has all the necessary elements.
Check and copy logs generated on the actual machine.
You can define your own debug methods, and enter and execute them.
You only need to enter a few characters of the method name, and you can comfortably use AUTOCOMPLETE to enter the name!!

Checked by iOS, Android.
(On Android, due to Unity's limitations, you need to close the keyboard and then select ui buttons.)
Of course, it can also be used with Editor, Windows, and Mac.
You can start it with the tilde key, and the Tab key, up and down keys, etc. also work like a common console.

Instructions

  • Package Manager
    • Import AnKuchen https://github.com/kyubuns/AnKuchen.git?path=Unity/Assets/AnKuchen
    • Import AbcConsole https://github.com/kyubuns/AbcConsole.git?path=Assets/AbcConsole

How to use

Setup

Place the AbcConsole GameObject in your first scene from the menu Assets > Create > AbcConsole.
You can open the AbcConsole in the upper left button.

Define debug command

All you have to do is define the method with the AbcCommand Attribute.
Primitive types can be used as arguments.

public static class OriginalCommand
{
    [AbcCommand("Show App Version")]
    public static void AppVersion()
    {
        Debug.Log($"AppVersion is {Application.version}");
    }

    [AbcCommand("Message To DebugLog")]
    public static void Echo(string message)
    {
        Debug.Log(message);
    }
}

FPS Counter

The FPS Counter is included in AbcConsole.
You can view it by typing [FpsCounter] in the Console.
In an environment where FrameTimingManager is enabled, more detailed information will be displayed.

Screen Shot 2021-09-23 at 18 14 31

FAQ

I want to change the color and location of the TriggerButton.

You can change AbcConsole GameObject.
My recommendation is to make the color of AbcConsole/Canvas/TriggerButton/Base transparent.

I want to turn it off when I do a production build.

Delete AbcConsole GameObject.
Or, Instantiate only when necessary, as follows. (Recommend)

[Conditional("DEVELOPMENT_BUILD"), Conditional("UNITY_EDITOR")]
private void CreateAbcConsoleForDebug()
{
    Instantiate(abcConsolePrefab);
}

I want to use a trigger other than the Button.

Disable AbcConsole/Canvas/TriggerButton Object.
You can also use the OnClickTriggerButton method of the Root Component (which AbcConsole has).

Requirements

  • Requires Unity2019.4 or later

License

MIT License (see LICENSE)

SpecialThanks