https://github.com/2401lucas/Save-System
A Simple C# Save and Load System that has the ability to track achievements, load data from several files and modify data without needing to modify the whole Object. Usable in C# & Unity
https://github.com/2401lucas/Save-System
persistance save-system unity
Last synced: about 1 year ago
JSON representation
A Simple C# Save and Load System that has the ability to track achievements, load data from several files and modify data without needing to modify the whole Object. Usable in C# & Unity
- Host: GitHub
- URL: https://github.com/2401lucas/Save-System
- Owner: 2401lucas
- Created: 2021-05-13T20:22:47.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-12-14T22:35:56.000Z (over 4 years ago)
- Last Synced: 2024-08-03T05:14:36.544Z (almost 2 years ago)
- Topics: persistance, save-system, unity
- Language: C#
- Homepage:
- Size: 20.5 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Simple C# Save and Load System
A simple C# Saving and Loading System, following the SOLID principles. [Read more about the SOLID principles here](https://en.wikipedia.org/wiki/SOLID)
## It is compatable with both Unity and C# projects.
## Template Script
SaveTemplate is the default script for the Save System
# The Setup
Create a script, inherit from SaveTemplate.cs and implement the abstract methods. There are 3 methods that need to be implemented for the save system to be functional.
### File Path
The File Path is used in the saving and loading of fIles.
Update the File Path to ```public override string filePath => "playerSave";```
### Gettting the Data
The GetData method returns all of the variation, or data, in a string array to be written to a file.
A const char, named DataSplitter, is used as a split between the variables, so that it can easily be split once the data needs to be interpreted.
### Interpretting the Data
The InterpretData method recieves all of the data in a save file, and is responsible for splitting, parsing and assigning the data to its respective variables.
If the data is empty or null, we default to the default values.
If it is not empty or null, the data is split using the constant DataSplitter and then parsed using the methods on SaveTemplate.
### Default Variables
The default variables are assigned when the variables are declared.
# Example
PlayerSaveData.cs is an example of how to implement this. The save data can be created in a GameManager for instance, and once loaded can be accessed directly to modify the data.
## It's as simple as that!