Simula/README.org at master · lboklin/Simula · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
[[file:./doc/TEMP_LOGO.png]]

Simula is a 3D window manager for Linux that runs on top of [[https://godotengine.org/][Godot]].

[[https://d.tube/#!/v/sudoreboot/t026ny0m][file:./doc/SimulaDesktop.png]]

*Video:* [[https://peertube.social/videos/watch/6ca912da-7bc4-4f81-934b-79fddeb71fd0][See here.]]

*Mission:* Facilitate a Linux future for VR & AR Desktop. In the short-run, this means allowing people to run 2D Linux apps with current generation headsets. In the long-run, this means allowing people to run Linux in standalone AR & VR HMDs. Currently, Simula is aiming to be compatible with the HTC Vive.

*Origins:* Simula is a reimplementation fork of [[https://github.com/evil0sheep/motorcar][motorcar]]. To read about motorcar, see /[[https://github.com/evil0sheep/MastersThesis/blob/master/thesis.pdf?raw=true][Toward General Purpose 3D User Interfaces: Extending Windowing Systems to Three Dimensions]]/


* Installation

[[https://gitter.im/SimulaVR/Simula][file:./doc/GitterBadge.png]]

Simula is in alpha phase, and can be difficult to get working on many setups. For help with installation, please visit our [[https://gitter.im/SimulaVR/Simula][chat room]].

** Ubuntu/Debian

Simula has only been tested on Ubuntu bionic beaver (18.04), but the instructions below should in principle work on older versions of Ubuntu and other distros that use ~apt~/~apt-get~ (i.e., Debian).

1. *Clone the repo and run the helper commands.*

  #+BEGIN_SRC shell
  git clone --recursive https://github.com/SimulaVR/Simula
  cd Simula
  source utils/UbuntuHelpers.sh

  installNvidiaDrivers # this will update you to nvidia-396 if you don't have it already
                       # If you run AMD, ensure that mesa is updated to at least mesa-17.3

  installUbuntuDependencies
  installSteam # if you haven't already
  installGodot # Installs Godot 3.1 master branch; this will probably take a while.
  #+END_SRC

2. *Ensure udev rules are up to date.* Ensure that ~/lib/udev/rules.d/60-HTC-Vive-perms.rules~ exists and contains the following:

  #+BEGIN_SRC shell
  # HTC Vive HID Sensor naming and permissioning
  KERNEL=="hidraw*", SUBSYSTEM=="hidraw", ATTRS{idVendor}=="0bb4", ATTRS{idProduct}=="2c87", TAG+="uaccess"
  KERNEL=="hidraw*", SUBSYSTEM=="hidraw", ATTRS{idVendor}=="28de", ATTRS{idProduct}=="2101", TAG+="uaccess"
  KERNEL=="hidraw*", SUBSYSTEM=="hidraw", ATTRS{idVendor}=="28de", ATTRS{idProduct}=="2000", TAG+="uaccess"
  KERNEL=="hidraw*", SUBSYSTEM=="hidraw", ATTRS{idVendor}=="28de", ATTRS{idProduct}=="1043", TAG+="uaccess"
  KERNEL=="hidraw*", SUBSYSTEM=="hidraw", ATTRS{idVendor}=="28de", ATTRS{idProduct}=="2050", TAG+="uaccess"
  KERNEL=="hidraw*", SUBSYSTEM=="hidraw", ATTRS{idVendor}=="28de", ATTRS{idProduct}=="2011", TAG+="uaccess"
  KERNEL=="hidraw*", SUBSYSTEM=="hidraw", ATTRS{idVendor}=="28de", ATTRS{idProduct}=="2012", TAG+="uaccess"
  SUBSYSTEM=="usb", ATTRS{idVendor}=="0bb4", ATTRS{idProduct}=="2c87", TAG+="uaccess"
  # HTC Camera USB Node
  SUBSYSTEM=="usb", ATTRS{idVendor}=="114d", ATTRS{idProduct}=="8328", TAG+="uaccess"
  # HTC Mass Storage Node
  SUBSYSTEM=="usb", ATTRS{idVendor}=="114d", ATTRS{idProduct}=="8200", TAG+="uaccess"
  SUBSYSTEM=="usb", ATTRS{idVendor}=="114d", ATTRS{idProduct}=="8a12", TAG+="uaccess"
  #+END_SRC

3. *Compile & launch Simula.*
  #+BEGIN_SRC shell
  # Ensure that SteamVR is launched.
  cd /path/to/simula
  make run # this should take a while also

  # Once Simula starts, launch some Wayland apps to interact with:
  weston-terminal # Wayland terminal
  epiphany        # Wayland web browser

  # You can also launch X apps:
  DISPLAY=:1 firefox # You have to tell X apps that Simula is located on DISPLAY 1
  # NOTE: This assumes Simula is launched on DISPLAY 1.
  #       Unless you have an unusual setup, this is usually the case by default;
  #       check Simula console output to check for sure.


  #+END_SRC

** COMMENT Arch
** COMMENT Nix[OS]
** Other Distros

Pending.


* Contributing

We're looking for open-source contributors. If you're interested in using Haskell to bring VR and Linux together, drop by our [[https://gitter.im/SimulaVR/Simula][chat room]], or email georgewsinger@gmail.com.

* Donations

If you're interested in a future where Linux and VR co-exist, you can donate to the following addresses:

#+BEGIN_QUOTE
*Bitcoin.* 17YLp6kJswxa8gGKwXqLrNtnM9Fgye6dfQ

*Ethereum.* 0x373227b43Fe1eFe8da9d30ED1Ee45E7488F6cab3

*PayPal.* george.w.singer@gmail.com
#+END_QUOTE

** COMMENT Project Expenses

*Project Expenses.* Donations to the project pay for the following expenses:
  - Part-time developers (x 1)
  - Vive donations to contributors (x 3)
  -

* Plans & Monthly Updates

See Simula's [[https://github.com/SimulaVR/Simula/wiki][Wiki]] for our Master Plan and list of Monthly Updates.

* TODO COMMENT TODOs
- [ ] SteamVR-for-Linux link
- [X] Explicit video link.