Oblivion Mod:Q-Core/Modding/Getting Started

!BETA NOTICE! This is a BETA release ONLY. Q-Core adds a lot of features (see Details below), but most of what it does is provide a scripting framework for modders to create even more advanced mods -- with less work. If you are a modder, please take a crack at using the modder's resources provided in the mod, but DO NOT RELEASE ANYTHING YET. I cannot guarantee backwards compatibility with future versions at this point, and since this is the first BETA release, it's likely full of bugs. If you are not a modder, please take advantage of the features provided and try to find bugs. Please report bugs via the discussion thread on the official forums linked to from the main page. How do I Start Modding with Q-Core? When loading your mod in TESCS, just be sure to check Q-Core.esm, just as you check Oblivion.esm. With Q-Core.esm checked, you'll have access to all of the Q-Core systems and functionality. When you save, your mod will be marked as dependent on Q-Core.esm just like it's dependent on Oblivion.esm. Where Can I Find Help for Modding with Q-Core? The best place to start is Q-Core/Modding, which has both tutorials to guide you through the features as well as documentation on the included features. If you can't find an answer there, ask on the forums for additional help. (Please do not post help requests on the wiki. Use the forums instead.) Should I Include Q-Core with my Mod? NO! Do not do this. Instead, you'll need to direct users to download Q-Core and install it themselves. Keep in mind that users may already have Q-Core installed. The reason for not including Q-Core is so that Q-Core can be independently updated of any mod that depends on it. And since Q-Core is designed to be backward compatible with mods built on top of earlier versions of itself, there won't be any problem with incompatibilities. Note that the independent updating of Q-Core, means that behavior of Q-Core components used in your mod will likely improve over time. How do I Indicate Q-Core Dependency? You should clearly indicate in the readme for your mod that the mod requires Q-Core (and what version of Q-Core is required). In the installation instructions, you might want to link to the Q-Core/User Docs page. Also, in the description field for your mod, should include two lines at the top: a Version line followed by a Requires line, for example: Version: 1.1 Requires: Q-Core 0.50 Your mod description here. The Version line should be the internal version number of your mod. The Requires line should indicate the minimal version of Q-Core required for your mod. Including version and requires info in the description is useful since it can be used by tools like Wrye Bash in mod list postings and to help debug load lists.