Skip to content

Game: Refactor and Updates to the Game Simulator #2806

Open
@lhw-1

Description

@lhw-1

As mentioned in #2805, an update for the Game Simulator is currently being planned. Here is the current list of ideas to be tackled:

  • Retire the Object Placement feature. While initially introduced to aid the story-writers with finding the co-ordinates for asset placements (to be written into the checkpoint files), as well as to allow exploring asset placement ideas, the current artwork assets often come with object shadows drawn onto the background images themselves, which limits flexibility on asset placement. Furthermore, the current game simulator cannot be accessed by students, limiting the potential use cases to ones for the story-writers. There is a potential for the Object Placement feature to play a role in flexible chapter design later on, but it may be easier to retire it for now and re-implement it with only the necessary features when needed, especially since the code will still be accessible through commit history of this repository. Completed as of Game: Remove Object Placement feature from Game Simulator #2810.

  • Replace the Panel with a Popover & Other UI Improvements. The current panel is somewhat messy both in terms of the UI (it does not scale in size with the simulator itself with browser resizes) as well as the UX (there are issues with the panel not being displayed when the Game Simulator is first launched). Replacing the panel with a popover, or other similar UI components that are more dynamic, would improve things greatly. This will likely be much easier in tandem with the next point:

  • Modification of how the Game Simulator works. Currently, a Source Academy game is created when the Game Simulator is first entered, and the four buttons are entered into the game as scenes. However, out of these four, only two actually require the game itself: Object Placement and the Chapter Simulator. And neither requires the game to be immediately available. Of course, creating a new game upon request everytime would also be unideal, but the fact remains that we don't need these four features to be available within the game as scenes. The immediate suggestion here would be to refactor the four features out of the game itself, and allow the game to only come into the picture when requested. This decision was also what necessitated the panel to be created as a UI component outside the game itself; by refactoring these out of the game, we can also avoid unnecessary limitations on the UI. More discussions could be had on how to handle the game itself within the simulator.

  • Renaming of UI Components. "Checkpoint Simulator" can be named "Simulate Chapter" instead, and "Chapter Simulator" can be named "Publish Chapter" instead, to better fit their actual functionalities. Completed as of Game: Refactor Game Simulator #2836.

  • Tests for the Game Simulator. Test cases and suites should be additionally implemented for the Game Simulator.

Metadata

Metadata

Assignees

Labels

EnhancementNew feature requestgameAll game related ideas, bugs, fixes

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions