Skip to content

Commit 91f3530

Browse files
committed
Update README.
1 parent 4e11094 commit 91f3530

File tree

1 file changed

+83
-0
lines changed

1 file changed

+83
-0
lines changed

README.md

+83
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# skript-variable-dump
22

3+
[![](https://jitpack.io/v/goingoffskript/skript-variable-dump.svg)](https://jitpack.io/#goingoffskript/skript-variable-dump "Get maven artifacts on JitPack")
34
[![](https://img.shields.io/badge/License-MIT-blue)](./LICENSE "Project license: MIT")
45
[![](https://img.shields.io/badge/Java-8-orange)](# "This project targets Java 8")
6+
[![](https://img.shields.io/badge/View-Javadocs-%234D7A97)](https://javadoc.jitpack.io/com/github/goingoffskript/skript-variable-dump/latest/javadoc/ "View javadocs")
57

68
Dump [Skript](https://github.com/SkriptLang/Skript/) variables to YAML.
79

@@ -14,3 +16,84 @@ All loaded variables will be dumped into a YAML file generated at:
1416
`/plugins/Skript/dumps/`
1517

1618
That's all.
19+
20+
## Example
21+
22+
📜 ➡️ 📑
23+
24+
- Variables: `/plugins/Skript/variables.csv`
25+
26+
```csv
27+
# === Skript's variable storage ===
28+
# Please do not modify this file manually!
29+
#
30+
# version: 2.5.3
31+
32+
numbers::1, string, 80036F6E65
33+
numbers::2, string, 800374776F
34+
numbers::3, string, 80057468726565
35+
numbers::4, long, 0000000000000004
36+
numbers::5, long, 0000000000000005
37+
numbers::6, long, 0000000000000006
38+
numbers::7, double, 401E000000000000
39+
numbers::8, double, 4020666666666666
40+
numbers::9, double, 4022333333333333
41+
wait, timespan, 81066D696C6C6973040000000000000BB8
42+
```
43+
44+
- Run: **/skript-variable-dump**
45+
- Generates: `/plugins/Skript/dumps/skript-variables-dump.2021-05-12_1.yml`
46+
47+
```yaml
48+
# Skript Variable Dump: 2021-05-12T16:53:30.636775
49+
# Skript Version: 2.5.3
50+
51+
numbers:
52+
'1': one
53+
'2': two
54+
'3': three
55+
'4': 4
56+
'5': 5
57+
'6': 6
58+
'7': 7.5
59+
'8': 8.2
60+
'9': 9.1
61+
wait:
62+
==: Timespan
63+
milliseconds: 3000
64+
```
65+
66+
## Addons
67+
68+
Addons can register adapters for their data types with:
69+
70+
```java
71+
import com.github.goingoffskript.skriptvariabledump.SkriptToYaml;
72+
73+
SkriptToYaml.adapts(ExampleType.class, (example, map) -> {
74+
map.put("thing", example.thing());
75+
map.put("amount", example.amount());
76+
});
77+
```
78+
79+
### Dependency
80+
81+
Get it from JitPack: https://jitpack.io/#goingoffskript/skript-variable-dump
82+
83+
```xml
84+
<repositories>
85+
<repository>
86+
<id>jitpack.io</id>
87+
<url>https://jitpack.io</url>
88+
</repository>
89+
</repositories>
90+
91+
<dependencies>
92+
<dependency>
93+
<groupId>com.github.goingoffskript</groupId>
94+
<artifactId>skript-variable-dump</artifactId>
95+
<version><!-- Released Version --></version>
96+
<scope>provided</scope>
97+
</dependency>
98+
</dependencies>
99+
```

0 commit comments

Comments
 (0)