Skip to content
/ rres Public
forked from raysan5/rres

A simple and easy-to-use file-format to package resources

License

Notifications You must be signed in to change notification settings

NadaXml/rres

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rRES - raylib resource file-format

A simple and easy-to-use file-format to package raylib resources.

rres has been designed to package game assets data into a simple self-contained comprehensive format, easy to read and use, prepared to load data in a fast and efficient way to be directly deployed to memory.

rres has been inspired mainly by XNB file-format (used by XNA) but also RIFF, PNG and ZIP file-formats.

Format Design

First design of the format was limited to packaging one resource after another, every resource consisted of one InfoHeader followed by a fixed set of four possible parameters and the resource data. Along the .rres file, a .h header file was also generated to map the resId with a resource name (usually the original filename of the un-processed data). This model was pretty simple and intuitive but it has some important downsides, like not considering complex pieces of data that could require multiple chunks.

rres first design

Second design was way more complex and tried to address first design shortcomings. In this design every resource could consist of multiple chunks of separate data, clearly defined by a set of properties and parameters. Actually, that design is more aligned with RIFF file-format and how most file types are structure, we could understand every resource in the package as a separate file on its own; also, this new design improves packaging possibilities and features.

rres second design

Tools

rREM was a preliminary implementation of a tool to support rres file generation from multiple assets data.

Compilation

rREM provides compilation using either VS2017 or CMake.

CMake

To compile rREM using CMake, run the following commands...

cd tools/rrem/project/CMake
mkdir build
cd build
cmake ..
make

License

rRES file-format is licensed under zlib/libpng license. Check LICENSE for further details.

Copyright (c) 2014-2018 Ramon Santamaria (@raysan5)

About

A simple and easy-to-use file-format to package resources

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C 98.0%
  • CMake 2.0%