first commit
This commit is contained in:
commit
f7797df039
209
README.md
Normal file
209
README.md
Normal file
@ -0,0 +1,209 @@
|
|||||||
|
# Application Name: Game Consent App
|
||||||
|
The Game Consent Mobile and Web Application by [W.A. Hawkes-Robinson aka Hawke Robinson](https://hawkerobinson.com).
|
||||||
|
|
||||||
|
# Description
|
||||||
|
The Game Consent App was created by W.A. Hawkes-Robinson (aka Hawke Robinson) as an electronic version of the consent tools used for decades by RPG Research's founder, W.A. Hawkes-Robinson (aka Hawke Robinson), especially for games with "risky" or "mature" content or working with kids or people with developmental diversities.
|
||||||
|
|
||||||
|
The website for updates, links to the opensource code, and more can be found at [gameconsent.com](https://gameconsent.com)
|
||||||
|
|
||||||
|
All versions of the Role-Playing Game Consent Mobile and Web App are open source (license specifics pending).
|
||||||
|
|
||||||
|
Created by W.A. Hawkes-Robinson.
|
||||||
|
|
||||||
|
Developed by 100% unpaid volunteers opensource developers at the 501(c)3 Non-profit RPG Research.
|
||||||
|
|
||||||
|
|
||||||
|
### BASIC
|
||||||
|
Cost: FREE
|
||||||
|
|
||||||
|
The basic version is freely available online and via mobile app stores with no ads.
|
||||||
|
|
||||||
|
The basic version includes:
|
||||||
|
* Mobile-app only functionality (web server feature only available in Pro version).
|
||||||
|
* Join an existing game "room" with a code given from a Game Master that created the code with either the Standard or Pro version.
|
||||||
|
* Complete an initial default template game consent checklist "traffic light" (3 gradients, green, yellow, and red) standard questions for each player profile and send that to the GM for that room when completed.
|
||||||
|
* Room/invite code automatically expires if not used for over 30 days.
|
||||||
|
|
||||||
|
|
||||||
|
### STANDARD
|
||||||
|
Cost: $5 (one time per license).
|
||||||
|
|
||||||
|
If the room was created with the Standard Version (by the GM):
|
||||||
|
* Support for BASIC version features, plus...
|
||||||
|
* Mobile-app only functionality (web server feature only available in Pro version).
|
||||||
|
* Support for 3-tier/color "traffic light" consent levels (green, yellow, red).
|
||||||
|
* Static default pre-game survey form.
|
||||||
|
* GM can host only one code/room at a time. So one regular gaming group room. Can either invite new players to use the same room at other times to run several groups, or can delete existing code/room and send a new one to form new room/group. For multiple rooms/codes, see Pro version.
|
||||||
|
* Forms and real-time "panic button" are not anonymous to GM (but are not seen by other players).
|
||||||
|
* Room/invite code automatically expires if not used for over 90 days.
|
||||||
|
|
||||||
|
|
||||||
|
### PROFESSIONAL
|
||||||
|
Cost: $5/month or $50/year ($10/yr discount over monthly). Proceeds donated to the 501(c)3 non-profit RPG Research.
|
||||||
|
|
||||||
|
If the room was created with the Pro Version (by the GM):
|
||||||
|
* Support for BASIC and STANDARD Version features, plus...
|
||||||
|
* Support for up to 1,000 parallel codes/rooms per year.
|
||||||
|
* In addition to mobile-only functionality, also web server based features available (additional monthly or discounted annual fees to enable)
|
||||||
|
* In addition to basic support for default 3-tier traffic light consent levels, additional support for creating customized any-tier custom levels of consent for the pre-game form.
|
||||||
|
* Support for creating customized any-tier real-time "Panic Button" feature alerts to the GM.
|
||||||
|
* Support for optional fully anonymous consent forms.
|
||||||
|
* Support for optional fully anonymous real-time panic button feature.
|
||||||
|
* Room/invite codes can be set to different customizable expiration dates.
|
||||||
|
* Room/invite codes only auto-expire if unused for over 1 year.
|
||||||
|
* Support for group and private chat, emojis, stickers, file transfers, and related features via RPGSN.net and Matrix Federated protocol.
|
||||||
|
* Support for unlimited number of allocated "Assistant GM" roles with different permissions customizable by the lead GM.
|
||||||
|
* Opensource web version can be edited to point to your own API and/or Matrix server(s) if you wish to self-host.
|
||||||
|
|
||||||
|
|
||||||
|
# Getting the App
|
||||||
|
|
||||||
|
[Game Consent]:(https://gameconsent.com)
|
||||||
|
|
||||||
|
Getting the app source code via Git:
|
||||||
|
|
||||||
|
* [RPG Research Git Repository Basic Version]:(https://git.dev2dev.net/RPGResearch/rpgconsent-basic.git)
|
||||||
|
|
||||||
|
* [RPG Research Git Repository Standard Version]:(https://git.dev2dev.net/RPGResearch/rpgconsent-standard.git)
|
||||||
|
|
||||||
|
* [RPG Research Git Repository Professional Version]:(https://git.dev2dev.net/RPGResearch/rpgconsent-pro.git)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Getting Access to the Public Web App Page
|
||||||
|
|
||||||
|
* [Game Consent Web App Login]:(https://web.gameconsent.com/login)
|
||||||
|
|
||||||
|
* [Public API webserver:]:(https://api1.gameconsent.com)
|
||||||
|
|
||||||
|
* [Matrix protocol chat and file exchange Synapse Home Server]:(https://rpgsn.net)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Details pending.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Usage
|
||||||
|
|
||||||
|
1. GM Creates Game Consent App BASIC, STANDARD OR PRO account via website or mobile app, accepting terms of service.
|
||||||
|
2. GM Creates Game Room and generates invite code number.
|
||||||
|
3. GM Sends invite code to prospective players.
|
||||||
|
4. Player with invite code from GM (via email link or manually received code), accepts terms of service, creates account with code and logs into website with code or downloads mobile app and logs in with mobile with code.
|
||||||
|
5. Player fills out profile.
|
||||||
|
6. Player accepts invite from GM to accept GM's terms of service for the game room and joins the game room.
|
||||||
|
7. Player fills out GM provided consent survey form.
|
||||||
|
8. GM Receives completed survey.
|
||||||
|
9. GM Approves Player joining room session(s).
|
||||||
|
10. Start game session and use real time tools (if applicable) during game session(s).
|
||||||
|
11. For Pro versions utilize chat features before, during, and after sessions.
|
||||||
|
12. For Standard versions provide post-game session feedback surveys/scoring using templated basic participant default forms, or for Pro version custom feedback forms.
|
||||||
|
|
||||||
|
|
||||||
|
## BASIC Version Features
|
||||||
|
Join an existing game "room" with a code given from a Game Master that created the code with either the Standard or Pro version.
|
||||||
|
Complete an initial default template game consent checklist "traffic light" (3 gradients, green, yellow, and red) standard questions for each player profile and send that to the GM for that room
|
||||||
|
when completed.
|
||||||
|
Room/invite code automatically expires if not used for over 30 days.
|
||||||
|
|
||||||
|
|
||||||
|
## STANDARD Version Features
|
||||||
|
|
||||||
|
The standard version costs $5 (one time per license). Proceeds are donated to the 501(c)3 non-profit RPG Research.
|
||||||
|
|
||||||
|
The Standard Version includes:
|
||||||
|
All of the features of the basic version plus:
|
||||||
|
Real-time "panic" button for 3-tier traffic light instant notification to GM's room app notification (green-yellow-red)
|
||||||
|
|
||||||
|
If the room was created with the Standard Version (by the GM):
|
||||||
|
|
||||||
|
* Mobile-app only functionality (web server feature only available in Pro version).
|
||||||
|
* Support for 3-tier/color "traffic light" consent levels (green, yellow, red).
|
||||||
|
* Static default pre-game survey form.
|
||||||
|
* GM can host only one code/room at a time. So one regular gaming group room. Can either invite new players to use the same room at other times to run several groups, or can delete existing code/
|
||||||
|
room and send a new one to form new room/group. For multiple rooms/codes, see Pro version.
|
||||||
|
* Forms and real-time "panic button" are not anonymous to GM (but are not seen by other players).
|
||||||
|
* Room/invite code automatically expires if not used for over 90 days.
|
||||||
|
|
||||||
|
## PRO Version Features
|
||||||
|
If the room was created with the Pro Version (by the GM):
|
||||||
|
* Support for Basic and Standard Version features, plus:
|
||||||
|
* Support for up to 1,000 parallel codes/rooms per year.
|
||||||
|
* In addition to mobile-only functionality, also web server based features available (additional monthly or discounted annual fees to enable)
|
||||||
|
* In addition to basic support for default 3-tier traffic light consent levels, additional support for creating customized any-tier custom levels of consent for the pre-game form.
|
||||||
|
* Support for creating customized any-tier real-time "Panic Button" feature alerts to the GM.
|
||||||
|
* Support for optional fully anonymous consent forms.
|
||||||
|
* Support for optional fully anonymous real-time panic button feature.
|
||||||
|
* Room/invite codes can be set to different customizable expiration dates.
|
||||||
|
* Room/invite codes only auto-expire if unused for over 1 year.
|
||||||
|
* Support for group and private chat, emojis, stickers, file transfers, and related features via RPGSN.net and Matrix Federated protocol.
|
||||||
|
* Support for unlimited number of allocated "Assistant GM" roles with different permissions customizable by the lead GM.
|
||||||
|
* Opensource web version can be edited to point to your own API and/or Matrix server(s) if you wish to self-host.
|
||||||
|
|
||||||
|
|
||||||
|
# Setting API Your Own API Server
|
||||||
|
|
||||||
|
Details pending.
|
||||||
|
|
||||||
|
|
||||||
|
# Support
|
||||||
|
|
||||||
|
Details pending.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Roadmap
|
||||||
|
|
||||||
|
|
||||||
|
## BASIC
|
||||||
|
|
||||||
|
Develop BASIC:
|
||||||
|
API and Web Server (Java and Python)
|
||||||
|
Mobile and Web Front-end (Flutter?)
|
||||||
|
|
||||||
|
## STANDARD
|
||||||
|
|
||||||
|
Develop STANDARD:
|
||||||
|
API and Web Server (Java and Python)
|
||||||
|
Mobile and Web Front-end (Flutter?)
|
||||||
|
Matrix API basic Connection, authentication, and limited chat.
|
||||||
|
|
||||||
|
## PROFESSIONAL
|
||||||
|
|
||||||
|
Develop PROFESSIONAL:
|
||||||
|
API and Web Server (Javba and Python)
|
||||||
|
Mobile and Web Front-end (Flutter?)
|
||||||
|
Matrix API full connection features: authentication, chat, images, emojis, stickers, videos, file exchange, etc.
|
||||||
|
|
||||||
|
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
Details pending.
|
||||||
|
|
||||||
|
|
||||||
|
# License
|
||||||
|
This will be released to the public under an flexible open source license that requires full attribution but allows flexible use.
|
||||||
|
|
||||||
|
The Specific Opensource license pending, until then, this is copyright (c)2004, (c)2022, (c)2023 W.A. Hawkes-Robinson, thanks to additional help by RPG Research volunteers.
|
||||||
|
|
||||||
|
|
||||||
|
## Authors and acknowledgment
|
||||||
|
|
||||||
|
Created by W.A. Hawkes-Robinson (aka Hawke Robinson).
|
||||||
|
|
||||||
|
|
||||||
|
# Project Status
|
||||||
|
|
||||||
|
Currently in design, scoping, documentation, and early setup phase.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Loading…
Reference in New Issue
Block a user