sspenst / thinky.gg Goto Github PK

A platform dedicated to high-quality puzzle games

License: GNU General Public License v3.0

JavaScript 0.15% CSS 1.11% TypeScript 97.93% Dockerfile 0.06% Shell 0.01% Java 0.36% Objective-C 0.07% Objective-C++ 0.14% Swift 0.01% Ruby 0.15% C 0.01% HTML 0.01%

thinky.gg's Introduction

Thinky.gg

A platform dedicated to high-quality puzzle games.

Dev Environment

Local install

Run npm install
Create a .env file in the root directory containing the following:

JWT_SECRET=anything
LOCAL=true
NEW_RELIC_APP_NAME=dummy
NEW_RELIC_LICENSE_KEY=dummy
REVALIDATE_SECRET=whatever

Run npm run dev to test changes locally

Containerized setup

Required: Docker installed and running locally.

Run bash startDevEnv.sh in the root directory

Tests

Run npm test to run jest tests

Contributing

Find an issue to work on
Fork the repo
Test your changes locally
Create a pull request

Tech Stack

thinky.gg's People

Contributors

Stargazers

Watchers

Forkers

cosmovibe timhalbert enfloo davidspencer6174 jeetee aecarp diziet

thinky.gg's Issues

History of least moves

Currently the Level data model stores some info about the least moves (number, time, user). Some problems with this approach:

There is data duplication when setting a new record (Stat is created and Level properties are updated)
- Could delete leastMoves, leastMovesTs, and leastMovesUserId from the Level model and replace it with a recordStat reference
- Need to manually create stats for legacy records
New records clear out the previous record data
- Could add an isRecord boolean to the Stat model
- How to keep track of one person setting multiple records?
  - Currently there is only one stat per user per level
  - If there is one stat for every attempt, need to always search through all attempts to find the best stat
  - Could create a separate stat for each record that is immutable (vs normal user stats which can be updated)

404 instead of 500 on invalid pages

Handle invalid routes gracefully instead of throwing an application error (/catalog/blah, /creator/invalid_id, etc.)

Sorting / filtering levels

filtering:

input box to filter by name
hide completed / in progress levels

sorting:

by name
by moves
by points

Level attempts

add 'attempts' property to Stat model
increment attempts every time the level is completed
add 'Your moves' and 'Your attempts' to level info modal

Don't allow a record to be set if you aren't logged in

Causes an error when fetching level.leastMovesUserId.name

Editor controls

need a way to pick a levelDataType (14 options)

could do 14 controls but this won't work well on mobile
maybe just a button that opens a modal for choosing the active block
maybe controls for each button but a separate modal for movables (would result in 6 controls; 9 movable options in a modal)

onClick on each square that will change to the selected data type

save button
test button (future)

Update Psychopath author notes

For example "Click on a GREEN SQUARE (which represents a level) to begin playing" is no longer accurate. Need to update the language to reflect the new site.

Player animations should be above controls

For example, the spin animation after winning on this level is underneath the controls.

Dev environment

Need a way to run locally without process.env.MONGODB_URI

mock API layer with pre-populated test data

Consistent input styling

for all inputs:

add margin
add label
use color variables for input background and text
border / rounded edges?

Pack.authorNote

Add an optional author note to the Pack model

Stats on profile

score of the user
logged in user's completion of the levels on the profile
total level count
hide levels/reviews if there are none

Test / set score for custom level

'Test' button to play the custom level
completing the level submits a stat
saving the level in the future deletes the stat

Publish levels

all publishing and unpublishing
- unpublish should delete stats and allow editing
- published can't be edited
make sure any world/level changes are updated on profiles and in the catalog with SWR

API polish on create pages

loading bar since the pages are never static
fix SWR error with undefined id

Display leastMoves data

require leastMovesTs and leastMovesUserId
display both in the level info modal

Don't allow a record to be set if you aren't logged in

Causes an error when fetching level.leastMovesUserId.name

Levels completed on profile are out of date

Use 'universe' and 'world' instead of 'creator' and 'pack'?

Many pack names / author notes reference worlds / universes. It might be worth changing creator / pack back to the old names to avoid any confusion.

Profile cleanup

grammar: 'You have completed 1 of Andrew's level'
add total levels for each creator in parentheses

Reset password

link from #8 will land you at a reset password page
- enter + reenter password
- logs you in after changing the password

Contribution instructions

Update the readme with:

how to build/test the repo locally
how to contribute to the codebase

Refresh JWT

You currently get logged out automatically after 1 week. Should instead refresh the JWT to keep you logged in if you are actively using the site. https://stackoverflow.com/questions/26739167/jwt-json-web-token-automatic-prolongation-of-expiration

Welcome message

Message on the home page with links to these tutorial packs:

Usernames and emails should not be case sensitive

Icons for selected block type

Show icons in the block type modal, also show the icon in the control so you know which is active

delete the erase button and just add it as an option in the modal

'Create' page

/create endpoint
ability to create worlds
worlds shouldn't show up in the catalog if they have 0 published levels

Markdown in author notes

Psychopath 2 allowed for some tags (bold, italic, font, etc.). Should these be supported? Would need to parse the tags correctly to avoid any XSS.

SWR usernames on static pages

Since usernames can be updated, need to refetch names to ensure they are up to date

Editor skeleton

Display the level that is being edited
/edit/:levelId

Remove 'hide controls' button?

Not sure if this option is worth keeping. Controls don't take up that much space...

Logo / favicon

The current favicon / discord logo is just an image of the 🅿️ emoji. Would be nice to come up with something more official

User creation date

add a 'ts' property to the User model
set timestamp when signing up
display account age on profile

Change password

add option to change password on account page
need to enter:
- previous password
- new password
- new password again

Some users have been created manually (for example, levels that have been brought over from Psychopath 2 have an associated user that created the level). Psychopath 2 players may want to have access to these accounts:

when signing up, if their email matches an existing manually-created user, show a modal:
- mention existing username
- send a password reset email for this user
  - use logic from #8 and #9 for this