Mentions légales du service

Skip to content
Snippets Groups Projects
Commit a511a7d4 authored by MONSEIGNE Thibaut's avatar MONSEIGNE Thibaut
Browse files

:pencil: Update Doc And Readme

parent 197263e3
No related branches found
No related tags found
No related merge requests found
Pipeline #132250 passed
Stage: prepare
Stage: documentation
Stage: analysis
Stage: deploy
Hide whitespace changes
Inline Side-by-side
.gitlab-ci.yml
+ 2
− 0
View file @ a511a7d4
......@@ -30,6 +30,8 @@ documentation:
variables:
LogFile: DocumentationLogs.txt
script:
# Copy and fix README.md links
- sed -r 's#/?Documentation/##gi' README.md > Documentation/index.md
# Generate documentation
- docfx metadata -f Documentation/docfx.json | tee $LogFile
- docfx build -f Documentation/docfx.json | tee -a $LogFile
......
Documentation/index.md deleted 100644 → 0
+ 0
− 0
View file @ 197263e3
Documentation/resources/Scenario.png 0 → 100644
NaN GiB (NaN%)
View file @ a511a7d4
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
Documentation/resources/Screenshot01.png 0 → 100644
NaN GiB (NaN%)
View file @ a511a7d4
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
Documentation/resources/Screenshot02.png 0 → 100644
NaN GiB (NaN%)
View file @ a511a7d4
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
scenario-example.xml → Documentation/resources/scenario-example.xml
+ 46
− 66
View file @ a511a7d4
......@@ -35,11 +35,11 @@
<Attributes>
<Attribute>
<Identifier>(0x1fa7a38f, 0x54edbe0b)</Identifier>
<Value>368</Value>
<Value>272</Value>
</Attribute>
<Attribute>
<Identifier>(0x207c9054, 0x3c841b63)</Identifier>
<Value>928</Value>
<Value>720</Value>
</Attribute>
<Attribute>
<Identifier>(0x4e7b798a, 0x183beafb)</Identifier>
......@@ -55,6 +55,39 @@
</Attribute>
</Attributes>
</Box>
<Box>
<Identifier>(0x000029cc, 0x00007eba)</Identifier>
<Name>Hello World Game</Name>
<AlgorithmClassIdentifier>(0x46705bc3, 0x3058a939)</AlgorithmClassIdentifier>
<Inputs>
<Input>
<TypeIdentifier>(0x5ba36127, 0x195feae1)</TypeIdentifier>
<Name>Input signal</Name>
</Input>
<Input>
<TypeIdentifier>(0x6f752dd0, 0x082a321e)</TypeIdentifier>
<Name>Input stimulations</Name>
</Input>
</Inputs>
<Attributes>
<Attribute>
<Identifier>(0x1fa7a38f, 0x54edbe0b)</Identifier>
<Value>336</Value>
</Attribute>
<Attribute>
<Identifier>(0x207c9054, 0x3c841b63)</Identifier>
<Value>624</Value>
</Attribute>
<Attribute>
<Identifier>(0x4e7b798a, 0x183beafb)</Identifier>
<Value>(0xcb293370, 0xee8027f2)</Value>
</Attribute>
<Attribute>
<Identifier>(0xcfad85b0, 0x7c6d841c)</Identifier>
<Value>2</Value>
</Attribute>
</Attributes>
</Box>
<Box>
<Identifier>(0x00003552, 0x000054ad)</Identifier>
<Name>Time signal</Name>
......@@ -84,11 +117,11 @@
<Attributes>
<Attribute>
<Identifier>(0x1fa7a38f, 0x54edbe0b)</Identifier>
<Value>320</Value>
<Value>224</Value>
</Attribute>
<Attribute>
<Identifier>(0x207c9054, 0x3c841b63)</Identifier>
<Value>832</Value>
<Value>624</Value>
</Attribute>
<Attribute>
<Identifier>(0x4e7b798a, 0x183beafb)</Identifier>
......@@ -104,59 +137,6 @@
</Attribute>
</Attributes>
</Box>
<Box>
<Identifier>(0x00004148, 0x000062f5)</Identifier>
<Name>LSL Export</Name>
<AlgorithmClassIdentifier>(0x6f3467ff, 0x52794da6)</AlgorithmClassIdentifier>
<Inputs>
<Input>
<TypeIdentifier>(0x5ba36127, 0x195feae1)</TypeIdentifier>
<Name>Input signal</Name>
</Input>
<Input>
<TypeIdentifier>(0x6f752dd0, 0x082a321e)</TypeIdentifier>
<Name>Input stimulations</Name>
</Input>
</Inputs>
<Settings>
<Setting>
<TypeIdentifier>(0x79a9edeb, 0x245d83fc)</TypeIdentifier>
<Name>Signal stream</Name>
<DefaultValue>openvibeSignal</DefaultValue>
<Value>ovSignal</Value>
<Modifiability>false</Modifiability>
</Setting>
<Setting>
<TypeIdentifier>(0x79a9edeb, 0x245d83fc)</TypeIdentifier>
<Name>Marker stream</Name>
<DefaultValue>openvibeMarkers</DefaultValue>
<Value>ovMarkers</Value>
<Modifiability>false</Modifiability>
</Setting>
</Settings>
<Attributes>
<Attribute>
<Identifier>(0x1fa7a38f, 0x54edbe0b)</Identifier>
<Value>432</Value>
</Attribute>
<Attribute>
<Identifier>(0x207c9054, 0x3c841b63)</Identifier>
<Value>832</Value>
</Attribute>
<Attribute>
<Identifier>(0x4e7b798a, 0x183beafb)</Identifier>
<Value>(0xcb2933f5, 0x2180a23d)</Value>
</Attribute>
<Attribute>
<Identifier>(0xce18836a, 0x9c0eb403)</Identifier>
<Value>2</Value>
</Attribute>
<Attribute>
<Identifier>(0xcfad85b0, 0x7c6d841c)</Identifier>
<Value>2</Value>
</Attribute>
</Attributes>
</Box>
<Box>
<Identifier>(0x0000629e, 0x000034f6)</Identifier>
<Name>Simple DSP</Name>
......@@ -185,11 +165,11 @@
<Attributes>
<Attribute>
<Identifier>(0x1fa7a38f, 0x54edbe0b)</Identifier>
<Value>368</Value>
<Value>272</Value>
</Attribute>
<Attribute>
<Identifier>(0x207c9054, 0x3c841b63)</Identifier>
<Value>832</Value>
<Value>624</Value>
</Attribute>
<Attribute>
<Identifier>(0x30a4e5c9, 0x83502953)</Identifier>
......@@ -235,24 +215,24 @@
</Target>
</Link>
<Link>
<Identifier>(0x00003661, 0x0000514c)</Identifier>
<Identifier>(0x00000e9b, 0x00001c1a)</Identifier>
<Source>
<BoxIdentifier>(0x0000629e, 0x000034f6)</BoxIdentifier>
<BoxOutputIndex>0</BoxOutputIndex>
</Source>
<Target>
<BoxIdentifier>(0x00004148, 0x000062f5)</BoxIdentifier>
<BoxIdentifier>(0x000029cc, 0x00007eba)</BoxIdentifier>
<BoxInputIndex>0</BoxInputIndex>
</Target>
</Link>
<Link>
<Identifier>(0x00005817, 0x00004c99)</Identifier>
<Identifier>(0x000031d4, 0x00003e9b)</Identifier>
<Source>
<BoxIdentifier>(0x00001d83, 0x00005bb9)</BoxIdentifier>
<BoxOutputIndex>0</BoxOutputIndex>
</Source>
<Target>
<BoxIdentifier>(0x00004148, 0x000062f5)</BoxIdentifier>
<BoxIdentifier>(0x000029cc, 0x00007eba)</BoxIdentifier>
<BoxInputIndex>1</BoxInputIndex>
</Target>
</Link>
......@@ -260,15 +240,15 @@
<Comments>
<Comment>
<Identifier>(0x00006a65, 0x00005977)</Identifier>
<Text>Signal = Sin((time)</Text>
<Text>Signal = Sin(time)</Text>
<Attributes>
<Attribute>
<Identifier>(0x473d9a43, 0x97fc0a97)</Identifier>
<Value>832</Value>
<Value>624</Value>
</Attribute>
<Attribute>
<Identifier>(0x7234b86b, 0x2b8651a5)</Identifier>
<Value>272</Value>
<Value>176</Value>
</Attribute>
</Attributes>
</Comment>
......
README.md
+ 20
− 3
View file @ a511a7d4
# Hello World Game
First Game For OpenViBE
[![pipeline status](https://gitlab.inria.fr/openvibe/unity-games/hello-world/badges/master/pipeline.svg)](https://gitlab.inria.fr/openvibe/unity-games/hello-world/commits/master)
[![Documentation](https://img.shields.io/badge/Documentation-deploy-success)](https://openvibe.gitlabpages.inria.fr/unity-games/hello-world/)
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
......@@ -11,11 +9,30 @@ First Game For OpenViBE
[![Vulnerabilities](https://sonarqube.inria.fr/sonarqube/api/badges/measure?key=inria:openvibe:games:helloworld:master&metric=vulnerabilities)](https://sonarqube.inria.fr/sonarqube/component_measures?id=inria:openvibe:games:helloworld:master&metric=vulnerabilities)
[![Code Smells](https://sonarqube.inria.fr/sonarqube/api/badges/measure?key=inria:openvibe:games:helloworld:master&metric=code_smells)](https://sonarqube.inria.fr/sonarqube/component_measures?id=inria:openvibe:games:helloworld:master&metric=code_smells)
## Description
This game is a template to use LSL to communicate with external software and in our case with [OpenViBE](http://openvibe.inria.fr/).
In parallel, we create an OpenViBE box derived from the LSL export box for the game.
This makes it easier to use the two tools.
It is always possible to use the previous LSL Export box.
But in order to make life easier for the community, it will be highly recommended to plan one box per game.
For example if several streams must be created or not, If several inputs must be combined, if settings must be given...
## Dependency
- LSL4Unity
- [LSL4Unity](https://github.com/tmonseigne/LSL4Unity)
## Screenshots
<div style="text-align:center"><img src="Documentation/resources/Screenshot01.png" /></div>
<div style="text-align:center"><img src="Documentation/resources/Screenshot02.png" /></div>
## OpenViBE Scenario Example
<div style="text-align:center"><img src="Documentation/resources/Scenario.png" /></div>
## Thanks
Thanks to Erwan Normand for the two tutorials :
- [Setup SonarQube for a Unity project on GitLab](https://gitlab.inria.fr/snippets/513)
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment