diff options
| author | Bryson Steck <steck.bryson@gmail.com> | 2022-02-28 12:41:01 -0700 |
|---|---|---|
| committer | Bryson Steck <steck.bryson@gmail.com> | 2022-02-28 12:41:01 -0700 |
| commit | ed4ed2be4634278510ab4c41509c7fbc8d95e853 (patch) | |
| tree | ca0522ede745ce63ac076e0ebf9fa110fb06f490 | |
| parent | 83d0d5c28b3de547f14ae5629dce06e926ee5521 (diff) | |
| download | resurrection-ed4ed2be4634278510ab4c41509c7fbc8d95e853.tar resurrection-ed4ed2be4634278510ab4c41509c7fbc8d95e853.tar.gz resurrection-ed4ed2be4634278510ab4c41509c7fbc8d95e853.tar.bz2 | |
clarify .resurrection files in data dir
| -rw-r--r-- | data/README.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/data/README.md b/data/README.md index 912aa76..f13e301 100644 --- a/data/README.md +++ b/data/README.md @@ -2,9 +2,9 @@ The following applies to all files in this directory with the exception of `resu # Example Files -These files are crucial to Resurrection as they contain important timing data and resources for the plugin. +This directory contains sample files for you to visualize what files Resurrection writes to the file system and how they work. Resurrection creates these files in the same directory as the Spigot server `plugins` directory when the plugin is enabled for the first time or if the files do not exist. -This directory contains sample files for you to visualize what these files will/may contain. The plugin creates these files in the same directory as the Spigot server `plugins` directory. +**The files in this directory are purely for documentation purposes, they are not compiled into the final jars since Resurrection creates these files programmatically.** Avoid touching these files while the plugin is enabled and avoid deleting or moving the files at any time after it's creation to prevent breaking the plugin. |