[1.7.10] How to include and reference text file?

[m27315]

Hi,

 

I'd like to include a plain text file in my forge mod.  I'm guessing it goes somewhere in the assets folder, but I do not know where to place it or how to find it once the mod is running.

 

Any pointers?

 

Thanks!

[m27315]

I'm a little out of my water, being new to Forge Mod development.  I'd like for each user to have their own config file, which if it doesn't exist, I want to copy it out of the mod and into the user's config file space.  It's a non-standard config file, so I can't use the easier read/write config file methods. ... Dumb question, where can I find more info on MyMod.class.getResourceAsStream in the forge javadocs?  What class does that belong to? ... Thanks!

[larsgerrits]

Class.class.getResourceAsStream

isn't related to Forge anyway. It's plain Java, so look up on that.

[m27315]

Awesome! ... Thanks!

[Draco18s]

Here's a class I use to unpack some custom COG files, which is based off how COG unpacks its config files (COG is also open source).

 

package com.draco18s.hardlib;

import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

import cpw.mods.fml.common.Loader;

public class CogConfig {
private static List<String> extraModules = new ArrayList<String>();

public static void addCogModule(String name) {
	extraModules.add(name);
}

public static void unpackConfigs() {
	File configPath = getConfigDir();
        	
        	File defaultModulesDir = new File(modulesDir, "custom"); //TODO change this if you don't need a sub-folder or want a different name
        	if (!defaultModulesDir.exists()) {
        		defaultModulesDir.mkdir();
        	}
        
        	for (String module : extraModules) {
        		File writeFile = new File(defaultModulesDir, module);
        		if(!writeFile.exists()) {
        			unpackConfigFile(module, writeFile);
        		}
        	}
}

private static boolean unpackConfigFile(String configName, File destination) {
    	String resourceName = "cog_config/" + configName; //TODO: change this to point to your resource location, which is inside "src/main/resources", eg. this currently points to "src/main/resources/cog_config"
        try {
    	    InputStream ex = HardLib.class.getClassLoader().getResourceAsStream(resourceName);
            BufferedOutputStream streamOut = new BufferedOutputStream(new FileOutputStream(destination));
            byte[] buffer = new byte[1024];
            boolean len = false;
            int len1;

            while ((len1 = ex.read(buffer)) >= 0)
            {
                streamOut.write(buffer, 0, len1);
            }

            ex.close();
            streamOut.close();
            return true;
        }
        catch (Exception var6) {
            throw new RuntimeException("Failed to unpack resource \'" + resourceName + "\'", var6);
        }
    }

private static File getConfigDir() {
    		return new File(Loader.instance().getConfigDir(), "CustomOreGen");//TODO: change this to point to you desired config location
    	}
}

 

It's flexible enough that you should be able to alter it to handle whatever file or files you want.

[Draco18s]

Ouch at that manual copying Why do people always reinvent the wheel?

 

Likely because we don't know the wheel exists.