Skip to content
CJ Kucera edited this page Jul 19, 2019 · 6 revisions

1. Create a personal fork of the main repository

This only needs to be done once, when you first start modding. Create a personal Fork of the BLCM/BLCMods repository (top right). Creating a Fork

2. Create your user directory (and your first file)

This only needs to be done once, when you first start modding. You need to create a new directory with your github username, to store your mods underneath Borderlands 2 mods or Pre Sequel Mods. The only real way to do this is with the "Create new file" button, so you can't use the "Upload files" button here. Make sure you're on your own personal fork while you do this:

Create New File button

At the next screen, you need to type in your username followed by a /, and the page will automatically know that you're talking about a new directory, like so:

Creating a New Directory

You can either paste your new mod directly into the box, or just put in a temporary file.

3. Upload any other files to your own fork

Once you have your directory in place, on your personal fork, you can use the Upload files button to upload files directly into your user folder:

Upload Files

Many people will appreciate your directory more if it's organized into subfolders. To create new folders, you'll have to use Create new file like you did originally, and use / when typing in the filename to create a new directory. That way you can use Borderlands 2 mods/Your Name/Mod Name/mod.txt instead of Borderlands 2 mods/Your Name/mod.txt.

4. Add a cabinet.info file so your mod shows up in the ModCabinet

There is a wiki called "ModCabinet" which helps categorize all the mods on the github for easier browsing. You can see it here.

Your mod will be automatically added to ModCabinet so long as you have a file called cabinet.info alongside your mod. See the Contributing to ModCabinet page for information on what to put in this file.

5. Submit a "Pull Request" to pull your changes into the main repository

  • While still on your personal fork, send a Pull Request to Compare merge your fork to the master branch. Creating a Pull Request
  • Make sure that the branch of your fork that you wish to submit (#1) on the right side is correct, and BLCM/BLCMods master branch is on the left, then submit the request (#2). Confirming the Pull Request
  • Then wait for someone on BLCM to accept, merge and commit your request for you, if it takes more than a week feel free to ping someone on the discord to let them know that you've been waiting an extended period of time for a pull request.

  • This is NOT permission to ping someone as soon as you send a pull request, remember that not everyone is on discord/Github 24/7, it will take some time regardless if you ping someone or not, and will be seemingly random at times, so please be patient when waiting for approval.
Clone this wiki locally