Skip to content

SpaceMadness/lunar-unity-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lunar plugin for Unity

Download it from the Asset Store

Requires Unity 4.6 or later.

Project Goals

Imagine, you've just added this new cool feature and want to test it but keep losing the game before you actually get there. Maybe it would be easier if zombies die faster, things go slower or you simply can't get killed? Or maybe you just want to skip all of these and jump straight into the action? On top of that, you don't really want to mess around with Editor, modify scenes or "break" anything.

If so - you should give Lunar a try! It's a free and open source Quake3-flavored-Unix-style command line solution for your game.

  • Create custom commands and execute them from the terminal window
  • Bind commands to the hot keys
  • Create aliases to execute batches
  • Define user variables which persist across game launches
  • Change some aspects of your game while testing

Quick Start

###Open Terminal window (see: Getting Started) Use Editor's menu: Window ▶ Lunar ▶ Terminal

###Create command (see: Commands)

  • Create new C# script Commands.cs in Assets/Editor folder:
using LunarPlugin;

[CCommand("test")]
class Cmd_test : CCommand
{
    void Execute()
    {
        PrintIndent("Hello, Unity!");
    }
}
  • Open terminal window and type command's name:
> test
  Hello, Unity!
  • List commands:
> cmdlist

###Create key bindings (see: Key Binding)

  • Bind to a single key:
> bind t test
  • Bind command to a short cut:
> bind ctrl+t test

###Create config variable (see: Config Variables)

  • Create new C# script CVars.cs in Assets/Scripts folder:
using LunarPlugin;

[CVarContainer]
static class Cvars
{
	public static readonly CVar myBool = new CVar("myBool", false);
	public static readonly CVar myInt = new CVar("myInt", 10);
	public static readonly CVar myFloat = new CVar("myFloat", 3.14f);
	public static readonly CVar myString = new CVar("myString", "Hello!");
}
  • Open terminal window and list variables:
> cvarlist
  myBool 0
  myFloat 3.14
  myInt 10
  myString Hello!
  • Set variable's value:
> myString "Hello, Lunar!"
  • Get variable's value:
> myString
  myString is:"Hello, Lunar!" default:"Hello!"

User Guide

Check wiki page for more detailed guide.

Plugin Talk

Seattle Unity User Group - Lunar Plugin Talk (7/30/2015)

Showcases

  • Project: Unity 2D Roguelike
    Demonstrates some possible use cases of the plugin for Unity's 2D Roguelike tutorial.
    Features:

    • Start Nth day.
    • Start Next/Prev day.
    • Restart day.
    • Override food amount.
    • Enable/disable enemies' movements (with visual feedback).
    • Hot keys bindings.
  • Project: Stealth
    Demonstrates some possible use cases of the plugin for Unity's Stealth tutorial.
    Features:

    • Enable/Disable security cameras (with visual feedback).
    • Enable/Disable laser fences (with visual feedback).
    • Enable/Disable enemy AI.
    • Enable/Disable all above items at the same time.
    • Smart auto completion.
    • Hot keys bindids.
  • Project: Space Shooter
    Demonstrates some possible use cases of the plugin for Unity's Space Shooter tutorial.
    Features:

    • Execute Editor menu item from the terminal window.
    • Set Time.timeScale with numeric hot keys (from 0.1 to 1.0).
    • Toggle God Mode for the player (with visual feedback).
    • Command bindings and alias for God Mode.
  • Angry Bots
    Demonstrates some possible use cases of the plugin for Unity's Angry Bots demo.
    Features:

    • Quickly move between checkpoints.
    • JavaScript calls from C#.
  • Project: Survival shooter
    // TBD

Social media

Contacts

For any other questions: [email protected]

About

A UNIX/Quake3 style command line interface to Unity editor

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages