ChoiceScript Saving Plugin (Update: April 2023)

TSSL · May 18, 2021, 9:16pm

So, I accidentally saved a game while in the stats screen, which seems to break the save Would there be any way to update around this bug? It’s just completely stuck on stats with no way to return to the game

ParrotWatcher · May 18, 2021, 9:18pm

I know that this has been the case for pretty much as long as the plugin’s been around. That said, if it can’t be fixed, would it be possible to disable the plugin on the stats screen?

mdhoneylamb1 · June 26, 2021, 7:41pm

OK, so to set up a demo on DashingDon, do I need to download and include smPlugin.js and smPluginAddOn.js. or just include the code for saving in my setup and scene files? The way the game creation screen on DashingDon is written is looks like I don’t have to include the .js files myself? I’m trying to sort this out now, instead of having to go back and do a ton of work later

*Edited for 1D10T style typos! I think I need more coffee!!

Lessa

Janus_Prospero · June 26, 2021, 7:53pm

You just need to include the save command (*sm_init name | number) right at the bottom of startup, then check the save feature on Dashingdon.com

Name: title of project

Number: amount of save slots - 1 to 5

mdhoneylamb1 · June 26, 2021, 7:56pm

Just to make sure I’m understanding, as long as I include the save command in startup, then DashingDon will take care of anything else necessary? Or I have to add save prompts in the scenes as well? Sorry for the dingaling questions, sleep isn’t my best friend at the moment so I’m working through perpetual brain fog

Lessa

Janus_Prospero · June 26, 2021, 8:12pm

You will just have to keep it in startup, nowhere else. The site, Dashingdon.com, requires you to manually check the option. If you do both correctly, then you will have successfully enabled the save feature.

mdhoneylamb1 · June 26, 2021, 8:37pm

Thank you so much @Janus_Prospero ! You have made my day! Also, huge thanks to @CJW . Just creating this and making it available for use elevates you to incredible human status Not to mention all the help you give every day. One in a billion rock star!

Lessa

CJW · April 1, 2023, 7:13pm

Bug Fix Release

Hi folks, AbrahamAriel · GitHub (afraid I don’t know their forum handle, if they’re on here) pointed out that a recent change to the menu buttons in ChoiceScript broke ChoiceScriptSavePlugin.

They even kindly submitted a fix, which I’ve incorporated and released:

gist.github.com

https://gist.github.com/CareyJWilliams/b11b15f8636475023d78a7d9a16dea92

ChoiceScriptSavePlugin.js

Scene.prototype.sm_save=function(line){var stack=this.tokenizeExpr(line);if(stack.length>2)throw new Error("sm_save: Invalid number of arguments, expected 0, 1 (save name) or 2 (id).");ChoiceScriptSavePlugin._save((new Date).getTime(),stack.length==1?this.evaluateExpr(stack):null)};Scene.prototype.sm_load=function(line){var stack=this.tokenizeExpr(line);var variable=this.evaluateExpr(stack);this.finished=true;this.skipFooter=true;this.screenEmpty=true;ChoiceScriptSavePlugin._load(variable)};Scene.prototype.sm_delete=function(line){var stack=this.tokenizeExpr(line);if(stack.length!=1)throw new Error("sm_delete: Invalid number of arguments, expected 1.");ChoiceScriptSavePlugin._delete(this.evaluateExpr(stack))};Scene.prototype.sm_update=function(){if(typeof this.stats._sm_save_count==="undefined")this.stats._sm_save_count=0;ChoiceScriptSavePlugin._getSaveList(function(saveList){if(!saveList)return;ChoiceScriptSavePlugin._syncHelperVariables(saveList,function(){})})};Scene.prototype.sm_menu=function(data){data=data||"";data=data.toLowerCase();var selectEle=document.getElementById("quickSaveMenu");if(!selectEle)return;var active=false;if(data==="false"){active=false}else if(data==="true"){active=true}else if(!data){active=selectEle.style.display=="none"}else{throw new Error("*sm_menu: expected true, false (or nothing) as an argument!")}selectEle.style.display=active?"inline":"none";var btns=document.getElementsByClassName("savePluginBtn");for(var i=0;i<btns.length;i++){btns[i].style.display=active?"inline":"none"}};Scene.validCommands["sm_save"]=1;Scene.validCommands["sm_load"]=1;Scene.validCommands["sm_delete"]=1;Scene.validCommands["sm_update"]=1;Scene.validCommands["sm_menu"]=1;var ChoiceScriptSavePlugin={};ChoiceScriptSavePlugin._CSS="#quickSaveMenu {        margin: 5px;        width: 100px;    }";ChoiceScriptSavePlugin._save=function(saveId,saveName){restoreObject(initStore(),"state",null,function(baseSave){if(baseSave){baseSave.stats["_smSaveName"]=saveName||"";baseSave.stats["_smSaveDateId"]=saveId;ChoiceScriptSavePlugin._addToSaveList(saveId,function(success){if(!success)return;saveCookie(function(){},ChoiceScriptSavePlugin._formatSlotName(saveId),baseSave.stats,baseSave.temps,baseSave.lineNum,baseSave.indent,this.debugMode,this.nav);setTimeout(function(){var selectEle=document.getElementById("quickSaveMenu");if(selectEle){selectEle.innerHTML="";ChoiceScriptSavePlugin._populateSaveMenu(selectEle)}},3e3)})}else{}})};ChoiceScriptSavePlugin._formatSlotName=function(saveId){return window.storeName+"_SAVE_"+saveId};ChoiceScriptSavePlugin._load=function(saveId){clearScreen(loadAndRestoreGame.bind(stats.scene,ChoiceScriptSavePlugin._formatSlotName(saveId)))};ChoiceScriptSavePlugin._delete=function(saveId){ChoiceScriptSavePlugin._removeFromSaveList(saveId,function(success){if(!success)return;var select=document.getElementById("quickSaveMenu");if(select){var deletedOption=select.options[select.selectedIndex];if(deletedOption)deletedOption.parentElement.removeChild(deletedOption)}initStore().remove("state"+ChoiceScriptSavePlugin._formatSlotName(saveId),function(success,val){})})};ChoiceScriptSavePlugin._createQuickSaveMenu=function(){var p=document.getElementById("menuButton");if(!p){alert("Error: unable to attach quick save menu");return}p=p.parentElement;var head=document.getElementsByTagName("head")[0];var style=document.createElement("style");style.innerHTML=ChoiceScriptSavePlugin._CSS;head.appendChild(style);var selectEle=document.createElement("select");selectEle.setAttribute("id","quickSaveMenu");p.appendChild(selectEle);var buttonArr=[{innerHTML:"New Save",clickFunc:"ChoiceScriptSavePlugin.save();"},{innerHTML:"Load",clickFunc:"ChoiceScriptSavePlugin.load();"},{innerHTML:"Delete",clickFunc:"ChoiceScriptSavePlugin.delete();"}];for(var i=0;i<buttonArr.length;i++){var btn=document.createElement("button");btn.innerHTML=buttonArr[i].innerHTML;btn.setAttribute("class","spacedLink savePluginBtn");btn.setAttribute("onclick",buttonArr[i].clickFunc);p.appendChild(btn)}return selectEle};ChoiceScriptSavePlugin._populateSaveMenu=function(selectEle){ChoiceScriptSavePlugin._getSaveList(function(saveList){if(!saveList)return;saveList.forEach(function(saveId){ChoiceScriptSavePlugin._getSaveData(saveId,function(saveData){if(!saveData){return}var option=document.createElement("option");option.setAttribute("value",saveData.stats._smSaveDateId);if(!saveData){option.innerHTML="Failed to load save."}else{var slotDesc=saveData.stats.sceneName+".txt ("+simpleDateTimeFormat(new Date(parseInt(saveData.stats._smSaveDateId)))+")";if(saveData.stats._smSaveName){slotDesc=saveData.stats._smSaveName+" &mdash; "+slotDesc}option.innerHTML=slotDesc}selectEle.appendChild(option)})})})};ChoiceScriptSavePlugin._getSaveData=function(saveId,callback){restoreObject(initStore(),"state"+ChoiceScriptSavePlugin._formatSlotName(saveId),null,function(saveData){if(saveData){callback(saveData)}else{callback(null)}})};ChoiceScriptSavePlugin._removeFromSaveList=function(saveId,callback){ChoiceScriptSavePlugin._getSaveList(function(saveList){if(!saveList)return;var index=saveList.indexOf(saveId.toString());if(index>-1)saveList.splice(index,1);initStore().set("save_list",saveList.join(" "),function(success,val){ChoiceScriptSavePlugin._syncHelperVariables(saveList,function(){callback(success)})})})};ChoiceScriptSavePlugin._addToSaveList=function(saveId,callback){ChoiceScriptSavePlugin._getSaveList(function(saveList){if(!saveList)return;saveList.push(saveId.toString());initStore().set("save_list",saveList.join(" "),function(success,val){ChoiceScriptSavePlugin._syncHelperVariables(saveList,function(){callback(success)})})})};ChoiceScriptSavePlugin._syncHelperVariables=function(saveList,callback){self.stats._sm_save_count=saveList.length;saveList.forEach(function(save,index){ChoiceScriptSavePlugin._getSaveData(save,function(saveData){if(saveData){self.stats["_sm_save_id_"+index]=save;self.stats["_sm_save_name_"+index]=saveData.stats._smSaveName||"";self.stats["_sm_save_date_"+index]=simpleDateTimeFormat(new Date(parseInt(save)))}})});callback()};ChoiceScriptSavePlugin._getSaveList=function(callback){initStore().get("save_list",function(success,val){if(!success)callback(null);if(!val)callback([]);else callback(saveList=val.split(" ").sort(function(a,b){return b-a}))})};ChoiceScriptSavePlugin._init=function(){if("file:"===window.location.protocol&&(typeof window.uploadedFiles==="undefined"&&typeof allScenes==="undefined")){setTimeout(ChoiceScriptSavePlugin._init,3e3);return}if(!window.storeName){Scene.validCommands["sm_save"]=0;Scene.validCommands["sm_load"]=0;Scene.validCommands["sm_delete"]=0;Scene.validCommands["sm_menu"]=0;Scene.validCommands["sm_menu"]=0;return alertify.error("Disabling ChoiceScript Save Plugin as there is no storeName detected. Please check your index.html.")}ChoiceScriptSavePlugin._populateSaveMenu(ChoiceScriptSavePlugin._createQuickSaveMenu())};ChoiceScriptSavePlugin.save=function(){if(stats.sceneName=="choicescript_stats"){alert("Error: Unable to save at this point.");return}var date=new Date;var message="What would you like to call this save?<br>Leaving this blank will result in a scene and date identifier.";alertify.prompt(message,function(e,saveName){if(e){ChoiceScriptSavePlugin._save(date.getTime(),saveName)}else{}},"Quick Save")};ChoiceScriptSavePlugin.delete=function(){var select=document.getElementById("quickSaveMenu");if(select.value<=0)return;var message="Delete save '"+select.options[select.selectedIndex].text+"'?<br>This cannot be undone!";alertify.confirm(message,function(result){if(!result){return}else{ChoiceScriptSavePlugin._delete(parseInt(select.value))}})};ChoiceScriptSavePlugin.load=function(){var select=document.getElementById("quickSaveMenu");if(select.value<=0)return;alertify.confirm("Are you sure you wish to load this save?<br>Current progress will be lost!",function(result){if(!result){return}else{ChoiceScriptSavePlugin._load(select.value)}})};setTimeout(ChoiceScriptSavePlugin._init,3e3);

You’ll need to replace your current ChoiceScriptSavePlugin.js file with the contents at the link above in order to use it with the latest version of ChoiceScript.

@dashingdon FYI.

Eiwynn · April 1, 2023, 7:22pm

Do authors need to change anything in their startup or will the same command we have been using still enable it when uploading to ink or dashingdon’s?

CJW · April 1, 2023, 7:22pm

No code changes required, the script just won’t inject itself properly without the update.

Eiwynn · April 1, 2023, 7:24pm

Okay, so the update is something I, with my WiP demo, do not really need to fuss with?

CJW · April 1, 2023, 7:25pm

If you’re relying solely on dashingdon to host your game and provide the save plugin, then you have nothing to do indeed (that’s on Dash).

CJW · May 13, 2023, 12:23pm

Yes, saves don’t play nicely with modifications underfoot. It’s stored in your browser’s local storage, rather than a file. You can clear local storage items manually, but it’s a little fiddly. You’ll want to read around the topic.

Daleko · September 4, 2023, 7:06pm

Hey Carey, I just wanted to let you know that I have the same problem reported by other people, whereby the game doesn’t load mid-scene, but only at the start of it (I didn’t even think it was supposed to load mid-scene until now!)

Is it something you eventually figured out the cause of? I use Dashingdon, so I don’t understand what else I could do other than use the sm_init command.

In case you want to take a look for yourself, the game can be reached at this link: After Dark

Thank you in advance for your attention, and for your hard work over the past ten years!

CJW · September 5, 2023, 12:12am

Check this response to a slightly different issue. The reasoning is the same. If people save a game and you then update it, saves are very likely to break. There really isn’t a great deal we can do about this, aside from perhaps detecting when a save is out-of-date and warning people.

I had a quick flick through your game and saving worked fine for me as it is right now.

Daleko · September 5, 2023, 7:30am

Thank you for the very quick reply! I’ll link your answer in the game’s thread then.

MoonlightBomber · September 6, 2023, 2:01am

I’ve tried the latest version of the plugin, and no save slots appeared on top of the screen. I’ve followed every instruction to the letter, but I can’t seem to get the quick save function working. Did I miss something?

cultivator-anon · January 7, 2024, 8:27pm

Does this work with the newest version of ChoiceScript?

CJW · January 8, 2024, 3:20pm

If you mean with regards to checkpoints, I’m honestly not sure. I don’t have the free time to check myself at the moment, but please feel free to try it and report back. I would imagine some tweaks may be needed.

I’m sorry I can’t be of more direct help at the moment.

adrao · February 3, 2024, 9:49am

Ah, I just saw this thread… did anybody try to use the checkpoints? Do they work with CSIDE?

Topic		Replies	Views
Is it possible to add a "game progress saving" feature for my ChoiceScript game? If so, how? ChoiceScript Help	3	2061	September 27, 2016
Help with Save System ChoiceScript Help	7	2566	July 2, 2014
Saving "on the fly" with smPlugin, can it be done? ChoiceScript Help	4	2116	July 19, 2015
[Resolved] How to do things like setting save points, making sure the game stays on the same part when you refresh a page? ChoiceScript Help	2	1589	January 11, 2016
How to save/bookmark in ChoiceScript? ChoiceScript Help	4	1064	October 21, 2013

ChoiceScript Saving Plugin (Update: April 2023)

Bug Fix Release

Related topics