Skip to content
Snippets Groups Projects
README.md 1.5 KiB
Newer Older
  • Learn to ignore specific revisions
  • ComFreek's avatar
    ComFreek committed
    # UFrameIT
    
    Richard Marcus's avatar
    Richard Marcus committed
    
    
    Richard Marcus's avatar
    Richard Marcus committed
    The FrameIT project builds a Framework for developing Serious Games by combining Virtual Worlds with Mathematical Knowledge Management. 
    The UFrameIT framework uses the Unity game engine with the [MMT](https://uniformal.github.io/) system.
    This repository contains the Unity project, which currently includes the framework itself and a demo game.
    
    Richard Marcus's avatar
    Richard Marcus committed
    
    
    ComFreek's avatar
    ComFreek committed
    For more information about the project, please visit <https://uframeit.github.io/>
    
    ## Installation (for end users)
    
    
    ComFreek's avatar
    ComFreek committed
    Just download our latest release: <https://github.com/UFrameIT/UFrameIT/releases/latest>
    
    ComFreek's avatar
    ComFreek committed
    
    ## Installation (for developers)
    
    First, you have to set up a development environment:
    
    
    Richard Marcus's avatar
    Richard Marcus committed
    1. Install [Unity](https://unity3d.com/de/get-unity/download) 2019.4.x (LTS) via the Unity Hub. We periodically update to the latest LTS version. Currently, any 2019.4 version should work; you can safely ignore any version warnings popping up.
    
    ComFreek's avatar
    ComFreek committed
    2. Clone this repository: `git clone https://github.com/UFrameIT/UFrameIT.git`
    
    Richard Marcus's avatar
    Richard Marcus committed
    3. Install [IntelliJ IDEA](https://www.jetbrains.com/de-de/idea/)
    
    Richard Marcus's avatar
    Richard Marcus committed
    4. Follow these [instructions](https://github.com/UniFormal/MMT/blob/devel/src/frameit-mmt/installation.md) to get the necessary MMT archives and install the Server Component
    
    ComFreek's avatar
    ComFreek committed
    
    ### Running
    
    
    Richard Marcus's avatar
    Richard Marcus committed
    1. Open the Unity Hub and add the folder where you have cloned this repository. Then, you can directly open the project in the hub.
    
    Richard Marcus's avatar
    Richard Marcus committed
    2. Run the Server via IntelliJ (as described in the [FrameIT MMT server's usage guide](https://github.com/UniFormal/MMT/tree/devel/src/frameit-mmt))
    
    ComFreek's avatar
    ComFreek committed
    3. Run the game in unity