SKYRIM
JContainers - data storage framework by silvericed
Skyrim » Modders resources and tutorials
Added: 10/01/2014 - 10:23PM
Updated: 16/09/2014 - 11:56PM

2,826 Endorsements

3.1.0 Latest version

53,288 Unique D/Ls

62,044 Total D/Ls

128,178 Total Views

Uploaded by silvericed

Description

Last updated at 23:56, 16 Sep 2014 Uploaded at 22:23, 10 Jan 2014

Description

JContainers is a modding framework that extends Papyrus by adding various data structures. Also it is simple NoSQL database. It features:

- various containers that capable to store anything inside - number, string, form or another container
- export or import container data into human readable JSON format
- path resolving: helps access nested data easily with ".youModName.playerData.arrayOfNumbers[10]" like paths
- unicode support
- thread safety: keeps data safe when two or more threads trying to write into one container

Links

Latest documentation
Post feature requests here please

Special thanks

thanks to Saerileth and Gooser, without your interest that project would be abandoned
thanks to skwerlman, alexdunnfor documentation improvements
verteiron - his Familiar Faces mod makes my framework much more noticeable on nexus
thanks to RealAntithesis for interesting ideas

Third party libraries used

skse library - it would be impossible to imagine Skyrim modding without it
boost framework - real treasure for any C++ programmer
jansson - nice JSON parsing library

Installation

Use NMM/MO/anything.
For manual installation open you Skyrim Data folder, place the scripts, SKSE etc in that folder. When ask to merge folders hit yes.

Versioning note

JContainers uses semantic versioning scheme - API.FEATURE.PATCH. Essence:

- API version increases when API changes in backward-incompatible way. Mod requiring JC 3.x most likely will not work with JC 4.x installed
- FEATURE version increases when functionality added in a backwards-compatible manner. Mod requiring JC 3.1 will perform well with JC 3.2 and above
- PATCH version increases when backwards-compatible bug fixes added.

Permissions

- You (as mod author) may bundle this plugin.
- It's up to you to report to a user of incompatibility of installed JC API version and the version mod has been compiled for the best user's experience. Valid condition is `JC.APIVersion == hardcodedAPIVersion && JC.featureVersion >= hardcodedFeatureVersion`.
- The files in this plugin are not to be modified under any circumstance as that could cause problems when a load order includes multiple mods that use the plugin and one or more mods have modified the files in this plugin.

Mods using this plugin

HooKmmerse
KeyInput
Proper Potion Names
Familiar Faces
Druids Den - Collectors Edition