Skip to content

liris-xr/PLUME-Protos

Repository files navigation

PLUME banner.

PLUME: Record, Replay, Analyze and Share User Behavior in 6DoF XR Experiences
Charles Javerliat, Sophie Villenave, Pierre Raimbaud, Guillaume Lavoué
(Journal Track) IEEE Conference on Virtual Reality and 3D User Interfaces
Video » Paper » Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About PLUME Protos
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Citation

About PLUME Protos

This repository stores the definition for samples used by the PLUME Recorder. These samples are based on protobuf to ease serialization on any platform.

Getting Started

Start by cloning the repository using the following command:

git clone https://github.com/liris-xr/PLUME-Protos.git

Prerequisites

Install protoc and put it in your PATH. You can find the procedure to install protoc here.
Install python and put it in your PATH.

How to build

Python

Simply run:

python build_all_python.py

A folder generated/python will be created, containing all the *_pb2.py files.

C#

Simply run:

python build_all_csharp.py

A folder generated/csharp will be created, containing all the *.g.cs files.

Usage

Import the generated files in your project and use the messages with protobuf.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the GPLv3 License.

Contact

Charles JAVERLIAT - charles.javerliat@gmail.com

Sophie VILLENAVE - sophie.villenave@ec-lyon.fr

Citation

@article{javerliat_plume_2024,
	title = {{PLUME}: {Record}, {Replay}, {Analyze} and {Share} {User} {Behavior} in {6DoF} {XR} {Experiences}},
	url = {https://ieeexplore.ieee.org/document/10458415},
	doi = {10.1109/TVCG.2024.3372107},
	journal = {IEEE Transactions on Visualization and Computer Graphics},
	author = {Javerliat, Charles and Villenave, Sophie and Raimbaud, Pierre and Lavoué, Guillaume},
	year = {2024},
	note = {Conference Name: IEEE Transactions on Visualization and Computer Graphics},
	pages = {1--11}
}