AcediaFramework
/
AcediaCore
2
0
Fork 0
Code Issues 9 Pull Requests Releases Wiki Activity
UnrealScript library and basis for all Acedia Framework mods
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
127 Commits
3 Branches
0 Tags
9.2 MiB
 
Tree: 6c89f178f0
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '6c89f178f0'
${ noResults }
AcediaCore/docs/index.md

2.2 KiB
Raw Blame History

Acedia for mod making

This document aim to guide you through all of Acedia's features and capabilities from the mod maker perspective. It consists of a brief overview of how different components fit together and then somewhat detailed look at each of them.

This document is not a reference documentation that lists and describes every single class and method. Unfortunately, such a document does not exist right now. The closest substitute for it would be Acedia's source code - most of the methods and classes are given brief descriptions in the comments. They might somewhat lack in quality, since having a peer review for them would not have been viable, but that is all I can offer. Any corrections to them are always welcome.

We assume that our audience is at least familiar with UnrealScript programming. Acedia's API is not stable enough for us to recommend using it to people new to the Killing Floor modding.

What the hell is all of this?

Acedia 0.1 was a small mutator that fixed game-breaking bugs and what Acedia is now might seem like a huge departure from that. But this development was more or less planned even before version 0.1 release. In particular, Acedia 0.1 had already included a Feature class that was used to pick what bug fixes to enable. It would have been an overkill if bug fixing was all Acedia would ever do and now Feature is one of the Acedia's main... features that is supposed to take the role of the Mutator class.

What was Acedia before now is broken into three different packages:

  • AcediaCore - package that defines base classes, required for other Acedia packages to work correctly;
  • Acedia - launcher that is supposed to load both native Mutators and Acedia's Features;
  • AcediaFixes - all the bug fixing Features were moved here.

The topic of this document is only AcediaCore - a base class library.

Functionality of AcediaCore

First of all, go read about safety rules. They don't go into much detail, so don't worry if you don't understand everything - you can read on each specific topic later. But they make a good introduction and will warn you about otherwise very likely mistakes that could lead to rather nasty consequences.