diff --git a/DESIGN.md b/DESIGN.md new file mode 100644 index 0000000..d4ea375 --- /dev/null +++ b/DESIGN.md @@ -0,0 +1,16 @@ +# Overall Design + +## User Journey +On first login, the user will be informed that the website is intended for +adults and the dangers of starvation play. Once they have gone through the +acknowledgment, they will be shown the "logged out" mode for game, where there +is no cooldown for asking for meals. This is intended to be a testing +environment both for development as well as for users to understand how the game +works. + +## User safety considerations +To prevent refeeding syndrome, the game will not allow users to set the maximum +fast duration over 3 days, and will be significantly more likely to allow food +after 1 day. This makes sure that refeeding syndrome risks are minimized ([This +article](https://www.verywellhealth.com/refeeding-syndrome-8720457) indicates +that 5 days in when risks start to become noticeable). diff --git a/PAGES.md b/PAGES.md new file mode 100644 index 0000000..ffd1314 --- /dev/null +++ b/PAGES.md @@ -0,0 +1,26 @@ +# Page Structure + +## `/` +Main page, will show the testing version for logged out users and the normal +version for logged in users. Alias for `/test` for logged out users and `/play` +for logged in ones. + +## `/about` +A description of the game, safety considerations, and a link to the repository. + +## `/user` +Configuration page for the user. This is where custom meals, as well as setting +the max fast duration (up to 3 days, defaulting to 1 day) can be set. Will +redirect to the login page for logged out users. + +## `/test` +Testing area for the game. Will be the equivalent to what logged out users will +see, and will be a hidden url for logged in users. + +## `/play` +Hosts the main game. For logged in users, this is the same as `/`. For logged +out users, this will redirect to the login page. + +## `/login` +Basic login page. Allows for logged out users to log in, and will ask a logged +in user if they would like to switch accounts (log out).