> For the complete documentation index, see [llms.txt](https://saianirudh-karri.gitbook.io/vreqst/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://saianirudh-karri.gitbook.io/vreqst/vreqst-tool-support-for-specifying-requirements-for-virtual-reality-software-products.md).
# VReqST - Tool Support for specifying requirements for Virtual Reality Software Products
### **Who needs this VReqST tool?**
This is going to be a ground zero for people who would like to start building enterprise Virtual Reality (VR) Software Products. We know how difficult it is to provide requirements to your VR development team **\[1] \[3]**. The tools currently practiced as not effective enough to describe an overall flow of a VR Scene in detail. Thus, we built VReqST tool for requirement analysts from Virtual Reality Domain to ease their journey on capturing requirements and specify them accurately for designers and developer to have a seamless development. So, if you are manually specifying your VR requirements in plain English, try using VReqST and let us know your experiences.
We simplified VR requirements specification into 5 simple steps as listed below:
1. **Scene** - Describe the basic properties of a scene type
2. **Article** - Describe the types of articles or objects used in the scene
3. **Action-Response** - Describe the actions performed by or on the articles along with their respective response outcomes
4. **Custom** - Describe behavior of the certain article and its action using minimal code constraints
5. **Timeline** - Describe the synchronous and asynchronous events in a timeline
Each step is generalized using a Role Based model template **\[2]** i.e. a meta model of a bare-minimum Virtual Software System and represented in a JSON format for requirement analysts to fill and share it with the respective designer and developer team **\[4]**.
Role based Model Template of a bare minimum VR Software System
Each step is a JSON template backed with a underlying validator which validates the template against predefined rules that are described in detail in the further part of the documentation. Please follow the documentation carefully to understand the JSON template of each step.
### **Can I deploy this tool locally?**
Yes, here is the [source code](https://github.com/Amogha027/VReqST-2). This tool is build using ReactJS for front-end and MongoDB as a back-end. You can follow the deployment instructions provided in github repo and try it out. You can also find the overall demo of the tool [here](https://zenodo.org/record/7638468#.Y-tNkHZBzBV). Also find various example specifications [here](https://github.com/sai11101989/VReqST/tree/main/SampleSpec).
### **What if I have queries? Who do I reach out to?**
If are struck with VReqST tool setup or queries, please write to . I will try to respond to you at the earliest.
#### References:
1. Sai Anirudh Karre, Y. Raghu Reddy, and Raghav Mittal. 2024. ***RE Methods for Virtual Reality Software Product Development: A Mapping Study.*** ACM Trans. Softw. Eng. Methodol. 33, 4, Article 88 (May 2024), 31 pages.
2. Sai Anirudh Karre, Karthik Vaidhyanathan, and Y. Raghu Reddy. 2023. ***A Tool based Experiment to Teach Elicitation and Specification of Virtual Reality Product Requirements.*** In Proceedings of the ACM Conference on Global Computing Education Vol 2 (CompEd 2023). Association for Computing Machinery, New York, NY, USA, 195.
3. Sai Anirudh Karre, Raghav Mittal, and Raghu Reddy. 2023. ***Requirements Elicitation for Virtual Reality Products - A Mapping Study.*** In Proceedings of the 16th Innovations in Software Engineering Conference (ISEC '23). Association for Computing Machinery, New York, NY, USA, Article 12, 1–11.
4. Sai Anirudh Karre, Vivek Pareek, Raghav Mittal, and Raghu Reddy. 2022. ***A Role Based Model Template for Specifying Virtual Reality Software.*** In Proceedings of the 37th IEEE/ACM International Conference on Automated Software Engineering (ASE '22). Association for Computing Machinery, New York, NY, USA, Article 225, 1–5.
Made with ❤️ at [**SERC**](https://serc.iiit.ac.in)**,** [**IIIT Hyderabad**](https://iiit.ac.in)**, India**
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://saianirudh-karri.gitbook.io/vreqst/vreqst-tool-support-for-specifying-requirements-for-virtual-reality-software-products.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.