resources

kernel service

The resource services provides access the file system and resources stored in NWN container files. The main goals mostly satisfied: the ability to read all NWN(:EE) containers. The ability to add new container types is limited in utility due to NWNX:EE’s lack of a ResMan plugin, even so the ability to load files from a Zip file is included.

Example - Demanding a resource from resman

import rollnw
from rollnw.kernel import resman

rollnw.kernel.start()
assert resman().contains('nw_chicken.utc')
data = resman().demand('nw_chicken.utc')
data2 = resman().demand(rollnw.Resource('nw_chicken', rollnw.ResourceType.utc))
assert data == data2

nw::kernel::start();
// Assumes that NWN root directory was found.
if (nw::kernel::resman().contains({"nw_chicken"sv, nw::ResourceType::utc})) {
    auto utc = nw::kernel::resman().demand({"nw_chicken"sv, nw::ResourceType::utc});
    // Do something with this chicken.
}

containers

Directory

Status: Read, Write (file format dependant)

Erf

Status: Read

Example - Load an Erf and Print Contents

import rollnw

erf = rollnw.Erf("tests/test_data/user/hak/hak_with_description.hak")
print(erf.name(), erf.size())
for rd in erf.all():
    print(rd.name.filename(), rd.size)

#include <nw/resources/Erf.hpp>
// ...
Erf e("MyModule.mod");
if (e.valid()) {
    std::cout << fmt::format("{} has {} resources", e.name(), e.size()) << "\n";
    for (const auto& rd : e.all()) {
        std::cout << fmt::format("File: {}, Size: {}", rd.name.filename(), rd.size) << "\n";
    }
}

Key/Bif

Status: Read

NWSync

Status: Read

Example - Loading and Reading From NWSync Manifest

import rollnw

nws = rollnw.NWSync("path/to/nwsync")
if nws.is_loaded():
    # One of the curated modules
    manifest = nws.get('9a84e512dd3971eb215d6f9b0816a2e3ae2fee54')
    if manifest:
        tga = manifest.demand('002metal.tga')
        # Do something with this image..

#include <nw/resources/NWSync.hpp>
#include <nw/kernel/Kernel.hpp>

auto path = "path/to/nwsync"
auto n = nw::NWSync(path);
if(!n.is_loaded()) {
    throw std::runtime_error("a fit");
}

auto manifests = n.manifests();
if (manifests.size() > 0) {
    auto manifest = n.get(manifests[0]);
    auto resource = manifest->all();
    if(resource.size() > 0) {
        // Extract the first resource found
        manifest->extract(std::regex(resource[0].name.filename()), "tmp/");
    }
}

Zip

Status: Read