Skip to content

Loadout guidelines

HazardousChurch edited this page May 12, 2020 · 9 revisions

TMF wiki page covering loadouts and assigngear


Macros

LIST macros

Instead of

magazines[] = {
	"30Rnd_556x45_Stanag",
	"30Rnd_556x45_Stanag",
	"30Rnd_556x45_Stanag",
	"HandGrenade"
};

do

magazines[] = {
	LIST_3("30Rnd_556x45_Stanag"),
	"HandGrenade"
};

NOTE: These macros are only available from LIST_1(x) to LIST_20(x)

Medical macros

Instead of

items[] = {
	LIST_5("ACE_fieldDressing"), \
	LIST_1("ACE_morphine"), \
	LIST_1("ACE_tourniquet")
};

do

items[] = {MEDICAL_R};

NOTE: Following macros are available: MEDICAL_R, MEDICAL_CLS, MTR_GEAR, FAC_GEAR and MEDICAL_M

Contributing loadouts

  • Loadout contributions should use the macros listed above as much as possible.
  • Loadout contributions must follow guidelines listed in Contribution-guidelines.
  • Loadout contributions must list used addons in the header.
  • Loadout contributions should list the loadout author in the header.
  • Loadout contributions must not throw errors or in the default mission template. Make sure to check TMF autotest.
  • Loadout contributions must always occur from separate forks and branches, via pull request.
  • Loadout contributions must follow guidelines listed at the top of this page.
  • Loadout contributions must use the provided example_loadout.hpp.
  • Loadout contributions must successfully build using PboProject.

Using Gitkraken

  1. Make sure your fork is up to date by right clicking the master branch under upstream in the Remote list and selecting Fast-forward master to upstream/master
  2. Right click master under local and select Create branch here. Name it loadouts/classname
  3. Copy your loadout.hpp file into P:\x\arc_misc\addons\tmf_loadouts\loadouts. It must be named classname.hpp
  4. Open P:\x\arc_misc\addons\tmf_loadouts\CfgLoadout.hpp and add your loadout using the following template, remove comments:
/* Example classnames:
us_army_2010
ru_marines_2000_winter
us_rangers_2010_mk17
uk_army_2000_ddpm
*/
class classname { 
	//Example displayname: US Marines (2020, UCP, M27 IARs)
	displayName = "mydisplayname (year, appearance, notable equipment)";

	/* Available categories:
	"Armaverse Factions"
	"Russia"
	"USA"
	"Western Factions"
	"Eastern Factions"
	*/
	category = "category name"; // Remove this line to put loadout in "Other loadouts" category.

	tooltip = "Author: authorname \n\nNote: my note"; // Tooltip displayed when hovered over in editor. \n indicates newline

	#include "loadouts\classname.hpp"
};
  1. Open up PboProject and Crunch arc_misc. Resolve any resulting errors.
  2. In GitKraken there should now appear n file change in working directory [View change] at the top right. Press View change
  3. Make sure all edited files are listed, then press Stage all changes
  4. At the bottom right enter Added loadout: classname and optionally add description into the field below. Then press the Commit changes to n file button.
  5. At the top press Push to upload the changes to github.
  6. You will be prompted with What remote/branch should "branchname" push to and pull from? Select origin and press Submit.
  7. Go to New pull request on github. Change compare to your uploaded branch, you may have to refresh the page. Press Create pull request. Enter the same info here as in Stage 7. Press Create pull request.

Your pull request should now be up for review by the repo maintainers, who will hopefully merge it or provide feedback soon.