Game: Create a new quiz feature #2919

CYX22222003 · 2024-04-09T11:03:36Z

Description

Previously, the quiz feature of the game was implemented by jumping between dialogue segments based on the player's choices. We have now separated the quiz component from the dialogue objects and achieved the following improvements:

Display scores and store quiz results
Create branching storylines based on different quiz results
Simplify story writing syntax for quiz components

GameQuizManager

Renders the quiz using dialogue boxes and prompts UI. A prompt for players to choose whether they want to start the quiz is added before every quiz starts.

QuizParser

Parses the quiz content under the quizzes header in the story file.

Saving quiz results

Quiz results are saved as an array of [string, number] pairs, representing the quizId and the latest score of the corresponding quiz. The score of a quiz is the number of questions answered correctly.

New actions & conditions

Adds new action show_quiz to show a quiz. The show_quiz action is recommended to only be used in dialogues. During a quiz, the dialogue box and speaker belonging to the dialogue will be set invisible, and keyboard inputs will be disabled.

New conditions attemptedQuiz, passedQuiz, and quizScore are added for story writers to check the completion status of a quiz. attemptedQuiz is true if the player has played all questions in the given quiz, regardless of the scores obtained. passedQuiz is true if the player has played all questions in the given quiz and got full marks. quizScore is true if the score of the given quiz is greater than or equal to the given number.
The syntax for conditions in txt file is as follows:

attemptedQuiz.<quizId>
passedQuiz.<quizId>
quizScore.<quizId>.<number>

Interpolation of quiz scores in dialogues

Storywriters can insert quiz scores in dialogue lines. This allows writers to define how they want to show the quiz score. The syntax in txt file is similar to inserting the player's name in dialogues:

@scottie, normal, left
You got {<quizId>.score} questions right!

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update
Code quality improvements

How to test

As this feature should be backward compatible, all previous mock chapters on Source Academy & all chapters already uploaded on Source Academy should function without issues.
A mock chapter containing quizzes is used to test the new features in the game simulator.

Checklist

I have tested this code
I have updated the documentation

coveralls · 2024-04-09T11:10:55Z

Pull Request Test Coverage Report for Build 9114802444

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 31.41%

Totals
Change from base Build 9101202777:	0.0%
Covered Lines:	4891
Relevant Lines:	14671

💛 - Coveralls

…fault (#2848) * Make compact components the new default and remove any mentions to the old components. Also removes the experimental button toggle. * Update test snapshots * Clean up testing code a little * Formatting changes * Fix some minor issues

* bumping js-slang * Update tests * remove obsolete snapshots --------- Co-authored-by: NhatMinh0208 <minhkhicon2468@gmail.com>

…n in QuizManager

…store quiz questions to dialogue log

RichDom2185

Hi, sorry for the late review, thanks wo I did a quick look through the code and have some rough feedback below.

P.S.: Could you provide a screenshot of what the new feature looks like?

src/features/game/save/GameSaveTypes.ts

src/features/game/state/GameStateManager.ts

src/features/game/dialogue/GameDialogueManager.ts

Modify getDialogueRenderer method access modifier

correct documentation errors

Remove the unnecessary use of parameterized type

simplify unnecessary conditional statement Co-authored-by: Richard Dominick <34370238+RichDom2185@users.noreply.github.com>

CYX22222003 · 2024-05-12T13:50:47Z

Hi, sorry for the late review, thanks wo I did a quick look through the code and have some rough feedback below.

P.S.: Could you provide a screenshot of what the new feature looks like?

quiz question and options:

quiz starting prompt

character reaction to students' response

lhw-1

Thanks for the PR @CYX22222003 @reginateh - your work over the semester is much appreciated! This feature should be quite helpful for game storywriters moving forward 😄

Apart from the images (which I see you've posted), could you also provide a full example of a quiz being written in a checkpoint txt file? It would be helpful as a cross-reference.

Also, after this PR, please don't forget to update the documentation for the game developer guide & the storywriter guide!

Here are some small queries / nits to address:

lhw-1 · 2024-05-15T15:40:35Z

src/features/game/action/GameActionExecuter.ts

+        globalAPI.enableKeyboardInput(false);
+        await globalAPI.showQuiz(actionParams.id);
+        globalAPI.enableKeyboardInput(true);


Could you remind me on why disabling and then enabling keyboard input is necessary here?

(I do remember discussing this in person but can't seem to remember why at the moment & will be better to have it documented within the PR as well)

I believe this is to prevent the trigger of dialogue line proceeding while attempting the quiz.

src/features/game/dialogue/GameDialogueManager.ts

lhw-1 · 2024-05-15T15:46:35Z

src/features/game/dialogue/GameDialogueManager.ts

@@ -79,6 +80,7 @@ export default class DialogueManager {

    // Disable interactions while processing actions
    GameGlobalAPI.getInstance().enableSprite(this.getDialogueRenderer().getDialogueBox(), false);
+    this.getInputManager().enableKeyboardInput(false);


Disabling and then enabling keyboard input was already done in GameActionExecuter.ts - are the rationale different for these two cases?

I believe that the enabling and disabling input in GameActionExecutor is because we currently disable any keyboard inputs while attempting the quiz to prevent its interference with the normal proceeding of dialogue.

src/features/game/dialogue/GameDialogueRenderer.ts

src/features/game/dialogue/GameDialogueSpeakerRenderer.ts

src/features/game/quiz/GameQuizManager.ts

lhw-1 · 2024-05-15T16:08:35Z

src/features/game/quiz/GameQuizManager.ts

+      header,
+      quizQuestionBox,
+      quizQuestionWriter.container
+    ]);


Given that there is quite a bit of rendering-related code here, I'm wondering if a refactor would be a possibility - any thoughts?

(It's fine if it's non-trivial, given the complex inter-weaving between dialogue and quizzes - a bigger refactor might be necessary later on, which would be out of scope for this PR. But if possible, we should prevent it from snowballing early on)

It seems to be possible that we can create a method for generating all the UI components and return them as an array. Any other thoughts @reginateh

src/features/game/quiz/GameQuizManager.ts

src/features/game/scenes/gameManager/GameGlobalAPI.ts

refactor the logic of makeLineQuizScores method Co-authored-by: reginateh <154109919+reginateh@users.noreply.github.com>

remove unnecessary comment line

change method access modifiers

reformatting Co-authored-by: Lee Hyung Woon / 이형운 <leehyungwoonsamuel@gmail.com>

change variable name

change the parameters of game components setting

CYX22222003 · 2024-05-16T10:34:43Z

Thanks for the PR @CYX22222003 @reginateh - your work over the semester is much appreciated! This feature should be quite helpful for game storywriters moving forward 😄

Apart from the images (which I see you've posted), could you also provide a full example of a quiz being written in a checkpoint txt file? It would be helpful as a cross-reference.

Also, after this PR, please don't forget to update the documentation for the game developer guide & the storywriter guide!

Here are some small queries / nits to address:

Here is a sample of quiz:

quizzes
    sourceManual
        0
        What is the pre-declared constant for: The Number value for π, the ratio of the circumference of a circle to its diameter?
        answer: 3
        option
            apple_Pi
            @ershk, thinking, left
            ...Are you hungry or something?
        option
            math_Pi
        option
            math_pi
        option
            math_PI

        1
        What is the pre-declared constant for: The Number value for the base-10 logarithm of e, the base of the natural logarithms?
        answer: 2
        option
            math_L10
        option
            math_LOG10
        option
            math_LOG10E
        option
            math_L10E

    telebayConsole
        0
        The first expression is: 100 + 37; What is the simplified form for this expression?
        answer: 3
        option
            13
        option
            37
        option
            100
        option
            137
            @scottie, smile, left
            Great! Looks like that worked.

        1
        The second expression is: (6 + 8) * 7 + 2 * 3; What is the simplified form for this expression?
        answer: 1
        option
            103
        option
            104
            @scottie, smile, left
            Great! Looks like that worked, too.
        option
            300
        option
            378

Use the showQuiz method inside a dialogue

 2
        @ershk, excited, left
        Yeah. Let's do this!
        @ershk, happy, left
        You can refer to the Source documentation if you'd like! Maybe that will help us get used to it, too.
        @ershk, normal, left
        Let's get started!
            show_quiz*(sourceManual)
        @ershk, normal, left

CYX22222003 · 2024-05-16T10:37:31Z

Thanks for the PR @CYX22222003 @reginateh - your work over the semester is much appreciated! This feature should be quite helpful for game storywriters moving forward 😄

Apart from the images (which I see you've posted), could you also provide a full example of a quiz being written in a checkpoint txt file? It would be helpful as a cross-reference.

Also, after this PR, please don't forget to update the documentation for the game developer guide & the storywriter guide!

Here are some small queries / nits to address:

We have updated the game developer guide but we cannot push our changes of the storywriter guide to the general repo.

Correct parsers' behavior for errors Co-authored-by: Lee Hyung Woon / 이형운 <leehyungwoonsamuel@gmail.com>

CYX22222003 requested a review from lhw-1 April 9, 2024 11:03

CYX22222003 assigned reginateh Apr 9, 2024

reginateh and others added 27 commits April 10, 2024 17:18

add new action show_quiz

90694b3

add quiz parser & quiz manager

2ecf439

reformat

9758022

bumping js-slang (#2852)

491a4f3

* bumping js-slang * Update tests * remove obsolete snapshots --------- Co-authored-by: NhatMinh0208 <minhkhicon2468@gmail.com>

add quiz manager

59143df

create quiz result type

583f14e

hide dialogue box while showing quiz

a8d37b9

modify character hidding feature

eab42e5

track and display quiz results

91f7976

debugging for speaker displaying

023c9cb

midify UI for quiz displaying

6d34b75

update UI for quiz display

fd701c9

attempt to rebase

85ef1fb

small bug fix

f7eaed7

solve quiz speaker issue

c7044b5

remove default reaction in QuizParser and handle no reaction situatio…

35dd94c

…n in QuizManager

add a new property (boolean array) in Quiz type to record quiz result

a740601

rearrange quiz result

0891160

minor changes & comment

fe704ae

remove redundant file and console logs

112b8a3

save quiz status as attempted/completed arrays

0515c9c

add conditions to check whether a quiz is attempted/completed

60c8c00

modify UI again

8ac29d5

disable keyboard input in a quiz

116e0f3

move question prompt text to QuizConstants

4a9b71a

QuizParser error handling & add new "speaker" property to QuizType & …

e47a20a

…store quiz questions to dialogue log

CYX22222003 and others added 6 commits April 23, 2024 18:04

Merge branch 'master' into game-quiz2

3c4697b

Merge branch 'master' into game-quiz2

12a4190

Merge branch 'master' into game-quiz2

ab6341e

Merge branch 'master' into game-quiz2

aea3aed

Merge branch 'master' into game-quiz2

9205153

Merge branch 'master' into game-quiz2

7c38472

RichDom2185 reviewed May 12, 2024

View reviewed changes

CYX22222003 and others added 5 commits May 12, 2024 20:32

Update GameDialogueManager.ts

6953459

Modify getDialogueRenderer method access modifier

Update GameSaveTypes.ts

e005eb7

correct documentation errors

Update GameStateManager.ts

cacd2f2

Remove the unnecessary use of parameterized type

Update src/features/game/state/GameStateManager.ts

0b232ea

simplify unnecessary conditional statement Co-authored-by: Richard Dominick <34370238+RichDom2185@users.noreply.github.com>

Merge branch 'master' into game-quiz2

725f9f8

CYX22222003 added 3 commits May 13, 2024 19:18

Merge branch 'master' into game-quiz2

b2eb34a

Merge branch 'master' into game-quiz2

6de3681

Merge branch 'master' into game-quiz2

10d5a83

lhw-1 reviewed May 15, 2024

View reviewed changes

CYX22222003 and others added 8 commits May 16, 2024 11:49

Merge branch 'master' into game-quiz2

e72fe77

Update src/features/game/dialogue/GameDialogueManager.ts

54ec50e

refactor the logic of makeLineQuizScores method Co-authored-by: reginateh <154109919+reginateh@users.noreply.github.com>

Update GameQuizManager.ts

1feee8b

remove unnecessary comment line

Update GameDialogueSpeakerRenderer.ts

7c5b4bd

change method access modifiers

Update GameQuizSpeakerRenderer.ts

4960cb9

change method access modifiers

Update src/features/game/dialogue/GameDialogueRenderer.ts

c455348

reformatting Co-authored-by: Lee Hyung Woon / 이형운 <leehyungwoonsamuel@gmail.com>

Update GameQuizManager.ts

e21f292

change variable name

Update GameQuizManager and GameQuizConstants

e33cb15

change the parameters of game components setting

guest1@CHENYIXUN and others added 3 commits May 16, 2024 22:59

Modifying showNextLine method in GameGlobalAPI

3ba8991

Reformatting

b3f268f

Update src/features/game/parser/QuizParser.ts

4e639f4

Correct parsers' behavior for errors Co-authored-by: Lee Hyung Woon / 이형운 <leehyungwoonsamuel@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Game: Create a new quiz feature #2919

Game: Create a new quiz feature #2919

CYX22222003 commented Apr 9, 2024 •

edited

coveralls commented Apr 9, 2024 •

edited

RichDom2185 left a comment

CYX22222003 commented May 12, 2024

lhw-1 left a comment

lhw-1 May 15, 2024

CYX22222003 May 16, 2024 •

edited by reginateh

lhw-1 May 15, 2024

CYX22222003 May 16, 2024

lhw-1 May 15, 2024

CYX22222003 May 16, 2024

CYX22222003 commented May 16, 2024

CYX22222003 commented May 16, 2024

Game: Create a new quiz feature #2919

Are you sure you want to change the base?

Game: Create a new quiz feature #2919

Conversation

CYX22222003 commented Apr 9, 2024 • edited

Description

GameQuizManager

QuizParser

Saving quiz results

New actions & conditions

Interpolation of quiz scores in dialogues

Type of change

How to test

Checklist

coveralls commented Apr 9, 2024 • edited

Pull Request Test Coverage Report for Build 9114802444

Details

💛 - Coveralls

RichDom2185 left a comment

Choose a reason for hiding this comment

CYX22222003 commented May 12, 2024

lhw-1 left a comment

Choose a reason for hiding this comment

lhw-1 May 15, 2024

Choose a reason for hiding this comment

CYX22222003 May 16, 2024 • edited by reginateh

Choose a reason for hiding this comment

lhw-1 May 15, 2024

Choose a reason for hiding this comment

CYX22222003 May 16, 2024

Choose a reason for hiding this comment

lhw-1 May 15, 2024

Choose a reason for hiding this comment

CYX22222003 May 16, 2024

Choose a reason for hiding this comment

CYX22222003 commented May 16, 2024

CYX22222003 commented May 16, 2024

CYX22222003 commented Apr 9, 2024 •

edited

coveralls commented Apr 9, 2024 •

edited

CYX22222003 May 16, 2024 •

edited by reginateh