Skip to content

Commit 696ff89

Browse files
authored
Update README.MD
1 parent 97772f9 commit 696ff89

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

README.MD

+21-14
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# ConfigAPI
2-
Config API for Bukkit 1.8 - 1.16 based on Dynamic Proxies
2+
Config API for Bukkit 1.8 - 1.16 based on dynamic proxies
33

44
## Features:
5-
- Create config via Interface with `default` getters and setters
6-
- Automatic generation of YAML files based on Java code
7-
- Automatic updates of YAML file after adding new field to config
8-
- Support of comments in YAML files
9-
- Support of multiple config files
5+
- Works with Bukkit 1.8 - 1.16
6+
- Compatible with Java 8 - 15
7+
- Multiple configuration files
8+
- Fastly create configs via Java interface with `default` getters
9+
- Automatic generation of config's YAML file
10+
- Automatic update of config's file after add new methods to it's interface
11+
- Support for setting new values to config
1012
- System of serializers for custom objects (e.g. ItemStack, Location)
11-
- Automatic translation of `&` based colors
13+
- Support of comments in YAML config
14+
- Automatic translation of `&` based colors
1215

1316
## Import
1417
#### Gradle
@@ -108,11 +111,9 @@ public interface TestConfig extends Config {
108111

109112
#### Automatic generated YAML from above Java code
110113
```yaml
111-
values:
112-
a: 1
113-
b: 2
114114
example_message: '&cIt''s default value of example message' # This comment will be saved to YAML file!
115115
spawn_points:
116+
structure: java.util.ArrayList
116117
type: org.bukkit.Location
117118
'0':
118119
world: world
@@ -135,14 +136,20 @@ spawn_points:
135136
z: 20.0
136137
yaw: 0.0
137138
pitch: 180.0
139+
values:
140+
structure: java.util.HashMap
141+
type: java.lang.Integer
142+
a: 1
143+
b: 2
138144
award:
139145
material: DIAMOND_SWORD
140146
amount: 1
141147
name: '&cAward'
142148
lore:
143-
- '&aFirst line'
144-
- '&cSecond line'
145-
149+
structure: java.util.ArrayList
150+
type: java.lang.String
151+
'0': '&aFirst line'
152+
'1': '&cSecond line'
146153
```
147154
148155
## Serializers
@@ -190,4 +197,4 @@ public class TestPlugin extends JavaPlugin {
190197
// Init your configs...
191198

192199
}
193-
}
200+
}

0 commit comments

Comments
 (0)