Is using localStorage() allowed?

How can we help?

CZS

January 22, 2022 16:30
Edited

I'm making a computer game in PJS and I would like to be able to use `localStorage()` to save the game state to the browser so that the user doesn't have to keep a save code somewhere. However, I've heard varying reports as to whether using `localStorage()` is allowed; the KA guidelines seem to forbid it universally, but I've heard programmers saying that this has changed and that it has been allowed again in certain instances. Is using this functionality an option?

If it makes any difference, the key I'm using is one which is very unlikely to be used by anyone else ("CZS_ArthorSaveCode"), and the user has to enable the use of `localStorage()` in the settings page before the program accesses it; the settings page also has a button allowing them to erase any data previously stored. The only data I'm storing is a single string of around 70 characters. I already wrote and tested all the code for this, but once I was finished I commented out everything that used `localStorage()`.

The link to the program is here: https://www.khanacademy.org/computer-programming/jungle-game-unfinished/4687028301086720

Thanks!

New post

6 comments

Kestron

January 24, 2022 22:42
1

Comment actions Permalink
I am not official and have no clue, but it looks like no one else is replying either.

To the best of my knowledge, localStorage is only ever allowed in an HTML environment. Please note that I am not a Guardian and this all hearsay.
CZS

January 25, 2022 18:03
0

Comment actions Permalink
Thanks, Kestron! If none of the guardians respond I'll assume that that's the case.
VEXCESS #BringBackBackgrounds

January 29, 2022 03:20
0

Comment actions Permalink
My understanding is that local storage is allowed in HTML programs so long as you use it reasonably and don't store more than a small piece of data.

But I think that using local storage in a PJS is probably not allowed.

If you want to use PJS but in an HTML project I may suggest using this
https://www.khanacademy.org/computer-programming/easy-pjs-in-html/5852298286678016
CZS

January 29, 2022 21:10
0

Comment actions Permalink
OK, thank you very much, Vexcess. I think I'll just live with a PJS program and copy/pasting a save string for now, but I appreciate the offer!
Evan Lewis

March 09, 2022 01:57
2

Comment actions Permalink
Hi everyone!

Vexcess' answer is pretty much spot-on, but I wanted to provide an official response and some additional clarification here.

Using localStorage in the webpage projects is allowed as long as you adhere to the following:
1. Use as little data storage as you can---all KA projects are hosted on the same domain, so the limited space provided by localStorage has to be shared across all KA projects.
2. Use storage keys that are specific to your project, such as AuthorName_ProjectName_KeyName. Since storage is shared across projects, you shouldn't use general key names or intentionally overwrite the data saved by someone else's project.
Allowing users to opt into using localStorage to save their progress would be a great feature to include in your project, but this isn't something that's required.

Hopefully that helps clarify!
CZS

March 09, 2022 16:55
0

Comment actions Permalink
Thank you very much, that is helpful.

Please sign in to leave a comment.

Is using localStorage() allowed?

Didn't find what you were looking for?

6 comments

Didn't find what you were looking for?