Home

Awesome

UnityHTTPServer

UnityHTTPServer is a simple C# http server implementation works under Unity3D.

Feature

Supported Platform

Get Start

Use UnityHTTPServer Component

Simply add a GameObject in your scene and add UnityHTTPServer component.

Port: the port you wish to serve the http.

Save Folder: the wwwroot for your files wish to serve via http.

Use StreamingAssetsPath: Toggle this bool will use StreamingAssetsPath to replace the Save Folder.

Buffer Size: The buffer for your content to serve via http.

Controller: The MonoBehaviour instance to run your WebAPI method.

<img src="Img/01.png">

Manual usage (Advanced)

// Create the Http server instance.
// Server will automatically start once it created.
// replace {} part with your parameters
myServer = new SimpleHTTPServer({your path}, {your port}, {your controller}, {your bufferSize});

// Stop the server, remember to call the Stop() method while the application is close.
myServer.Stop();

Serve Files

Just simply make sure your files is under the Save Folder. Then enter PlayMode in Editor.

Example: (Use StreamingAssetsPath is on)

<img src="Img/02.png">

Result:

<img src="Img/03.png">

WebAPI method

When use UnityHTTPServer Component, create a MonoBehaviour and make sure the MonoBehaviour has an instance in scene, it is recommend to attach the MonoBehaviour on same GameObject with UnityHTTPServer.

Then make the MonoBehaviour to the reference on UnityHTTPServer's Controller field.

On the screenshot we use TestController.cs as an example. <img src="Img/04.png">

Json Serialize

Usually a web api will return a json string as the result, you need to implement the Json Serialize function yourself.

The simplest way is using Unity's JsonUtility (with some limitation). Here is the example:

// Create a http server instance.
myServer = new SimpleHTTPServer(GetSaveFolderPath, port, controller, bufferSize);

// Regist the OnJsonSerialized delegate to your json implemention.
// Here, we use the Unity's JsonUtility.
myServer.OnJsonSerialized += (result) =>
{
    return JsonUtility.ToJson(result);
};

Void Method

You can invoke a void method in target MonoBehaviour via add your method name on url.

Example: (In TestController.cs)

// Url: http://127.0.0.1:{port}/SimpleMethod
// change {port} to the port set on your UnityHttpController component

public void SimpleMethod()
{
    Debug.Log("Cool, fire via http connect");
}

Result:

<img src="Img/05.png">

Custom Object

In theory, you can return any object which supported by json serialize. Example: (In TestController.cs)

// Url: http://127.0.0.1:{port}/CustomObjectReturnMethod
// change {port} to the port set on your UnityHttpController component
public ReturnResult CustomObjectReturnMethod()
{
    ReturnResult result = new ReturnResult
    {
        code = 1,
        msg = "testing"
    };
    return result;
}

//Mark as Serializable to make Unity's JsonUtility works.
[System.Serializable]
public class ReturnResult
{
    public string msg;
    public int code;
}

Result:

<img src="Img/08.png">

Query parameter

You can also add query parmeter in your Url

Example: (In TestController.cs)

// Url: http://127.0.0.1:{port}/CustomObjectReturnMethodWithQuery?code=1111&msg=wow_it_is_so_cool
// change {port} to the port set on your UnityHttpController component
public ReturnResult CustomObjectReturnMethodWithQuery(int code, string msg)
{
    ReturnResult result = new ReturnResult
    {
        code = code,
        msg = msg
    };
    return result;
}

//Mark as Serializable to make Unity's JsonUtility works.
[System.Serializable]
public class ReturnResult
{
    public string msg;
    public int code;
}

Result:

<img src="Img/09.png">

Array Return

You can invoke a method which return an array result.

Note: The supportion of array is based on your Json Library, in case I use the LitJson library, the array return supportion will break while using Unity's JsonUtility

// A example while using LitJson as the Json Library
myServer.OnJsonSerialized += (result) =>
{
    return LitJson.JsonMapper.ToJson(result);
};

Example: (In TestController.cs)

// Url: http://127.0.0.1:{port}/SimpleStringMethod
// change {port} to the port set on your UnityHttpController component
public string[] SimpleStringMethod()
{
    return new string[]{
        "result","result2"
    };
}

// Url: http://127.0.0.1:{port}/SimpleIntMethod
// change {port} to the port set on your UnityHttpController component
public int[] SimpleIntMethod()
{
    return new int[]{
        1,2
    };
}

Result:

SimpleStringMethod

<img src="Img/06.png">

SimpleIntMethod

<img src="Img/07.png">

Troubleshooting

TODO