Skip to content

Onboarding tutorial on first connection#84

Merged
moufmouf merged 34 commits into
workadventure:mainfrom
HimeShaman:first-connection-tutorial
Jan 7, 2022
Merged

Onboarding tutorial on first connection#84
moufmouf merged 34 commits into
workadventure:mainfrom
HimeShaman:first-connection-tutorial

Conversation

@HimeShaman
Copy link
Copy Markdown
Contributor

@HimeShaman HimeShaman commented Nov 3, 2021

Will need code from this PR on workadventure to work

Copy link
Copy Markdown
Collaborator

@moufmouf moufmouf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need a way to say the tutorial should be enabled (or disabled) by default.
So we need to add a property at the top level of the map.

Something like

tutorial: true

saying the tutorial should happen for this map.

Also, we need to add a documentation for the tutorial (in the /docs directory)

Comment thread src/Features/tutorial.ts Outdated
Comment thread src/Iframes/Tutorial/style/style.scss Outdated
@HimeShaman HimeShaman force-pushed the first-connection-tutorial branch from 24c7cf6 to 17a392c Compare December 10, 2021 17:12
@HimeShaman HimeShaman force-pushed the first-connection-tutorial branch 3 times, most recently from 5e649a6 to 30d45ae Compare January 3, 2022 16:35
Comment thread docs/reference.md Outdated
@HimeShaman HimeShaman force-pushed the first-connection-tutorial branch from 90466c9 to 7d99885 Compare January 7, 2022 14:15
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

Merging #84 (6f8eaa5) into main (1a75fde) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #84   +/-   ##
=======================================
  Coverage   55.17%   55.17%           
=======================================
  Files           1        1           
  Lines          29       29           
  Branches        5        5           
=======================================
  Hits           16       16           
  Misses         13       13           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1a75fde...6f8eaa5. Read the comment docs.

@moufmouf moufmouf merged commit f660bb2 into workadventure:main Jan 7, 2022
moufmouf added a commit that referenced this pull request Jan 7, 2022
Onboarding tutorial on first connection (#84)


* First commit - adds whole feature

* Removes ts-ignore annotations

* Uses player state in order to get and set "tutorialDone" value

* Prettier refactoring

* Makes tutorial iframe open under the player

* WIP no overflows on sides

* No more overflowing

* Refactoring and test map update

* Makes dialog box slightly transparent so the player position is never fully hidden to the user

* Typo fix

* Deletes redo button + slight refactoring

* WIP tutorial iteration

* EndWIP: makes tutorial follow player and switches Walter for Tutopi

* Adjusts html/css for mobile version

* Uses the camera API to prevent the iframe from crossing worldView boundaries

* horizontal borders based on available area

* Mobile integration

* Responsive style for both mobile and desktop

* Adds new assets and make the iFrame fit whatever the scaling is

* Adds new video assets and clean old ones + config adjusted

* Uses the player state to trigger tutorial

* Removes unused css

* Test map updates: shortcut to corners

* fix wrong original y value for the iframe

* Completes the test map

* Factorise regex for user agent

* Removes unused console.log

* Makes the tutorial optional depending on associated map prop

* Adds documentation

* Typo correction

* Update docs/reference.md

Co-authored-by: David Négrier <d.negrier@thecodingmachine.com>

* imports WasCameraUpdatedEvent from typings package

* Updates packages

* Corrects types

Co-authored-by: Benedicte Quimbert <b.quimbert@workadventu.re>
Co-authored-by: David Négrier <d.negrier@thecodingmachine.com>
github-actions Bot pushed a commit that referenced this pull request Jan 7, 2022
# [1.2.0](v1.1.1...v1.2.0) (2022-01-07)

### Features

* **tutorial:** adding an easy to add "tutorial" ([ff749c8](ff749c8)), closes [#84](#84)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants