Need help saving config with comments

So first I will just say this isn't a problem with copying in onEnable. I got that figured out.

What I am trying to do, is I am trying to create a section in the config.yml but keep my comments that are already there. Right now, I am using plugin.saveConfig(); but that overwrites my comments (except for the header comments).

Do I have to get the file via InputSteam, write to it and then put it back or whatever using OutputSteam?

Thanks.

 

If using the bukkit config API, it's not possible to retain the comments between nodes on saving the file.
If you modify the file via an OutputStream, you can control it yourself, I guess.
But it's not as easy to use as the Bukkit config API.

What I usually do in this case is to place all comments first in the file and then do the config part below it.
Because comments before the first config node should be kept. Even when saving the file.

 

Heres how you add a comment into the top of the file.

Code:java

    @Override
    public void onEnable() {
 
        FileConfiguration config = getConfig();
 
        config.options()
                .header("#====== DO NOT EDIT THIS FILE ======\r\n======= THIS FILE STORES USER DATA ========");
        config.options().copyHeader(true);
 
        config.options().copyDefaults(true);
        saveConfig();
}

 

Sorry I should have been more clear. I am trying to retain comments with a custom yml file. Not with the config.yml

 

aman207

Code:YAML

# retainable comment

Ensure there is at least one space between the '#' key and your text/characters that follow.

 

Wingzzz Yeah there is.

 

Well I'm not sure then. I use it and have no problems as well as others have had success when they've used that way of comments.

 

I figured out another way around.

Thanks anyways

 

Please post your solution.

 

Well instead of trying add a section to my .yml with the comments, I just decided to create a new file, and put the new sections in there. Which actually helps with organization as well.