[1.7.2] How to store wiki type info about a block

[TheSparkst3r]

I am currently working on a mod which provides information about blocks as a companion mod to WAILA and NEI. It's currently part of another mod but I wish to split it into its own mod.

 

I have all the functionality worked out but I am stuck for a method of storing the info.

To test the functionality I've just made classes with the info as variables and pull the classes into a hashmap with the unlocalised name of the stack(passed when info is requested) as the key.

 

Rough specification:

-Language support

-Non dependant/obtrusive; doesn't complain if a file doesn't exist. I don't want console spam like if textures aren't available.

-Modular; a user can add a pack and have it detect and use it. Ties into last point.

 

An example file structure might be:

 

"pack-root"/
     assets/
          info/
               "lang"/
                    "mod"/
                         items/
                         blocks/

 

The logical choice would be resource packs. And to use .json files for storing the information.

I have no idea how load them, though. How should I go about doing this?

 

[jabelar]

I haven't tried before, but I'm pretty sure that you can use standard Java text file methods for reading files.  Just look those up. 

 

Your .json file would help map the right file for the purpose (based on the block you want info about and the language you want the text in).

 

In terms of referring to your file there is some FML hooks such as:

 

  Reveal hidden contents

File myFile = FMLCommonHandler.instance().getMinecraftServerInstance().getFile("hello_world.txt");

 

 

After that you should be able to do other file-based methods.  I'm not Java expert, but I think something like:

 

  Reveal hidden contents

    File myFile = FMLCommonHandler.instance().getMinecraftServerInstance().getFile("hello_world.txt"); // use your file name here, which you would get from your .json file

    BufferedReader reader = null;

try {

reader = new BufferedReader(new FileReader(myFile.getAbsolutePath()));

} catch (FileNotFoundException e1) {

// TODO Auto-generated catch block

e1.printStackTrace();

}

    String line = null;

    try {

while ((line = reader.readLine()) != null) {

    // ... put in your code to read and parse your file here

}

} catch (IOException e) {

// TODO Auto-generated catch block

e.printStackTrace();

}

 

 

Since you're catching the errors with the code above, you can control it such that it doesn't spam console if that's what you want.

 

Then you can come up with a text format that best suits your needs. For example maybe you want some markup to enable formatting or something.

[MineMaarten]

We are on the same idea here , with the wiki API. I've done the text reading already, it can be found here to take a look at: https://github.com/MineMaarten/IGW-mod/blob/master/src/igwmod/InfoSupplier.java

[TheSparkst3r]

  On 4/9/2014 at 5:04 AM, jabelar said:

I haven't tried before, but I'm pretty sure that you can use standard Java text file methods for reading files.  Just look those up. 

 

Your .json file would help map the right file for the purpose (based on the block you want info about and the language you want the text in).

 

In terms of referring to your file there is some FML hooks such as:

 

  Reveal hidden contents

File myFile = FMLCommonHandler.instance().getMinecraftServerInstance().getFile("hello_world.txt");

 

 

After that you should be able to do other file-based methods.  I'm not Java expert, but I think something like:

 

  Reveal hidden contents

    File myFile = FMLCommonHandler.instance().getMinecraftServerInstance().getFile("hello_world.txt"); // use your file name here, which you would get from your .json file

    BufferedReader reader = null;

try {

reader = new BufferedReader(new FileReader(myFile.getAbsolutePath()));

} catch (FileNotFoundException e1) {

// TODO Auto-generated catch block

e1.printStackTrace();

}

    String line = null;

    try {

while ((line = reader.readLine()) != null) {

    // ... put in your code to read and parse your file here

}

} catch (IOException e) {

// TODO Auto-generated catch block

e.printStackTrace();

}

 

 

Since you're catching the errors with the code above, you can control it such that it doesn't spam console if that's what you want.

 

Then you can come up with a text format that best suits your needs. For example maybe you want some markup to enable formatting or something.

 

I presume this is loading from the root dir of the server, is there a way to do the same from a resource pack? But as a last ditch attempt this might be a great solution. Thanks

 

EDIT: I've just realised "ResourceLocation" exists. That might be a solution with a BufferedReader to get the content.

Need to look at MC's .json to NBT parser too.