Skip to content
Snippets Groups Projects
Unverified Commit e36ed67e authored by Richard Marcus's avatar Richard Marcus Committed by GitHub
Browse files

Update README.md

parent abe35d6d
No related branches found
No related tags found
No related merge requests found
# UFrameIT # UFrameIT
say what uframeit is in one sentence, link to official website. say what this repo contains. 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.
For more information about the project, please visit <https://uframeit.github.io/> For more information about the project, please visit <https://uframeit.github.io/>
...@@ -12,15 +14,15 @@ Just download our latest release: <https://github.com/UFrameIT/UFrameIT/releases ...@@ -12,15 +14,15 @@ Just download our latest release: <https://github.com/UFrameIT/UFrameIT/releases
First, you have to set up a development environment: 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. 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.
2. Clone this repository: `git clone https://github.com/UFrameIT/UFrameIT.git` 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) 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/) 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` 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] and [install](https://github.com/UniFormal/MMT/blob/devel/src/frameit-mmt/installation.md) the Server Component
### Running ### Running
1. Start Unity and open the project in this repo? 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.
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 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 3. Run the game in unity
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment