Giter Club home page Giter Club logo

abilifier's Introduction

Abilifier

Versions 1.2.0.4 and higher require modtek v3 or higher

Versions 1.4.0.0 amd higher require IRBTModUtils, available here: https://github.com/BattletechModders/IRBTModUtils/releases

This is a mod for HBS Battletech that allows developers to give players choices when it comes to leveling up abilities. Special thanks to kMiSSioN for allowing the reuse of their code adding additional ability buttons to the Combat HUD.

To use, place your new AbilityDefs in an appropriate subfolder, either in the Abilifier folder or elsewhere in your modpack, and ensure you have the appropriate manifest entry in your mod.json so modtek will load the new AbilityDefs, e.g.

 "Manifest": [
		{ "Type": "AbilityDef", "Path": "Abilities" },

In addition, you must add the new Ability Ids to SimGameConstants under the Progression entry, e.g.:

	"Progression" : {
		"GunnerySkills" :[
			[
				"TraitDefWeaponHit1"
			],
			[
				"TraitDefWeaponHit2"
			],
			[
				"TraitDefWeaponHit3"
			],
			[
				"TraitDefWeaponHit4"
			],
			[
				"TraitDefWeaponHit5",
				"AbilityDefG5",
				"AbilityDefG5a"
			],

Using the above, a player reaching Gunnery 5 will have the choice between the abilities with Ids AbilityDefG5 and AbilityDefG5a. Using the existing naming scheme (appending "a", "b", etc. for new abilities in a skill tree) is not required, but is recommended for potential future compatibility.

Lastly, developers have a choice between the display style for the ability selection pop-up. The default method is to display the entire body of the Ability details in the AbilityDef .json, e.g: TextPop

The alternative style is to use a hover tooltip, but this requires a little extra work on the developers' part: HoverPop

To use a hover tooltip, you will need to create BaseDescriptionDef (essentially lore hover items) .jsons for all abilities, including any vanilla abilities being used, and place them in Abilifier/AbilityDescs. The BaseDescriptionDef Id must be identical to the AbilityDef Id, ending in "Desc" as below:

{
    "Id" : "AbilityDefP5aDesc",
    "Name" : "MOSTEST SUREST FOOTING",
    "Details" : "PASSIVE: 'Mechs piloted by this MechWarrior gain ALL THE EVASIVE CHARGES after moving (can exceed the unit's maximum). If the move is not a sprint, jump, or charge to melee, the 'Mech also gains ENTRENCHED (50% stability damage reduction).",
    "Icon" : ""
}

StatisticEffectData Extensions

Abilifier now ships with an additional config .json called EffectDataExtensions.json. This file defines optional new capabilities and restrictions for EffectData affecting StatCollections in game. The config comprises a Dictionary, where the "key" is equal to the EffectData.Description.Id for which you want to impose additional restrictions.

More Details

Additional AbilityDef Fields

A few new fields have been added to AbilityDefs, providing some additional functionality.

More Details

Settings

Settings available in the mod.json:

More Details

AbilityRealizer

As of v1.3.0.0, Abilifier has absorbed the AbilityRealizer mod. Settings for AbilityRealizer module can be found in AbilityRealizerSettings.json in the Abilifier mod folder. All existing settings and behavior have been maintained.

More Details

Traits

Troubleshooting information for trait pip generation.

More Details

abilifier's People

Contributors

ajkroeg avatar cmission avatar gnivler avatar korgano avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.