epicgames-fortnite-client

node-epicgames-fortnite-client

The javascript client for Fortnite.

Installation

npm i epicgames-fortnite-client

Do you need help?

Check our discord server: https://discord.gg/HxGfuEx

Example

const EGClient = require('epicgames-client').Client;
const Fortnite = require('epicgames-fortnite-client');

let eg = new EGClient({
    email: 'EMAIL',
    password: 'PASSWORD'
});

eg.init().then(async (success) => {
	
	if(!success)
		throw new Error('Cannot initialize EpicGames launcher.');

	if(!await eg.login())
		throw new Error('Cannot login on EpicGames account.');

	let fortnite = await eg.runGame(Fortnite);

	let stats = await fortnite.getStatsBR('Kysune');
	
	console.dir(stats);

});

Constructor options

const FortniteClient = require('epicgames-fortnite-client').Client;
let fortnite = new FortniteClient(eg, {

	use_waiting_room: true, //false to ignore waiting room (epicgames load balancer)

	http: {
		//settings for lib https://github.com/request/request
	}

});

Methods

Generals

init()

Initialize client

login()

Login to an account.

setLanguage(language)

Sets language for client.

• language {string} - Language Code Identified e.g. en-US, pl-PL (or pl)

getSubgames()

Returns an object with all subgames (e.g. Battle Royale, Save The World, Creative) and last modified time.

getRawBasicData()

Returns all basic data. That informations are received while start game.

refreshBasicData()

Refreshing all basic data. You can use this after change client's language.

getStoreCatalog()

Returns raw fortnite store catalog (items possible to buy e.g. starter kit, battle pass)

Battle Royale (BR)

getNewsBR()

Returns an object with list of news for subgame Battle Royale and last modified time.

getStatsBR(id[, time='alltime'])

Returns an object of statistics for the Battle Royale mode. An object is divided on platforms with objects, which is divided on game's modes (solo/duo/squad).

• id {string} - account's id or display name
• time {string} - weekly or alltime

getStoreFeaturedItems()

Returns list of store featured items

getStoreDailyItems()

Returns list of store daily items

getTournaments()

Returns an object with list of tournaments and last modified time.

getAllGameModes()

Returns an object with list of all game modes and last modified time.

Save The World (PVE)

getNewsPVE()

Returns an object with list of news for subgame Save The World and last modified time.

getWorldInfo()

Returns object with full info about locations, missions etc. You don't need bought subgame Save The World.

Creative Mode

getCreativeWorld(code)

Returns informations about creative world.

• code {string} - creative world's share code

getFavoriteCreativeWorlds()

Returns list of your creative worlds.

Classes

CreativeWorld

Properties

code

author

title

description

type

locale

Methods

addToFavorites()

License

MIT License

Copyright (c) 2018 Kysune

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.