Skip to content

Commit ca81e64

Browse files
authored
Update README.md
1 parent 3a197e2 commit ca81e64

File tree

1 file changed

+3
-86
lines changed

1 file changed

+3
-86
lines changed

README.md

Lines changed: 3 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,13 @@
1-
# ExPresS XR
1+
# Numismatic Exhibition Exhibition with ExPresS XR
22

3-
ExPresS XR (**Ex**perimentation and **Pres**entation for **S**cience with Open**XR**) is a toolkit for VR and XR in Unity.
4-
Based on the OpenXR Standard, it aims is to help automate early stages of development by providing configurable base implementations of components that are expected to be useful for scientific XR projects.
5-
6-
## Now using the brand new Interaction Toolkit 2.3.0
7-
8-
ExPresS XR is now using Unity's XR Interaction Toolkit 2.3.0. This comes with an overhaul to the XR Rig, many new features such as Poke-Interactions and loads of bug fixes.
9-
10-
## Getting Started & Documentation
11-
12-
If you are new check out the [Getting Started](https://github.com/eisclimber/ExPresS-XR/wiki/Getting-Started)-Page in the wiki and [video tutorials](https://www.youtube.com/playlist?list=PLaAvR_HPw8vhvauv-PpZuULIV3pETSwn_).
13-
14-
The full documentation can be found [here](https://github.com/eisclimber/ExPresS-XR/wiki)
15-
16-
17-
## Structure
18-
19-
Following the aim to the OpenXR standard itself, ExPresS XR aims to allow development for a multitude of devices.
20-
That why the project does not only support VR headsets with controllers but also a controller-free mode that can be used with smartphones (+ a VR mount, like the Google Cardboard)
21-
22-
The project is divided into three categories: General, Experimentation and Presentation.
23-
24-
- General: Implementations of configurable XR Rigs, Movement, XR-based UI and Interaction and a as in-editor tutorials
25-
- Experimentation: Providing an easy solution to collect and export data, automatic generation of a "clean" test environment, as well as a fully customizable quizzing system
26-
- Presentation: Options for displaying objects in VR in interesting ways that allow building virtual exhibitions with ease
27-
28-
Apart from the code itself the wiki features useful workflow tutorials that aim to help inexperienced developers (e.g. building end systems or scanning real world objects to be imported in the project)
29-
30-
## Full Feature List
31-
32-
- Ready to play example scenes showing the features and applications of `ExPresS XR`.
33-
- In-editor setup dialogs and tutorials for a quick start with your project.
34-
- Detailed documentation of the project components and workflow.
35-
- A fully configurable XR Rig.
36-
- Three input modes: Controller, Head Gaze, Eye Gaze (untested).
37-
- Different movement options: Teleportation, Continuous Move, Grab Move, ... .
38-
- Customizable interaction options: Ray, Grab/Direct, Poke, UI, ... .
39-
- Collision and PlayArea collision detection and visual feedback.
40-
- Virtual animated hands allowing grabbing and pushing of objects.
41-
- The Controllers that are used can be displayed in game.
42-
- A system for Hand Animations when grabbing.
43-
- A basic implementation of Inverse Kinematics (IK). For more elaborate IK use addons like FinalIK.
44-
- A great expansion of Unity's interaction toolkit.
45-
- Sockets that are highlight their size and can be setup to accept certain objects.
46-
- A Socket that will move objects back to to socket's position when no interaction is performed.
47-
- Physical Buttons with toggle mode.
48-
- Custom Teleportation Areas and Sockets.
49-
- UI keyboards usable with XR.
50-
- Sound-Emission uppon Collision
51-
- (Deprecated -> Supported by XRGrabInteractable now) Allow grabbing objects on the outside, rather than a single fixed attach point.
52-
- A HUD-system, allowing full screen fades and other permanent ui elements.
53-
- Configurable displays to present objects and further information in VR.
54-
- The objects can be picked up and inspected.
55-
- Automatic Creation of an "neutral"-looking rooms with specified dimensions for quick experiment setups.
56-
- An easy-to-use system for gathering and exporting data from anywhere in the VR.
57-
- Is structured similar to Unity's event system.
58-
- Data can be saved locally or be sent via http.
59-
- A fully customizable quizzing system.
60-
- Users answer a question by pressing a physical button in the VR.
61-
- Can be tailored and edited to one's likings using an setup dialog.
62-
- Allows configuring a multitude of parameters such as: Multiple or single choice, number of answers, question order ... .
63-
- Supports Questions, Answers and Feedback in the form of Text, GameObjects, Images and Videos.
64-
- The Feedback can be shown in different ways or be omitted.
65-
- Everything can be exported via the data gathering system.
66-
- Various little helpers for making life a bit easier.
67-
68-
## Help Us Out
69-
70-
ExPresS XR needs your feedback to improve. For that you will find a [survey](https://github.com/eisclimber/ExPresS-XR/blob/main/ExPresS%20XR%20Survey.pdf) in the repository of your project.
71-
72-
If you like the project you can buy me a coffee: https://ko-fi.com/eisclimber
73-
(We all know: Programmer + Coffe = Code :D)
74-
75-
76-
## Made with ExPresS XR
77-
78-
![ProjectsHeader](https://user-images.githubusercontent.com/49446532/221184626-22493d7d-66d8-422f-ae5b-192f57d661fe.png)
79-
80-
- [A Sample serving as an VR-Exhibition of the Church in Mühlen using ExPresS XR](https://github.com/eisclimber/express-xr-exhibition-kirche-muehlen)
81-
82-
If you create your own project using ExPresS XR feel free to contact me, so I can add you to the list (also don't forget the [survey](https://github.com/eisclimber/ExPresS-XR/blob/main/ExPresS%20XR%20Survey.pdf)).
83-
84-
## Known Issues
85-
86-
ExPress XR tries to evolve together with Unity's XR Interaction Toolkit. If you find any bugs check out the [Issues](https://github.com/eisclimber/ExPresS-XR/issues)-Page and report them. If you want to provide fixes for the Issues or expand ExPresS XR's functionality feel free to open a Pull Request.
873

884
## Credits
895

906
Created by Luca Dreiling
917

92-
Special Thanks to Kevin Körner for the great mentoring during and after the creation of the masters thesis this project is subject of.
8+
Special thanks to Kevin Körner and Stefan Krmnicek for supporting the creation with their expertise on Exhibitions and Numismatic, their feedback and playtesting.
939

10+
The models used are taken from Sketchfab under CC Lincense (links and detailed credits will be added shortly).
9411

9512
## Contact and Support
9613

0 commit comments

Comments
 (0)