Oblivion
0 of 0

File information

Last updated

Original upload

Created by

XJDHDR

Uploaded by

XJDHDR

Virus scan

Safe to use

Documentation

Readme

View as plain text

Name: Plugin Resources
Version: 1.001
Category: Modders Resources and Tutorials
Author: XJDHDR
Download locations: Nexus Mods: Direct Link: https://www.nexusmods.com/oblivion/mods/37684
Ad-supported interstitial link: http://lopoteam.com/3050662/plugin-resources---nexus-mods

Discussion threads: Bethesda.net: https://bethesda.net/community/topic/323002/relz-plugin-resources
AFK mods: https://afkmods.iguanadons.net/index.php?/topic/5420-relz-plugin-resources/
The Assimilation Lab: http://www.theassimilationlab.com/forums/topic/16661-relz-plugin-resources/


Table of Contents:
==================
Description
Details
Requirements
Install
Uninstall
Incompatibility
Known issues or Bugs
History
Contacts
Credits
Tools used
Licensing/Legal



Description
===========
Provides a library of pre-created records for modders to use. This allows their mods to be mergeable into Wrye Bash's Bashed Patch, thus saving ESP slots for the end user.


Details
=======
This mod provides a library of pre-created records for modders to use. This allows their mods to be mergeable into Wrye Bash's Bashed Patch, thus saving ESP slots for the end user.

Modders:
All you have to do is replace any new records in your mod with blank records created by "Plugin Resources.esm". If you ensure that every new record created by your mod uses a record provided by "Plugin Resources.esm", this will allow your mod to be merged into the Bashed Patch.

What are the Rules?
1. You can only use records from my ESM that you have already claimed. The reason for this is so that you don't use a record that someone else is using in their mod, which would cause overwrites and conflicts if an end-user had both mods installed.
2. Your finished mod must be mergeable in Wrye Bash. If it isn't, you are simply making your mod dependent on mine for no good reason. Additionally, you're wasting blank records and wasting my time as a result.

How do I claim a record for my mod?
Each listed record type below has a link to a wiki page on both SourceForge and Github. The wiki page you visit will have a list of records present in "Plugin Resources.esm" and whether or not they are available. To assign a record to your mod, simply edit the wiki page so that the needed records are listed as being used by your mod. It would also be appreciated if you inform me that you are claiming records. I would also appreciate it if you could edit both wikis to reflect your claimed records but I can do so otherwise.

Do I need another online account to claim a record?
You will need either a SourceForge or Github account to edit the pages on the respective wikis. Both are free and easy to create. Personally, I slightly prefer SourceForge's wikis to Github's but it's entirely up to you.

Once I've claimed a record, how exactly do I use it?
The procedure I recommend is to create your mod as you normally do until you are ready to upload it somewhere. Once you are ready, figure out how many and what new records your mod has created then claim those records. After that, open your mod and Plugin Resources in TES4Edit then modify the FormIDs of your mod's new records to the FormIDs of the records you claimed. You will then need to recompile any scripts in your mod that reference any of these new records.

The other way you can do this is by loading your mod and Plugin Resources into the Construction Set then modifying unclaimed records in Plugin Resources to suit your needs.


Then you can and should change the Editor ID for the claimed records to something more appropriate for your mod. After that, simply modify the claimed records to suit your purposes

At the moment, you can use the following records in the ESM without any problems:
Main page: https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources/ https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin-Resources

Activator https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Activator https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Activator
AI Package https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20AI%20Package https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20AI%20Package
Alchemical Apparatus https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Alchemical%20Apparatus https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Alchemical%20Apparatus
Ammunition https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Ammunition https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Ammunition
Animated Object https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Animated%20Object https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Animated%20Object
Armor https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Armor https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Armor
Book https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Book https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Book
Class https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Class https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Class
Climate https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Climate https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Climate
Clothing https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Clothing https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Clothing
Combat Style https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Combat%20Style https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Combat%20Style
Container https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Container https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Container
Creature https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Creature https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Creature
Door https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Door https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Door
Effect Shader https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Effect%20Shader https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Effect%20Shader
Enchantment https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Enchantment https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Enchantment
Eyes https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Eyes https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Eyes
Faction https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Faction https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Faction
Flora https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Flora https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Flora
Furniture https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Furniture https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Furniture
Global https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Global https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Global
Grass https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Grass https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Grass
Hair https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Hair https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Hair
Ingredient https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Ingredient https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Ingredient
Key https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Key https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Key
Landscape Texture https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Landscape%20Texture https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Landscape%20Texture
Leveled Creature https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Leveled%20Creature https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Leveled%20Creature
Leveled Item https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Leveled%20Item https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Leveled%20Item
Leveled Spell https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Leveled%20Spell https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Leveled%20Spell
Light https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Light https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Light
Load Screen https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Load%20Screen https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Load%20Screen
Misc. Item https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Misc%20Item https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Misc%20Item
Non-Player Character (NPC) https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20NPC https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20NPC
Potion https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Potion https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Potion
Quest https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Quest https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Quest
Race https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Race https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Race
Script https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Script https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Script
Sigil Stone https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Sigil%20Stone https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Sigil%20Stone
Soul Gem https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Soul%20Gem https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Soul%20Gem
Sound https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Sound https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Sound
Spell https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Spell https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Spell
Static https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Static https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Static
Subspace https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Subspace https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Subspace
Tree https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Tree https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Tree
Water https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Water https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Water
Weapon https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Weapon https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Weapon
Weather https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Weather https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Weather


The following are also provided, but there are some caveats:
Conversation Topic https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Conversation%20Topic https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Conversation%20Topic
-Conversation Topics can only be merged into the Bashed Patch if CBash is enabled. It is still a beta and thus disabled by default.
-The editor ID for Dialog Topics can only be changed using TES4Edit.

Dialog Topic https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Dialog%20Topic https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Dialog%20Topic
-Same as Conversation Topics.

Cell https://sourceforge.net/p/xjdhdr-random-code/wiki/Plugin%20Resources:%20Cell https://github.com/XJDHDR/xjdhdr-random-code/wiki/Plugin%20Resources:%20Cell
-There are none available by default in the ESM. These have to be specifically requested. The reason is because after you create a new cell, you will have to place some objects in the cell. The problem with doing this is that each object placement is regarded by Wrye Bash as a new reference record and will refuse to merge it into the Bashed Patch. The solution then is to request a new cell and state how many objects you intend to place into the cell. I will then create a new cell with the required number of placeholder references which you then use the CS's Search and Replace function on.
-Cell edits can only be merged into the Bashed Patch if CBash is enabled. It is still a beta and thus disabled by default.

The following are not provided and won't be until the issues noted are resolved:
Birthsign
-All blank Birthsigns created by my ESM will appear in the Birth signs menu when the player is creating their new character. I will not create blank Birthsign records unless there is a way to hide them.
Game Setting
-The game won't recognize any new settings created by my ESM unless someone modifies Oblivion's EXE to recognize them. I am willing to create blank records if someone is willing to do that modification. Additionally, settings changes can only be merged into the Bashed Patch if CBash is enabled.
Idle Animation
-Still need to properly research the possibility of making this work but I'm not very hopeful.
Region
-Only really useful in conjunction with new worldspaces, which I'm not currently willing to support for reasons mentioned below.
Skill
-The game won't recognise any new skills created by my ESM unless someone modifies Oblivion's EXE to recognise them. I am willing to create blank records if someone is willing to do that modification.
Worldspace
-World space edits are only mergeable if CBash is enabled. Also, any new objects placed in the world space is a new reference, so I would have to custom create blank world spaces with reference placeholders. Finally, due to the way worldspaces are handled in Oblivion, there might be the possibility of oversights or game bugs that would make a mergable mod with worldspaces impossible. I'm not currently willing to put in the work required to make this work but I might reconsider this depending on how big your requested worldspace is. If I do change my mind, it will be the same arrangement as Cell records, only provided on request.

What if I'm trying to claim a record at the same time as someone else?
Whoever gets their edit in first gets the record.

What if there aren't enough available records for my mod?
Simply send me a message requesting some more and I will release an updated ESM with more blank records.


Requirements
============
None


Install
=======
First, installing mods without using a mod manager is highly discouraged as it can lead to bugs and crashes in your game depending on how many mods you have installed and how they interact with each other. Hence, I can't provide support if you choose to install this mod manually.

As for using a mod manager, I can't recommend any particular manager as everyone has their own personal preferences in this area. My personal preference is Vortex ( https://www.nexusmods.com/site/mods/1? ) though Wrye Bash ( https://github.com/wrye-bash/wrye-bash ) was my previous favourite and is still a solid choice (and you need it anyway for it's Bashed Patch).

To install, simply download this mod's archive onto your PC then install it using your favourite mod manager. This is a standard mod containing only an ESM so no special instructions are required to install. Please consult your mod manager's documentation or contact the mod manager's developer(s) if you need help installing mods.


Update
======
Download the updated file, install it then uninstall the old version.

A clean save is not required to update this mod. The latest version should cleanly replace any old versions you are using. However, if you are having trouble updating this mod and following the prerequisites above don't help, you can try to do a clean save and see if that helps. This is the procedure:
1. Deactivate or uninstall "Plugin Resources.esm" in either Oblivion's launcher or your favourite mod manager.
2. Load the save you want to update.
3. Save your game in a new slot.
4. Repeat 2 and 3 for each save you want to update.
5. Install the latest version of this mod.
6. Reactivate "Plugin Resources.esm".


Uninstall
=========
This is a standard mod containing an ESM and supplementary files so no special instructions are required to uninstall. Please consult your mod manager's documentation or contact it's developer(s) if you need help uninstalling mods.


Incompatibility
===============
None.


Known Issues or Bugs
====================
None.


History
=======
1.001, 2019/02/16 - Reworked the blank Global Variables to provide a way for a mod to get Plugin Resource's version (XJPRaVersionVar will
contain the version number as displayed in the documentation).
- Added a function that can remove every single item from a container's inventory (zzzzXJPRRemoveAllItemsFromPlayerFunctionScript).
- Added a container (XjPRTempSafeTransferContainer) that can be used for temporary item storage (particularly useful for preventing duplicated items: https://cs.elderscrolls.com/index.php?title=Common_Mistakes#Avoid_Using_DuplicateAllItems_on_a_Companion )
- Fixed the blank NPC records to no longer create a dirty edit in some circumstances.
- Added 5 blank animated objects (XJPRAnimObject0001 - 05).
- Added 5 blank classes (XJPRClass0001 - 05).
- Added 10 blank quests (XJPRQuest0011 - 020)
- Added 30 blank scripts (zzzXJPRScript0021 - 050)

1.000, 2011/03/21 - Initial release.


Contact
=======
You can find me at the following sites under the user 'XJDHDR':
- Nexus Mods: http://www.nexusmods.com/oblivion/users/625820/?
- Bethesda.net: https://bethesda.net/community/user/xjdhdr
- Github: https://github.com/XJDHDR


Credits
=======
My thanks goes to:

God for creating us all.
Bethesda Game Studios for creating the RPGs I love to play and mod.
Nexus Mods for providing me with a place to host my work.
LHammonds for the Readme Generator this readme was based on.


Tools Used
==========
TES4Edit - https://www.nexusmods.com/oblivion/mods/11536
TES Construction Set - https://www.nexusmods.com/oblivion/mods/48493?
Wrye Bash - https://www.nexusmods.com/oblivion/mods/22368
Readme Generator - http://lhammonds.game-host.org/obmm/tools_readme_generator1.asp (offline)
7-Zip - https://www.7-zip.org/


Licensing/Legal
===============
Do not redistribute or modify this mod without my permission. If you need this mod to do something more, please contact me.