Oliver/Phantom-Ink-Online
0
0
Fork 0
Code Issues Activity

Add configuration section to README

Browse source
This commit is contained in:
Oliver-Akins 2021-01-09 01:20:15 -07:00
parent 3cb599511e
commit c16257cdbe
1 changed files with 30 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

31
web/README.md
View file

@ -41,4 +41,33 @@ will need to change the port value in `src/main.js` to the correct port number)
4. Run `pnpm serve`, this will start a local hot-reloading server on 4. Run `pnpm serve`, this will start a local hot-reloading server on
`localhost:8080`. **DO NOT** reverse-proxy this server. It serves files that `localhost:8080`. **DO NOT** reverse-proxy this server. It serves files that
are not optimized nor minified. are not optimized nor minified.
5. Go to `localhost:8080` in your web browser of choice. 5. Go to `localhost:8080` in your web browser of choice.
---
# Configuration:
Configuring the site is pretty simple, the most complicated part is already
done because you have a functional web server.
In order to edit any of the following settings, go to `src/store/index.js` and
find the respective value in the section that allows editing. **Important**:
Any values edited in this file will require re-building the site using
`pnpm build`, and the changes will only take place after players refresh their
web browser.
| Variable | Type | Description
| -------- | ---- | -----------
| survey_link | string | This is the link to the survey that will appear in the player's hand once the object has been correctly guessed and in the attributions modal. This can be left empty or `null` without any problems, the buttons will be hidden.
| name* | string | The name of the team.
| icon* | string | The filename of the icon used for the team reminder for the team. This assumes the file is in the `public/assets/` directory.
| eyes* | other | This is an object of numbers used to indicate how many eyes appear on that slot of the game board for the team.
| writer_name | string | How the interface should refer to the players who are receiving cards and writing.
| writer_card_button | string | The text that appears on the cards that are given to the writer by the guessers.
| writer_object_choose_button | string | The text that appears on the object choices for the writers to select one for them to use before being allowed to start giving clues to the guessers.
| guesser_name | string | How the interface should refer to the players who are sending the cards and guessing what the object is.
| guesser_card_button | string | The text that appears on the button for the cards in the guesser's hand in order to give the card to the writer.
| eye_icon | string | The filename of the eye icon. This assumes the file is in the `public/assets/` directory.
| discard_hand_icon | string | The filename of the icon used on the guesser's discard hand button. This assumes the file is in the `public/assets/` directory.
\* _Note_: These exist for teams 1 and 2, they can each have their own values (and it is recommended that they don't have the same values).