Nocigar commited on
Commit
ce079f7
1 Parent(s): 3003803

Upload README.md

Browse files
Files changed (1) hide show
  1. default/scaffold/README.md +26 -0
default/scaffold/README.md ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Content Scaffolding
2
+
3
+ Content files in this folder will be copied for all users (old and new) on the server startup.
4
+
5
+ 1. You **must** create an `index.json` file in `/default/scaffold` for it to work. The syntax is the same as for default content.
6
+ 2. All file paths should be relative to `/default/scaffold`, the use of subdirectories is allowed.
7
+ 3. Scaffolded files are copied first, so they override any of the default files (presets/settings/etc.) that have the same file name.
8
+
9
+ ## Example
10
+
11
+ ```json
12
+ [
13
+ {
14
+ "filename": "themes/Midnight.json",
15
+ "type": "theme"
16
+ },
17
+ {
18
+ "filename": "backgrounds/city.png",
19
+ "type": "background"
20
+ },
21
+ {
22
+ "filename": "characters/Charlie.png",
23
+ "type": "character"
24
+ }
25
+ ]
26
+ ```