Custom Config File Where I Can Store Locations

Hey guys, so I got a few quick questions,

1. How can I create a new custom config file? Ex. created a new config file named "Location.yml" that will be located in the plugin folder of that certain plugin.

2. How can I store locations into that file?

3. How can I retrieve a location from the file and then teleport the player to the location I retrieved?

Thanks!

 

I won't help you with customConfig because i'm lazy.

2- Configuration is stored as Strings normally, its easier. So, in order to transform a Location to a String, normally i use the format: world_name;x;y;z or world_name;x;y;z;yaw;pitch

Code:java

String locationString = location.getWorld().getName()+";"+location.getX()+";"+location.getY()+";"+location.getZ() // put here aditional pitch and yaw if you want to save eye location
 
//OBS: pitch and yaw are floats

Save a double (location.getX() is a double, can be like 243.324124314134) require a lot of space.. Normally I use something to make it a 2 digit number after coma ("243.31")

3- Make the reverse.

Code:java

String[] loc = LocationString.split(";");
if(loc.lenght < 5) {
Location location = new Location(Bukkit.getWorld(loc[0]), Double.parseDouble(loc[1]), Double.parseDouble(loc[2]), Double.parseDouble(loc[3]));
} else {
Location location = new Location(Bukkit.getWorld(loc[0]), Double.parseDouble(loc[1]), Double.parseDouble(loc[2]), Double.parseDouble(loc[3]), Float.parseFloat(loc[4]), Float.parseFloat(loc[5]));
}

 

rfsantos1996 Alright I'll try that thanks, can anyone help me with the multiple configs?

 

Niknea make a Google Search on custom config and go to the bukkit wiki. There you Will find help to make your own custom config.
Now for saving/loading you Will need to convert the location to a string.
Like this for saving:
for (Entry<String, Location> map: hashmap.entrySet())
{
Location loc = map.getValue();
String saveLoc = loc.getWorld().getName()+":"+loc.getX()+":"+loc.getY()+":"+loc.getZ();
customConfig.set(map.getKey(), saveLoc)
}

And for loading:
for (String locs : customConfig.getKeys(true))
{
String[] parts = customConfig.getValue().split(":");
If(parts.length == 4)
{
World w = Bukkit.getServer().getWorld(parts[0]);
double x = Double.parseDouble(parts[1]);
double y = Double.parseDouble(parts[2]);
double z = Double.parseDouble(parts[3]);
Location loc = new Location(w, x, y, z);

hashmap.put(locs, loc);
}
}

This code is untested!!!

EDIT: Too slow

 

Here are some snippets to help with loading/saving custom configs:

Code:java

// Loading the config
File configFile = new File(getDataFolder(), "foo.yml");
FileConfiguration config = YamlConfiguration.loadConfiguration(configFile);
 
// Saving the config
try {
  config.save(configFile);
} catch (IOException e) {
  // TODO: Handle the exception
}

 

Asgernohns coasterman10 Alright it worked! Here is my code

PHP:

  private FileConfiguration customConfig = null;
    private File customConfigFile = null;
    public void reloadCustomConfig(){
        if (customConfigFile == null) {
            customConfigFile = new File(getDataFolder(), "location.yml");
        }
        customConfig = YamlConfiguration.loadConfiguration(customConfigFile);
 
        // Look for defaults in the jar
        InputStream defConfigStream = this.getResource("location.yml");
        if (defConfigStream != null) {
            YamlConfiguration defConfig = YamlConfiguration.loadConfiguration(defConfigStream);
            customConfig.setDefaults(defConfig);
        }
    }
 
    public FileConfiguration getCustomConfig() {
        if (customConfig == null) {
            reloadCustomConfig();
        }
        return customConfig;
    }
    public void saveCustomConfig() {
        if (customConfig == null || customConfigFile == null) {
            return;
        }
        try {
            getCustomConfig().save(customConfigFile);
        } catch (IOException ex) {
            getLogger().log(Level.SEVERE, "Could not save config to " + customConfigFile, ex);
        }
    }
 
    @EventHandler
    public void onJoin123(PlayerJoinEvent e){
        if(getCustomConfig().get(e.getPlayer().getName()) == null){
            getCustomConfig().set(e.getPlayer().getName(), "");
            saveCustomConfig();
            e.getPlayer().sendMessage(ChatColor.GOLD + "Added to Database!");
        }
        else{
            e.getPlayer().sendMessage(ChatColor.GREEN + "Found in Database!");
        }
    }

Please keep in mind this wont be the real code, I know its messy .

Now I got a quick question, say I want to add stuff at the start of the config loading, ex. adding a "Location:" in the location.yml when the plugin starts, how do I add that? Would it be just like doing it to a config.yml? Would I have to do anything else? Thanks.

 

Niknea No it Will be the same, so Like: customConfig.set("hi", "Hello");
customConfig.getString("hi");

 

Niknea getConfig() returns a FileConfiguration, so a custom config works identically to getConfig() except you put customConfig instead of getConfig().

 

coasterman10 Asgernohns Not sure you understand what I'm saying, in the default config ( config.yml ) in your IDE you can add stuff that will be added to the config right when it loads, how can I do that with a custom file config? Would it be the same as the default config?

Seemed to run into a problem, on reload, the custon file resets, any ways to fix it? Thanks

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

Niknea Yes you can. Just make a new file called: location.yml

Niknea Did you save the file on shutdown?

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

Asgernohns I save it every time I edited something, CODE : http://pastie.org/9081185, pretty much when I reload the server, and do the /esetup command, it says "no overrides made", even though I set it before, but if I do it again without reloading, it will say a override was made. Any ideas?

 

Use a ConfigurationSerializable class for location loading with a lazy-initialized world:

Code:java

/*
* Copyright (C) 2014 CodeLanx , All Rights Reserved
*
* This work is licensed under a Creative Commons
* Attribution-NonCommercial-NoDerivs 3.0 Unported License.
*
* This program is protected software: You are free to distrubute your
* own use of this software under the terms of the Creative Commons BY-NC-ND
* license as published by Creative Commons in the year 2014 or as published
* by a later date. You may not provide the source files or provide a means
* of running the software outside of those licensed to use it.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* You should have received a copy of the Creative Commons BY-NC-ND license
* along with this program. If not, see <[url]https://creativecommons.org/licenses/>[/url].
*/
package com.codelanx.codelanxlib.serialize;
 
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
import org.bukkit.Bukkit;
import org.bukkit.World;
import org.bukkit.block.Block;
import org.bukkit.configuration.serialization.ConfigurationSerializable;
import org.bukkit.configuration.serialization.SerializableAs;
import org.bukkit.util.Vector;
 
/**
*
* @since 1.0.0
* @author 1Rogue
* @version 1.0.0
*/
@SerializableAs("Location")
public class SLocation implements ConfigurationSerializable {
 
    private final Vector loc;
    private final UUID uuid;
    private World world;
 
    public SLocation(Block block) {
        this.loc = block.getLocation().toVector();
        this.uuid = block.getWorld().getUID();
    }
 
    public SLocation(Map<String, Object> config) {
        this.loc = (Vector) config.get("location");
        this.uuid = UUID.fromString((String) config.get("world"));
    }
 
    @Override
    public Map<String, Object> serialize() {
        Map<String, Object> back = new HashMap<>();
        back.put("location", this.loc);
        back.put("world", this.uuid.toString());
        return back;
    }
 
    public SLocation valueOf(Map<String, Object> config) {
        return new SLocation(config);
    }
 
    public SLocation deserialize(Map<String, Object> config) {
        return new SLocation(config);
    }
 
    public World getWorld() {
        if (this.world == null) {
            this.world = Bukkit.getWorld(this.uuid);
        }
        return this.world;
    }
 
    public Vector getVector() {
        return this.loc;
    }
 
}

This becomes easier to manage:

Code:java

SLocation loc = (SLocation) config.get("path-to-slocation");
config.put("path-to-slocation", loc);
 
Location bloc = loc.getVector().toLocation(loc.getWorld());