From ec849b37e2b44a798a0670b58b915b247cd83d05 Mon Sep 17 00:00:00 2001 From: Florent Berthaut <florent.berthaut@univ-lille.fr> Date: Sun, 3 Dec 2023 10:21:01 +0100 Subject: [PATCH] Update readme --- README.md | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d30bf57..0ce61b8 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,18 @@ -# IVMI +# IVMI-builder (work in progress) -Facilitates creating immersive instruments +IVMI-builder is a free-software framework that facilitates the design of +Immersive Virtual Musical Instruments. It relies on the Godot game engine +and the PureData audio programming language. -Connect to or integrates PureData patches -Networking +## Prerequisites -## Install - - -To run the Pd patches, install gdpd, otherwise you can run PureData -on a computer on the same network, which enables live-editing of the sound -synthesis while the instrument is running. - -To render with an OpenXR compatible device (HMD, mobile) install godot-openxr - -To render on a stereoscopic (anaglyph, passive in splitscreen, or quadbuffer) display -install GdScreenVr +* PureData from [https://puredata.info](https://puredata.info) +* Godot 4.x from [https://godotengine.org/](https://godotengine.org/), with [OpenXR activated](https://docs.godotengine.org/en/stable/tutorials/xr/setting_up_xr.html) +* If you want to be able to integrate the audio when releasing your instrument + (e.g. in a binary or as an app), install the [Gdpd addon](https://gitlab.univ-lille.fr/ivmi/gdpd) --- -- GitLab