Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rulholos/wyssaveutils

A savefile utility for Will You Snail? (WYS)
https://github.com/rulholos/wyssaveutils

Last synced: about 2 months ago
JSON representation

A savefile utility for Will You Snail? (WYS)

Awesome Lists containing this project

README 

        
# WYSSaveUtils



This Utility aims to create a stable environment for save and setting files of Will You Snail? to be used by other programs.  

Expect bugs for this version, sorry.



### Documentation



All of these classes's Content inherit from IEnumerable, making them able to be accessed with a foreach loop.  

e.g : `foreach (List key in keys.keyContent) { Console.WriteLine(key[0]); }`.



#### SaveLoader



Create a new instance of SaveLoader with `SaveLoader save = new SaveLoader(0);`  

There is two way to instanciate a SaveLoader object :  

- With an int, this would be the slot number, 0 to 2.  

- With an absolute path to the save file as a string object.



You can access the save values using `save.saveContent.somevalue`



To edit values, considering the SaveLoader object is named `save`,  

if you want to edit the game version, do : `save.saveContent.GameVersion = some_string`.  

And then `save.WriteChanges();` to make the changes appear in the save file.  

But be sure of what you're doing, after writing, there's no going back.



If you want to reload the contents of the savefile, just do `save.Reload();`



When you're finished with what you're doing, call `save.CloseLoader();`



You can get the string value identifiers with the `Fields` object, using the same access value as `saveContent`.  

e.g : `Fields.GameVersion` will return `"Game Version"`



You can change the loader mode from a slot format to a filepath format using `save.ChangeMode(slot or filepath);`.  

But be sure you don't call it before saving the changes you made in the old file, or these will be saved to the new file.



#### SetLoader



Create a new instance of SetLoader with `SetLoader set = new SetLoader();`  

There is two way to instanciate a SetLoader object :  

- With no argument, it just instanciate the setting file in %appdata%/Local/Will_You_Snail

- With an absolute path to the setting file as a string object.



You can access the setting values using `set.setContent.somevalue`



To edit values, considering the SetLoader object is named `set`,  

if you want to edit the Screenshake value, do : `set.setContent.Screenshake = some_float_value`.  

And then `set.WriteChanges();` to make the changes appear in the settings.  

These changes actually are updated at runtime when the game is launched.  

But be sure of what you're doing, after writing, you can't go back.



If you want to reload the contents of the savefile, just do `set.Reload();`. It's already called by `WriteChanges()` though.



When you're finished with what you're doing, call `set.CloseLoader();`



You can get the string value identifiers with the `SetFields` object, using the same access value as `setContent`.  

e.g : `SetFields.VSync` will return a bool.



You can change the loader mode from a filepath format from the appdata format using `set.ChangeMode();` or `set.ChangeMode(filepath);`.  

But be sure you don't call it before saving the changed you made, or these will not be saved.



#### KeyBinds



Create a new instance of KeyBinds with `KeyBinds keys = new KeyBinds();`  

To instanciate, it's the same way as the two other.



You can access the keybinds values using `keys.keyContent.somevalue`



To add a key, use (example) `keys.AddKey(nameof(keys.keyContent.ActionJump), KeyBindsContent.Key.C, KeyBindsContent.KeyType.KEYBOARD);`  

To remove a key, it's `keys.RemoveKey(nameof(keys.keyContent.ActionJump), KeyBindsContent.Key.C);`  

And then, `keys.WriteChanges();` to append everything to the Keybinds.sav file.



When you're finished, don't forget to clear the memory using `keys.CloseLoader();`.



You can get the string value identifiers with the `KeyBindsFields` object.  

And same with all the possible keys you can add : `KeyBindsContent.Key` which is an enum.  

Warning : This Utility does not **fully** supports gamepads, only keyboards.