Skip to content

Commit 933d89a

Browse files
committed
Update README.
1 parent 12a9c73 commit 933d89a

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,27 @@ All loaded variables will be dumped into a YAML file generated at:
1717

1818
That's all.
1919

20+
## Rationale
21+
22+
This tool exists so script authors who intend to rewrite their scripts
23+
as plugins have an easy way to export their variable data and import it
24+
however they see fit.
25+
26+
**Goals**
27+
28+
- Export Skript variables to platform-agnostic formats.
29+
- That way, data stored as variables is portable and accessible
30+
outside of Skript's opaque, effectively-proprietary storage format.
31+
- Use case: rewriting a script as a plugin and importing the
32+
script's legacy data.
33+
34+
**Non-goals**
35+
36+
- Importing previously dumped variables.
37+
- This tool is meant to be a one-way conversion to get Skript data
38+
elsewhere, and since the data itself *originates* in Skript, importing
39+
previous dumps is considered outside this project's scope.
40+
2041
## Example
2142

2243
📜 ➡️ 📑

0 commit comments

Comments
 (0)