Java library to provide an easy way to manage all kind of resources
Java
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
resourcesmanager-core
resourcesmanager-java2dmodule
resourcesmanager-tests
.gitignore
README.md
license.txt
pom.xml

README.md

This project provides a way to manage your application resources/assets in a common way.

Features

  • User defined resource types (a Font, a String, an Image)
  • User defined ways to load each resource type.
  • Can be used with any framework, for example, LibGDX, Slick2D, etc.
  • Dynamic resource reloading in a transparent way
  • Resource cache
  • Simple and easy to use.

How to use it

To know how to use the project, you should know a bit about the following classes.

DataLoader

This class provides the logic of loading and unloading a resource, it is used by the ResourceManager when building a new Resource. This class should be implemented to define both load and unload logic, for example, if you want to load a Slick2D Sound, you could implement something like this:

public class SlickSoundLoader extends DataLoader<Sound> {

    private final String file;

    public SlickSoundLoader(String file) {
        this.file = file;
    }

    @Override
    public Sound load() {
        try {
            return new Sound(file);
        } catch (SlickException e) {
            throw new RuntimeException("failed to load slick sound from file " + file, e);
        }
    }

    public void unload(Sound s) {
        // release the data in some way, this method implementation is not required.
    }

}

The module named resourcesmanager-slick provides DataLoader implementations for some of the Slick assets like Sound, Image and Fonts, the module named resourcesmanager-java2d provides DataLoader implementations to load java2d Images and others.

Resource

This class provides a level of abstraction to the real resource data, and provides methods for getting the data, loading it and unloading it. Here is the API of the class:

Resource<T> {

    // it will return the real data, if not loaded it will try to load it before.
    T get();

    // shortcut to call unload() and load()
    void reload();

    // loads the data if not loaded already
    void load();

    // unloads the data if it was loaded
    void unload();

    // returns true if data is loaded, false otherwise.
    boolean isLoaded();

}

ResourceManager

This class provides a way to declare resources by declaring an id and how the Resource is loaded, for example:

ResourceManager resourceManager = new ResourceManagerImpl();
resourceManager.add("MyResourceID", new SlickSoundLoader("data/sounds/mysound.ogg"));

By declaring a resource you are not loading it yet, it only defines how the resource should be loaded when you ask for it:

Resource<Sound> mySound = resourceManager.get("MyResourceID");
// here is where the data is loaded for the first time.
Sound sound = mySound.get();
// calling get() a second time will return the same, already loaded, data.
Sound sound = mySound.get();

DataSource

Provides an abstract way to get a stream to the data itself, this class is not necessary in the process but could be useful to reuse DataLoader logic in an easy way, here is the API:

DataSource {

    // Returns a stream with the data.
    InputStream getInputStream();

    // Returns how the data is identified by this DataSource
    String getResourceName();

}

There are three implementations (you could add your own), ClassPathDataSource provides access to class path information, FileSystemDataSource provides access to data in the file system, RemoteDataSource provides information to a remote resource, from the web. The idea of this class is to make DataLoaders to use DataSource instead of a String which represents the file path so you could easily change from one source to another when declaring a resource data loader, for example:

new SlickSoundLoader(new ClassPathDataSource("data/sounds/mysound.ogg"))
// reuse data loader logic by changing the data source
new SlickSoundLoader(new RemoteDataSource("http://www.gemserk.com/mygame/sounds/mysound.ogg"))

Dynamic resource reloading

An interesting point is Resources are cached in ResourceManager, so if you ask for the Resource identified by mySound in two different points of your code, both will be accessing the same Resource and the same data. That means if you reload a Resource for some reason, the data will be updated in the Resource and you will be implicitly aware of the change in your code without having to do anything extra.

The following video named Dynamic Resources Reloading shows a resource being modified by an external application and being reloaded.

Also there is an example resourcemanager-tests/src/main/java/com/gemserk/resources/tests/ResourcesReloadExample.java which shows how to change a Resource data on the fly.

TODO List

  • Data monitoring, there is a basic data monitoring but it could be great to improve it and add as part of the API maybe, so you could know some image in the your file system was modified.

Contributing

Feel free to add issues, make forks or contact us directly if you have suggestions, bug reports or enhancements.

Tags

java, resources, assets, manager