Skip to content
This repository has been archived by the owner on May 5, 2020. It is now read-only.

Latest commit

 

History

History
273 lines (202 loc) · 9.9 KB

README.MD

File metadata and controls

273 lines (202 loc) · 9.9 KB
Raw

PowerUp Scenario Builder

Created by: @justKD

Live App via CodeSandbox

PowerUp Scenario Builder is a web app for creating question and answer tables for PowerUp (iOS, Android), a text-adventure style mobile game by AnitaB.org Open Source.

PowerUp Scenario Builder

Best experienced in Chrome. Also works in Safari and Firefox. Possibly with quirks.

Changelog

v1.1.0

  • Moved development to create-react-app environment
  • Most UI components recreated with React and Material-UI.
  • Replaced live app URL with a build via CodeSandbox.

v1.0.0

  • Initial release

Contents

Setup

Set the Scenario ID

Each graph represents the questions and answers for a single scenario in PowerUp.

When starting a new graph, the first thing you'll want to do is set your scenario ID.

The first card in every graph is unique. It serves as the first question presented to the player, but it also sets the ScenarioID for all subsequent cards.

Double-click on the value next to ScenarioID and change it to match the ScenarioID of the scenario you're working on.

You can edit the values of non-italicized text by double-clicking on it.

  • This is an important first step when you start a new work session.
    • This value is inherited by subsequent question cards.
    • It also creates a name space for numbering questions and answers.
    • If you forget to set it first, you may need to manually update the IDs for some cards.

Set the Text for the First Question

Double-click on the text at the top of the first card to edit it.

You don't need to set the QuestionID at this time.

Add your first answer card, and it will automatically set the starting QuestionID.

Cards

Adding and Editing Cards

Add a New Card

Click the plus icon to add a new child card.

  • Cards will automatically alternate type (question or answer).
  • Every question can have multiple answer cards attached to either end.
  • Each answer card can only have one question attached to either end.
    • This is to simplify Q&A relationships in order to avoid mistakes or unnecessary redundancies.
  • Cards can not be linked in a way that would ever create an infinite loop. This rule is further enforced when re-linking.
  • Cards will attempt to automatically set their ID fields.
  • Questions will attempt to update the NextQID field of parent answers.

You can manually edit the values in these fields, but doing so may result in undesired behavior from the automatic numbering system. Always check your work if you make manual edits.

Editing Fields

Double-click on non-italicized text to change it.

Like the starting card, the text at the top of each card is the actual Question or Answer text. Change the default "new" to be the appropriate text that should appear in PowerUp.

Moving Cards

To move a card, click and drag on an empty area inside the card.

You can move a card anywhere within the work area, but overlapping cards will be automatically re-positioned.

Deleting Cards

To delete a card, click inside any empty space in the card to select it, and press your delete key.

Card Types

  • Question Cards
    • QuestionID is a unique numerical identifier for that particular question card.
  • Answer Cards
    • AnswerID is a unique numerical identifier for that particular answer card.
      • When adding an answer, the AnswerID will be automatically assigned based on the ScenarioID set in the starting card.
      • This value can be manually changed if necessary, but new answers will continue to use the internal counter to set the default AnswerID.
    • QuestionID is the identifier for the preceding question.
      • It should always match the QuestionID of the question card connected to the left port of the answer card.
    • NextQID is the identifier for the resulting question.
      • It should always match the QuestionID of the question card connected to the right port of the answer card.
      • This value is automatically assigned when a question is connected.
      • This field must be manually set in order to end the scenario. - A terminating answer should not be connected to a child question.
    • PopupID determines if selecting this answer will launch a popup event.
      • These are popup events managed by the PowerUp class PopupEventPlayer.
      • This value should match the appropriate value in Popups.json, found in the PowerUp repository.
      • Set this value to a non-numerical character if there is no popup associated with this answer. - e.g. &
    • Points is the amount of karma points given to the player when this answer is selected.
      • Defaults to 2.

Re-linking Cards

You can delete a link by clicking to select it and pressing your Delete key.

Click and drag on the plus icon (right-side port of a card) to start re-linking a card.

Drag the new link to the left-side port of the target card, and release to create the link.

Re-linking follows the same rules as adding cards. Attempts to create illegal links are ignored.

Manually create links in order to assign multiple answers to the left-side port of a question.

Ending the Scenario

End a scenario by manually setting the appropriate value in the NextQID field of a terminating answer.

  • Set this value to a negative integer to end the scenario and launch a mini-game.
    • Each mini-game has a unique negative integer as an identifier.
      • As of Aug. 1, 2018:
        • -1 - Minesweeper
        • -2 - Sink to Swim
        • -3 - Vocab Matching
  • Set this value to a non-numerical character to end the scenario without a mini-game.
    • e.g. $

Menu Options

  • ? Opens and closes the quick help panel.
    • The quick help panel is scrollable.
  • Save downloads a local copy of your current work session to your normal web downloads folder.
    • The file is a representation of the current state of your work session, including all values and card positions.
    • The file name defaults to powerup-map.json, but, after downloading, it can be renamed to something more descriptive.
  • Layout automatically cleans up the layout of your work area.
    • Beware, this will undo any intentional manual layout changes.
  • Load will open a file finder dialog.
    • Select a previously saved JSON downloaded with the Save JSON option, and the work session will be restored.
    • The file name does not matter. Only the structure of the JSON data.
  • Export Answers will download all answers as a CSV table.
    • This format matches the database in the Android version of PowerUp.
    • For the iOS version, the table will need to be imported into the SQLite database.
    • The easiest way is probably to use a GUI editor such as DB Browser for SQLite.
  • Export Questions will download all questions as a CSV table.
    • Otherwise, the details are the same as Export Answers.
  • Export SVG will download the current work session as an editable SVG.
    • The exported SVG can not be imported, so any editing done to the SVG map is strictly for convenience.
    • This feature is meant to make it easier to embed the map in other documents, or to share with other reviewers/editors.
    • Large maps may not be printer-friendly. The SVG can be split up into smaller sections using most vector graphics editors.
  • Export PDF will download the current work session as a PDF image.
    • This feature serves a similar purpose as the Export SVG option.
    • Unless there is a reason to share SVG, this option will typically be better for viewing a static map.

Navigating the Work Area

  • Pan - Click and drag in empty white space - Arrow keys
  • Zoom
    • Middle mouse wheel to zoom
    • Zoom in/out gestures on a touch pad - ctrl + and ctrl -
  • Undo - ctrl z or cmd z on macOS
  • Redo - ctrl y or cmd y on macOS
  • Zoom-To-Fit
    • shift z