Skip to content

Commit f15fff9

Browse files
authored
Update README.md
1 parent a50a84b commit f15fff9

File tree

1 file changed

+56
-2
lines changed

1 file changed

+56
-2
lines changed

README.md

+56-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,56 @@
1-
# SimulatorSDK
2-
Covisart Motion Simulator SDK
1+
# Covisart Motion Simulator SDK for Unity Game engine
2+
3+
[![N|Solid](https://raw.githubusercontent.com/COVISART/SimulatorSDK/master/LogoStylesSideBySide.png)](https://unity.com/)
4+
5+
[![Build Status](https://travis-ci.org/joemccann/dillinger.svg?branch=master)](https://travis-ci.org/github/COVISART/SimulatorSDK)
6+
7+
Vehicle simulator based on a motion system developed using virtual and augmented reality technologies. System supports multi axis motion systems. This simulator allows users to use the aircraft they want in a virtual environment. Using AR technology, user can interact with virtual cockpit. Unlimited rotation system provide most realistic flight experience.
8+
9+
10+
- Virtual Reality
11+
- Augmented Reality
12+
- High Precision Motion System
13+
14+
# Features!
15+
16+
- Control power situation of all connected motors.
17+
- Calibrate motion system with one function
18+
- Calibrate each axis one by one
19+
- Send axis data to system on each frame
20+
- Reset errors on motors at runtime
21+
22+
You can also:
23+
- Manage joystcik inputs
24+
- Manage VR headset data to match exact position when rotating system
25+
- Export documents as Markdown, HTML and PDF
26+
27+
You can find example codes and scene one folders
28+
29+
> We use Resharper when coding,
30+
> Resharper formatting syntax is to make it as readable
31+
> as possible.
32+
33+
### Tech
34+
35+
Motion Simulator uses a number of open source projects to work properly:
36+
37+
* [TwinCAT 3](https://www.beckhoff.com/TwinCAT3/) - eXtended Automation (XA) to control sensors and motors
38+
* [Visual Studio Professional](https://visualstudio.microsoft.com/vs/professional/) - integrated development environment
39+
* [Angular](https://angular.io/) - a platform for building mobile and desktop web applications.
40+
* [node.js] - evented I/O for the backend
41+
42+
And of course Covisart Motion Simulator itself is open source with a [public repository][dill]
43+
on GitHub.
44+
45+
### Installation
46+
47+
Covisart Motion Simulator requires [Unity 2019 LTS](https://unity.com/releases/2019-lts?_ga=2.266885710.1795603025.1592424756-2133270114.1577918347) to run.
48+
49+
Download repo and import [CovisartMotionSDK](https://github.com/COVISART/SimulatorSDK/tree/master/Assets/CovisartMotionSDK) and [Plugins](https://github.com/COVISART/SimulatorSDK/tree/master/Assets/Plugins) to your project.
50+
51+
For easy setup, download Unity package from [release](https://github.com/COVISART/SimulatorSDK/releases) and import it.
52+
53+
### Todos
54+
55+
- Write MORE Tests
56+
- Add communication control mode

0 commit comments

Comments
 (0)