jpiolho/QuakeReloaded

A library that provides API to interface Reloaded-II mods with Quake Enhanced

QuakeReloaded

A library that provides API to interface Reloaded II mods with Quake Enhanced

This is just a base mod that contains a lot of useful code for other mods. See of a list of mods using QuakeReloaded here

For players

• Install Reloaded-II if you don't have it
• Click here to install the mod

Manual install

• Head over to the Releases and download the latest QuakeReloaded 7z file (NOT the interfaces file)
• Extract the 7zip file into <Reloaded II path>/Mods/QuakeReloaded (alternatively: %RELOADEDIIMODS%/QuakeReloaded)
• Make sure it shows up in the Reloaded mod list

For modders

How to create a mod using QuakeReloaded

1. Setup a project with the Reloaded template. You can find documentation here
2. In your project, include QuakeReloaded.Interfaces nuget package.
3. Edit your ModConfig.json:
   1. Set the ModID with the following name convention (remember all lower case and no spaces): quakeenhanced.mod.<your mod name>
   2. Add quakeenhanced.mod.quakereloaded to ModDependencies
   3. Add quake_x64_steam.exe to SupportedAppId
4. To get access to QuakeReloaded API use the following code in your Mod constructor:

   if (!(_modLoader.GetController<IQuakeReloaded>()?.TryGetTarget(out var qreloaded) ?? false))
       throw new Exception("Could not get QuakeReloaded API. Are you sure QuakeReloaded is installed & loaded before this mod?");

5. Refer to other mods source code and the QuakeReloaded API documentation.