bl3auto

README

FORKED : BL3 Auto SHiFT

Cross platform Go app for automatically redeeming SHiFT codes for all Borderlands and Wonderlands games.

This was forked from matt1484's repo as it appears to be no longer maintained. Since VIP is discontinued, all VIP code has been removed. This will only redeem SHiFT codes going forward.

Getting Started

1. Make a SHiFT account at Borderlands
2. Download program from above link
3. Unzip the folder
4. Run it, you will be prompted for username and password
5. Enter username and password (we only use this info to sign into borderlands)
6. Watch it do its magic
7. Repeat when more codes come out (or set up a cron job)

Run it with --help to view command line args that are supported.

Installing

Docker

Source: https://hub.docker.com/r/jauderho/bl3auto/

1. Install Docker
2. Run docker pull jauderho/bl3auto:latest
3. Optional: Create codes subdirectory to store output from previous runs with mkdir codes
4. Run docker run -it -v codes:/root/.config/bl3auto/bl3auto jauderho/bl3auto:latest
   • The mounted volume will keep track of existing codes that have been used already

Docker Compose (preferred)

1. Install Docker and docker-compose
2. Create .env and put the following in the file
   • Add BL3_EMAIL="me@myemail.com" and BL3_PASSWORD="mypassword"
   • Replace "me@myemail.com" with your login email address
   • Replace "mypassword" with your login password
3. Use the compose.yml file below (Updated as of 10/16/2021)

services:
  bl3auto:
    container_name: bl3auto
    image: jauderho/bl3auto:latest
    command: ["-e", "${BL3_EMAIL}", "-p", "${BL3_PASSWORD}"]
    volumes:
      - './codes:/root/.config/bl3auto/bl3auto'

volumes:
  codes:

1. Optional: Create codes subdirectory to store output from previous runs with mkdir codes
   • Doing so will allow bl3auto to compare and avoid trying to redeem a previously used code
2. Run docker-compose up

Using the prebuilt releases

The binaries/executables are released here

FAQs

Why does my operating system say it's an unrecognized/untrusted app?

Telling the operating system that we're a trusted source is expensive. This is a small open source project and we don't have the funds to correctly sign the app.

Running the app on macOS

macOS may refuse to run the app because it is "from an unidentified developer". To get around this, right click on the app in Finder, and while holding the ⌥ Option key, click Open in the menu. You will be prompted with a message similar to this:

macOS cannot verify the developer of "bl3auto". Are you sure you want to open it?

Click the Open button and the app will run in your terminal. From that point forward you will be able to run the app directly or from your terminal without any issues.

Why does my antivirus flag this program?

It's a false positive. If you don't trust us, you can look at the code and compile it yourself. That's one of the beauties of an open source project!

It's not working. What should I do?

File an issue here with as much detail as you can provide. We're working on adding additional logging and a bug template to better assist with any issues.

License

This project is licensed under the Apache-2.0 License - see the LICENSE file for details

Documentation

Index

• func JsonFromBytes(bytes []byte) *gojsonq.JSONQ
• func JsonFromString(s string) *gojsonq.JSONQ
• type Bl3Client
  • func NewBl3Client() (*Bl3Client, error)
  • func (client *Bl3Client) GetCodePlatforms(code string) ([]string, bool)
  • func (client *Bl3Client) GetFullShiftCodeList() (ShiftCodeMap, error)
  • func (client *Bl3Client) GetShiftPlatforms() (StringSet, error)
  • func (client *Bl3Client) Login(username string, password string) error
  • func (client *Bl3Client) RedeemShiftCode(code, platform string) error
• type Bl3Config
• type HttpClient
  • func NewHttpClient() (*HttpClient, error)
  • func (client *HttpClient) Do(req *http.Request) (*HttpResponse, error)
  • func (client *HttpClient) Get(url string) (*HttpResponse, error)
  • func (client *HttpClient) Head(url string) (*HttpResponse, error)
  • func (client *HttpClient) Post(url, contentType string, body io.Reader) (*HttpResponse, error)
  • func (client *HttpClient) PostJson(url string, data interface{}) (*HttpResponse, error)
  • func (client *HttpClient) SetDefaultHeader(k, v string)
• type HttpResponse
  • func (response *HttpResponse) BodyAsHtmlDoc() (*goquery.Document, error)
  • func (response *HttpResponse) BodyAsJson() (*gojsonq.JSONQ, error)
• type ShiftCodeMap
  • func (codeMap ShiftCodeMap) Contains(code, platform string) bool
• type ShiftConfig
• type StringSet
  • func (set StringSet) Add(s string)

Functions

func JsonFromBytes

func JsonFromBytes(bytes []byte) *gojsonq.JSONQ

func JsonFromString

func JsonFromString(s string) *gojsonq.JSONQ

Types

type Bl3Client

type Bl3Client struct {
	HttpClient
	Config Bl3Config
}

func NewBl3Client

func NewBl3Client() (*Bl3Client, error)

func (*Bl3Client) GetCodePlatforms

func (client *Bl3Client) GetCodePlatforms(code string) ([]string, bool)

func (*Bl3Client) GetFullShiftCodeList

func (client *Bl3Client) GetFullShiftCodeList() (ShiftCodeMap, error)

func (*Bl3Client) GetShiftPlatforms

func (client *Bl3Client) GetShiftPlatforms() (StringSet, error)

func (*Bl3Client) Login

func (client *Bl3Client) Login(username string, password string) error

func (*Bl3Client) RedeemShiftCode

func (client *Bl3Client) RedeemShiftCode(code, platform string) error

type Bl3Config

type Bl3Config struct {
	Version             string            `json:"version"`
	LoginUrl            string            `json:"loginUrl"`
	LoginRedirectHeader string            `json:"loginRedirectHeader"`
	SessionIdHeader     string            `json:"sessionIdHeader"`
	RequestHeaders      map[string]string `json:"requestHeaders"`
	SessionHeader       string            `json:"sessionHeader"`
	Shift               ShiftConfig       `json:"shiftConfig"`
}

type HttpClient

type HttpClient struct {
	http.Client
	// contains filtered or unexported fields
}

func NewHttpClient

func NewHttpClient() (*HttpClient, error)

func (*HttpClient) Do

func (client *HttpClient) Do(req *http.Request) (*HttpResponse, error)

func (*HttpClient) Get

func (client *HttpClient) Get(url string) (*HttpResponse, error)

func (*HttpClient) Head

func (client *HttpClient) Head(url string) (*HttpResponse, error)

func (*HttpClient) Post

func (client *HttpClient) Post(url, contentType string, body io.Reader) (*HttpResponse, error)

func (*HttpClient) PostJson

func (client *HttpClient) PostJson(url string, data interface{}) (*HttpResponse, error)

func (*HttpClient) SetDefaultHeader

func (client *HttpClient) SetDefaultHeader(k, v string)

type HttpResponse

type HttpResponse struct {
	http.Response
}

func (*HttpResponse) BodyAsHtmlDoc

func (response *HttpResponse) BodyAsHtmlDoc() (*goquery.Document, error)

func (*HttpResponse) BodyAsJson

func (response *HttpResponse) BodyAsJson() (*gojsonq.JSONQ, error)

type ShiftCodeMap

type ShiftCodeMap map[string][]string

func (ShiftCodeMap) Contains

func (codeMap ShiftCodeMap) Contains(code, platform string) bool

type ShiftConfig

type ShiftConfig struct {
	CodeListUrl   string `json:"codeListUrl"`
	CodeInfoUrl   string `json:"codeInfoUrl"`
	UserInfoUrl   string `json:"userInfoUrl"`
	GameCodename  string `json:"gameCodename"`
	AllowInactive bool
}

type StringSet

type StringSet map[string]struct{}

func (StringSet) Add

func (set StringSet) Add(s string)