Figments.nrw is developed in Unity, with the source being made available via Gitlab (facilitating Git LFS for large assets). To open the project files and start working with the source code you need to setup your development environment, e.g. you pc, so that Unity, Git and Git LFS are installed and working.
We develop on Windows machines. Working with the source code on Mac OS or Linux based systems is untested.
Unity
Development of Figments.nrw happens in the following LTS version of Unity. Newer or older versions are untested and we currently can not support these.
| Figments.nrw Version | Tested and supported Unity Version |
|---|---|
| pre v0.4.0 | Unity 2021.3.5f1 |
You can download this specific version in the Unity Download Archive.
This LTS version of Unity has had some updates over the years, but these are not tested to work with Figments.nrw yet. We strongly recommend sticking to this specific version!
When we update Figments.nrw to more recent versions of Unity we will update this documentation accordingly.
Unity Modules
Figments.nrw supports Windows, Linux and Android builds. When installing the aforementioned Unity version, you need to enable these modules if you plan to build to these platforms as well.
| Build Target | Modules |
|---|---|
| Windows | Windows Build Support |
| Android | Android Build Support, OpenJDK, Android SDK & NDK Tools |
| Linux | Linux Build Support (IL2CPP), Linux Dedicated Server Build Support, if necessary Linux Build Support (Mono) |
Unity Hub
Managing different installations of Unity became easier with Unity Hub, which is why we recommend using this tool. Especially if you work on you own projects in addition to Figments or if you want to easily switch between versions.
Unity Account and License
Using Unity Hub you can easily manage your Unity account and license as well. Simply log in to your account, click the gear-icon to open the preferences and navigate to Preferences/Licenses. There you can refresh or add you personal, educational or other license as needed.
Git and Git LFS
While you certainly simply can download the source as a zipped archive, we recommend using git to clone the project files. That way you can easily pull any new releases and benefit from a version controlled environment. You are free to fork the project to any of your own repositories and work in you own version controlled environments as well, as long as you adhere to the stipulations of the open source license we or embedded packages may use (see LICENSE and THIRD PARTY LICENSES). For this, you need to have Git and Git LFS installed:
Cloning the Repository
To clone the repository, simply check it out using Git (or even Github Desktop) with
# SSH
git@git.uni-wuppertal.de:fehling/figments.nrw-public.gitor
# HTTPS
https://git.uni-wuppertal.de/fehling/figments.nrw-public.git