Skip to content

Commit

Permalink
Finished README.me
Browse files Browse the repository at this point in the history
  • Loading branch information
NeroNekro committed Dec 21, 2023
1 parent 16dace0 commit c061ba7
Showing 1 changed file with 40 additions and 4 deletions.
44 changes: 40 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# File Class
# 2090s Storage System

## Overview
The File class is a storage utility for handling file operations with optional encryption in Godot Engine. It allows for the creation, reading, writing, updating, and deletion of file contents, with an emphasis on handling JSON-formatted data.
Expand All @@ -13,9 +13,45 @@ The File class is a storage utility for handling file operations with optional e

### Initialization
```gdscript
var file = GStorage.File.new(path, open_file, secretkey="")
var file = GStorage.File.new(file_path, open_file, secretkey="")
```

- **path**: The path where the file is located or will be created.
- **file_path**: The path where the file is located or will be created.
- **open_file**: The name of the file to open or create.
- **secretkey**: The encryption key for securing the file. If left empty, no encryption will be set.
- **secretkey**: The encryption key for securing the file. If empty, no encryption will be set.


### Methods
Sets the data in the file dictionary and writes it to the file. Didnt overwrite the whole dictionary. Existing values are overwritten and new values are added

```gdscript
var file = GStorage.File.set_data(dict)
```

- **dict**: i.e. {"device_id": 1, ...}
- **return**: null


If you want to change a single value without passing a dictionary:
```gdscript
var file = GStorage.File.set_key(key, value)
```

- **key**: i.e. "device_id"
- **value**: i.e. 1
- **return**: value

If you want to have all data as a dictionary:
```gdscript
var file = GStorage.File.get_all_data()
```

- **return**: dictionary


If you want to delete a key:
```gdscript
var file = GStorage.File.delete_data()
```

- **return**: null

0 comments on commit c061ba7

Please sign in to comment.