https://github.com/talsidor/inspector-script
Lua-powered, no-fuss micro scripts in the Unity Inspector.
https://github.com/talsidor/inspector-script
lua unity3d upm-package
Last synced: 9 months ago
JSON representation
Lua-powered, no-fuss micro scripts in the Unity Inspector.
- Host: GitHub
- URL: https://github.com/talsidor/inspector-script
- Owner: Talsidor
- License: lgpl-2.1
- Created: 2024-09-01T10:53:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-02T05:15:09.000Z (over 1 year ago)
- Last Synced: 2025-07-15T06:58:45.477Z (9 months ago)
- Topics: lua, unity3d, upm-package
- Language: C#
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# InspectorScript
> Lua-powered, no-fuss micro scripts in the Unity3D Inspector.
You might have to **click** on this GIF to play it:
# 1. Installation
## 1.1. Compatibility
InspectorScript should work in any version of Unity that supports MoonScript and the Unity Package Manager.
But it was built in, and so far has only been tested in, Unity 2022.3.
## 1.2. Dependencies
This package requires that your project has access to MoonSharp.
Some suggested ways to get MoonSharp:
1. Via the Unity Package Manager, by following the instructions on [k0dep's UPM-compatible fork of MoonSharp](https://github.com/k0dep/MoonSharp/) (Recommended)
2. Via NuGet, by following the first step of [MoonSharp's Getting Started guide](https://www.moonsharp.org/getting_started.html)
3. Manually, by downloading a release from [MoonSharp's GitHub](https://github.com/moonsharp-devs/moonsharp/releases)
## 1.3. Installing via the Package Manager
This repository is set up to be Unity Package Manager compatible.
To install via the Package Manager:
1. Open Package Manager window in your Unity Editor.
2. Click the '+' icon in the top left and select 'Add package from git URL...'
3. Enter 'https://github.com/Talsidor/inspector-script.git' and click Add.
4. Confirm you can now use Inspector Script by opening the 'Examples' scene, or adding an Inspector Script component to a Game Object.
Alternatively, you can also simply checkout or download this repository and include it in your Unity Project's files.
----
# 2. Example Scene
The 'Examples' scene included in this package contains 5 examples of InspectorScript's functionality. Open and run the scene to see the scripts in motion, and select each of the Cube objects under the `[Examples]` scene object to see their scripts.
Try making some changes to these scripts! Changes made in Play Mode will take effect immediately, but beware that like all Unity objects, changes made during Play Mode will be lost when leaving Play Mode.
----
# 3. Getting Started
## 3.1. Supported object properties:
- `pos` - this object's local position
- `rot` - this object's local rotation (in euler angles)
- `scale` - this object's local scale
All three of these properties are Vector3s. Like with regular Unity Vector3s, you can get each axis with '.x', '.y', and '.z'. But unlike usual Transform Vector3s, you can also set these values.
### Examples
- Get value
```
var x = pos.x
```
- Set value
```
rot.x = 5
```
- Increment value
```
scale.y = scale.y + 0.1
```
## 3.2. Available Unity properties:
- `time` - seconds since play started
- `delta` - fraction of time taken by this frame
### Examples
- Move forward at one unit per second
```
pos.z = pos.z + delta
```
- Make Y position equal to seconds elapsed
```
pos.y = time
```
## 3.3. Lua functions confirmed working:
- `print(x)` - Routed to log the passed argument to the Unity Debug Console
- `math.sin(x)` - Can be used for sine wave functionality directly in Lua
- `if` statements - See example either below or in the 'Examples' scene
### Examples
- Log value of z position every frame
```
print(pos.z)
```
- Oscillate x between -1 and 1 once per second
```
pos.x = math.sin(time)
```
- If statement
```
if (pos.y < -10) then
pos.y = 0
end
```
----
To learn more about the Lua interpreter backing InspectorScript, check out MoonSharp's [Getting Started](https://www.moonsharp.org/getting_started.html) guide.