GitHub Readme.md
This provides OBS overlay of data from The Tracker Network and other sources
Please add attribution to your Stream Information Section (if supported):
Markdown:
[OBS-GAMESTATS](https://github.com/camalot/obs-gamestats) by [DarthMinos](https://www.twitch.tv/darthminos)
/overlay/fortnite/{platform}/{epic-name}/[mode]?[fields={field-list}]
pc
: PCxbl
: XBOXpsn
: PLAYSTATIONall
: Displays All Time
Stats (Default)solo
: Displays Solo
Statsduo
: Displays Duo
Statssquad
: Displays Squad
Stats
NOTE:
Progress Bars (Any of the_
fields for percentages) are not currently enabled due to an issue with the progress bar rendering incorrectly.
Values that are
0
will not render, unless they are explicitly set in the fields parameter.
This should be a comma (,
), pipe (|
), or semi-colon (;
), separated list
all
*
: SPECIAL ALL FIELDS (Default)avgsurvivaltime
: Avg Survival Timeavgsurvivaltime_
: Avg Survival Time %timeplayed
: Time Playedkpm
: Kills Per Minkd
: Kill / Death Ratiokills
: Total Killswins
: Total Winswins_
: Win Percentagematches
: Matches Playedtop25
: Total Top 25top12
: Total Top 12top10
: Total Top 10top6
: Total Top 6top5
: Total Top 5top3
: Total Top 3solo
*
: SPECIAL ALL FIELDS (Default)avgmatchtime
: Avg Match Timeavgmatchtime_
: Avg Match Time %kd
: Kill / Death Ratiokd_
: Kill / Death Ratio %kills
: Killskills_
: Kills %kpg
: Kills Per Matchkpg_
: Kills Per Match %kpm
: Kills Per Minutekpm_
: Kills Per Minute %matches
: Matchesmatches_
: Matches %timeplayed
: Time Playedtimeplayed_
: Time Played %top25
: Top 25top25_
: Top 25 %top12
: Top 12top12_
: Top 12 %top10
: Top 10top10_
: Top 10 %top6
: Top 6top6_
: Top 6 %top5
: Top 5top5_
: Top 5 %top3
: Top 3top3_
: Top 3 %wins
: Winswins_
: Wins %duo
*
: SPECIAL ALL FIELDS (Default)avgmatchtime
: Avg Match Timeavgmatchtime_
: Avg Match Time %kd
: Kill / Death Ratiokd_
: Kill / Death Ratio %kills
: Killskills_
: Kills %kpg
: Kills Per Matchkpg_
: Kills Per Match %kpm
: Kills Per Minutekpm_
: Kills Per Minute %matches
: Matchesmatches_
: Matches %timeplayed
: Time Playedtimeplayed_
: Time Played %top25
: Top 25top25_
: Top 25 %top12
: Top 12top12_
: Top 12 %top10
: Top 10top10_
: Top 10 %top6
: Top 6top6_
: Top 6 %top5
: Top 5top5_
: Top 5 %top3
: Top 3top3_
: Top 3 %wins
: Winswins_
: Wins %squad
*
: SPECIAL ALL FIELDS (Default)avgmatchtime
: Avg Match Timeavgmatchtime_
: Avg Match Time %kd
: Kill / Death Ratiokd_
: Kill / Death Ratio %kills
: Killskills_
: Kills %kpg
: Kills Per Matchkpg_
: Kills Per Match %kpm
: Kills Per Minutekpm_
: Kills Per Minute %matches
: Matchesmatches_
: Matches %timeplayed
: Time Playedtimeplayed_
: Time Played %top25
: Top 25top25_
: Top 25 %top12
: Top 12top12_
: Top 12 %top10
: Top 10top10_
: Top 10 %top6
: Top 6top6_
: Top 6 %top5
: Top 5top5_
: Top 5 %top3
: Top 3top3_
: Top 3 %wins
: Winswins_
: Wins %/overlay/seige/{platform}/{username}/?[fields={field-list}]
pc
: PCxbl
: XBOXpsn
: PLAYSTATION
NOTE:
Progress Bars (Any of the_
fields for percentages) are not currently enabled due to an issue with the progress bar rendering incorrectly.
Values that are
0
will not render, unless they are explicitly set in the fields parameter.
This should be a comma (,
), pipe (|
), or semi-colon (;
), separated list
*
: SPECIAL ALL FIELDS (Default)wins
: Winswins_
: Wins %season_wins
: Season Winsseason_losses
: Season Lossesseason
: Seasonlosses
: Losseskills
: Killsdeaths
: Deathskd
: Kill / Death Ratiotimeplayed
: Time Playedranked_wins
: Winsranked_wins_
: Wins %ranked_wins
: Winsranked_wins_
: Wins %ranked_losses
: Lossesranked_kills
: Killsranked_deaths
: Deathsranked_kd
: Kill / Death Ratioranked_timeplayed
: Time Playedlevel
: Progression Levelxp
: Progression XPrank
: Rank/overlay/overwatch/{platform}/{username}/[region]?[fields={field-list}]
pc
: PCxbl
: XBOXpsn
: PLAYSTATION
NOTE:
Progress Bars (Any of the_
fields for percentages) are not currently enabled due to an issue with the progress bar rendering incorrectly.
Values that are
0
will not render, unless they are explicitly set in the fields parameter.
This should be a comma (,
), pipe (|
), or semi-colon (;
), separated list
*
: SPECIAL ALL FIELDS (Default)total_wins
: Total Winslevel
: Levelprestige
: Prestigerating
: Ratingwins
: Casual Winsdamagedone
: Casual Damage Done Avgdeaths
: Casual Deaths Avgeliminations
: Casual Eliminations Avgfinalblows
: Casual Final Blows Avghealingdone
: Casual Healing Done Avgobjectivekills
: Casual Objective Kills Avgkills
: Casual Killsmedals
: Casual Total Medalsmedals_bronze
: Casual Bronze Medalsmedals_silver
: Casual Silver Medalsmedals_gold
: Casual Gold Medalsmatches
: Casual Matchesranked_damagedone
: Ranked Damage Done Avgranked_deaths
: Ranked Deaths Avgranked_eliminations
: Ranked Eliminations Avgranked_finalblows
: Ranked Final Blows Avgranked_healingdone
: Ranked Healing Done Avgranked_objectivekills
: Ranked Objective Kills Avgranked_kills
: Ranked Killsranked_medals
: Ranked Total Medalsranked_medals_bronze
: Ranked Bronze Medalsranked_medals_silver
: Ranked Silver Medalsranked_medals_gold
: Ranked Gold Medalsranked_matches
: Ranked Matchesranked_wins
: Ranked WinsTN_POLL_DELAY
: Delay in seconds to poll for stats. (Default 60)TN_FORTNITE_API_KEY
: Fortnite Tracker API Key See documentation to create API Key
TN_PUBG_API_KEY
: PUBG Tracker API Key See documentation to create API Key
You can change the colors of the labels and values by using query parameters
.
colors.label=red-400
colors.value=red-400
Example:
/overlay/fortnite/pc/my-fn-user-name/solo?colors.label=red-400&colors.value=red-400
For a list of the colors that are supported, look at the color list here. The value after .mdl-color--
is the value that is used.
OBS allows you to provide custom CSS with the browser source. Here are the CSS Selectors to use to customize it further.
/* Stat label and value container */
h3.info {
}
/* Stat Label */
h3.info .label {
}
/* Stat Value */
h3.info .value {
}
Here is an example of using a custom font for the labels and values:
/* MAKE SURE THIS IS AT THE TOP OF THE CSS BOX */
/* This will import a custom font from Google Fonts (https://fonts.google.com) */
@import url('https://fonts.googleapis.com/css?family=Permanent+Marker');
/* this can be anywhere in the box */
* {
font-family: 'Permanent Marker' !important;
}
Unmodified Font
Custom Font
Deploy to Heroku
link belowherokuapp.com
url in OBS as a Browser Source
using the endpoints above.After deploying, you can manage the app in Heroku to set up automatic deployments, and it will automatically deploy updates when the code is changed.
The conainer exposes port 3000. -P
will map the port on the host.
$ docker build --pull --tag camalot/obs-gamestats -f "./Dockerfile" .
$ docker run -d -P \
--restart unless-stopped \
--name "obs-gamestats" \
-e TN_FORTNITE_API_KEY="${TN_FORTNITE_API_KEY}" \
-e TN_POLL_DELAY="${TN_FORTNITE_POLL_DELAY}" \
-t camalot/obs-gamestats
.env
file in the obs-gamestats
directory.TN_FORTNITE_API_KEY=<you-fortnitetracker-api-key>
TN_POLL_DELAY=60
$ npm install
$ npm start