Skip to content
Snippets Groups Projects
Normal view Permalink
README.md 1.47 KiB
Newer Older
  • Learn to ignore specific revisions
    • ComFreek's avatar
    Update README.md  
    ComFreek committed
    1 
    # UFrameIT
    Richard Marcus's avatar
    Update README.md  
    Richard Marcus committed
    2
    ComFreek's avatar
    Update README.md  
    ComFreek committed
    3 
    say what uframeit is in one sentence, link to official website. say what this repo contains.
    Richard Marcus's avatar
    Update README.md  
    Richard Marcus committed
    4
    ComFreek's avatar
    Update README.md  
    ComFreek committed
    5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 
    For more information about the project, please visit <https://uframeit.github.io/>

## Installation (for end users)

LINK TO LATEST RELEASE.

## Installation (for developers)

First, you have to set up a development environment:

1. Install [Unity](https://unity3d.com/de/get-unity/download) 2019.4.x (LTS). We periodically update to the latest LTS version. Currently, any 2019.4 version should work; you can safely ignore any version warnings popping up.
2. Clone this repository: `git clone https://github.com/UFrameIT/UFrameIT.git`
3. Get the [FrameIT archives](https://github.com/UFrameIT/archives), make sure to update the submodules with this [script](https://gist.github.com/ComFreek/dcadfec0214d87e9ad3268e61479d05b)
4. Install [IntelliJ IDEA](https://www.jetbrains.com/de-de/idea/)
5. Clone [MMT](https://github.com/UniFormal/MMT/tree/devel), which also contains the [FrameIT MMT server](https://github.com/UniFormal/MMT/tree/devel/src/frameit-mmt), on the *devel* branch: `git clone --branch devel https://github.com/UniFormal/MMT.git`
and [install](https://github.com/UniFormal/MMT/blob/devel/src/frameit-mmt/installation.md) the [Server Component]

### Running

1. Start Unity and open the project in this repo?
2. Follow the [FrameIT MMT server's usage guide](https://github.com/UniFormal/MMT/tree/devel/src/frameit-mmt) for how to start the FrameIT MMT server
3. Run the game in unity