https://github.com/msiebuhr/ucs

Unity Cache Server re-implementation
https://github.com/msiebuhr/ucs

cache-server go unity-editor

Last synced: 4 months ago
JSON representation

Unity Cache Server re-implementation

• Host: GitHub
• URL: https://github.com/msiebuhr/ucs
• Owner: msiebuhr
• License: mit
• Archived: true
• Created: 2018-10-20T19:44:50.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-22T06:01:17.000Z (about 5 years ago)
• Last Synced: 2024-12-16T16:07:19.179Z (5 months ago)
• Topics: cache-server, go, unity-editor
• Language: Go
• Homepage:
• Size: 2.41 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Unity Cache Server

==================

.. in Go

> ARCHIVED

>

> This was a mostly do-some-work-related-Go. As I no longer work with Unity, I

> don't really have a need for this, nor can I test it in any meaningful

> capacity.

>

> If you like the project, feel free to fork the project - or petition Unity to

> take it over.

Installation from source

------------------------

    go get -u github.com/msiebuhr/ucs/cmd/ucs

    ucs

This will listen for cache-requests on TCP port 8126 and start a small

web-server on http://localhost:9126 with setup-instructinos and Promehteus

metrics.

Full usage options are shown with `ucs -h`. Note that options can be passed as

environment variables, making the following examples equivalent:

    ucs -quota 10GB

    ucs --quota 10GB

    QUOTA=10GB ucs

As it is generally recommended to [use a cache per major Unity Release and

project](https://github.com/Unity-Technologies/unity-cache-server/issues/50#issuecomment-413854421),

the server supports *namespaces*. This is done by using multiple `-port`

arguments or comma-separated list.

    ucs -port=8126 -port=name:8127

	ucs -port=8126,name:8127

	PORT=8126,name:8127 ucs

Each name/port will have a seperate cache, but garbage-collected as one (so old

projects' data will all but vanish and new ones will get lots of space).

For convenience, ports can be named as in `name:8127`. Is is used for the

file-system path, display on the help-page and in metrics. If the name is left

out, the port-number also becomes the name.

Load testing

------------

There's also a quick-and-dirty loadtest utility, `ucs-bender`:

    go get -u github.com/msiebuhr/ucs/cmd/ucs-bender

    ucs-bender # Will run against localhost

Related

-------

 * The "official" [Node.js cache server](https://github.com/Unity-Technologies/unity-cache-server)

 * [Blog about 6.0 development](https://blogs.unity3d.com/2018/03/20/cache-server-6-0-release-and-retrospective-optimizing-import/)

 * [Unity Documentation on Cache Servers](https://docs.unity3d.com/Manual/CacheServer.html)

 * [Unofficial C# Implementation](https://github.com/Avatarchik/UnityCachePlusPlus)

Miscellaneous

-------------

 * Icon by [Elizabeth Arostegui ](https://www.iconfinder.com/icons/998676/challenge_game_puzzle_rubik_icon)

 * MIT-Licensed