Skip to content
This repository has been archived by the owner on Sep 1, 2024. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
… into source
  • Loading branch information
adircoh committed Jul 9, 2024
2 parents 43fa46b + e98cbf6 commit 271a314
Show file tree
Hide file tree
Showing 58 changed files with 627 additions and 426 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ pages/status/helldivers-2.mdx
pages/status/content-warning.mdx
pages/status/manor-lords.mdx
pages/status/hades2.mdx
pages/status/wuthering-waves.mdx
pages/status/league-of-legends-public-beta-arena.mdx
pages/status/teamfight-tactics-public-beta.mdx
pages/status/call-of-duty-warzone-2-0.mdx
Expand Down
2 changes: 1 addition & 1 deletion engine
Submodule engine updated 1 files
+1 −1 docusaurus.config.js
17 changes: 17 additions & 0 deletions pages/api/changelogs/electron-platform/ow-electron/v28.3.2.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
id: v28.3.2
image: "/img/embed/changelogs.jpg"
title: "Version 28.3.2"
sidebar_custom_props:
tags:
overwolf_platform: false
electron_platform: true
---

## Platform

- Updated the underlying [electron](https://www.npmjs.com/package/electron/v/28.3.3) version to [**`28.3.3`**](https://www.npmjs.com/package/electron/v/28.3.3).

## Sub-Version Summary

- [`28.3.2`](https://www.npmjs.com/package/@overwolf/ow-electron/v/28.3.2) - Initial version.
2 changes: 1 addition & 1 deletion pages/api/extensions/current.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -216,4 +216,4 @@ SHA256 | string | An `SHA256` hash of the email address |
MD5 | string | An `MD5` hash of the email address |


[hashed-email]: /start/monetize-your-app/experimental/user-identity.mdx
[hashed-email]: /start/monetize-your-app/user-identity.mdx
28 changes: 28 additions & 0 deletions pages/api/general/subscriptions-api/subscriptions-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ The following is a list of endpoints exposed by the Overwolf Subscriptions API,

**For live examples of the different endpoints, please check out the [Tebex Subs Sample App](https://github.com/overwolf/tebex-subs-sample).**

**For live examples of the new categories and upgrade/downgrade endpoint, please check out the [Tebex Subs Sample App on the “upgrade/downgrade-develop” branch](https://github.com/overwolf/tebex-subs-sample/tree/upgrade/downgrade-develop).**

### Checkout

> Generates a checkout page for a specific subscription plan (package).
Expand All @@ -42,6 +44,32 @@ import Packages from '@site/../pages/endpoints/subscriptions-api.overwolf.com/_p

<Packages/>

### Categories

> Returns a list of all categories and their associated packages available for a specific store in this App.
import Categories from '@site/../pages/endpoints/subscriptions-api.overwolf.com/_categories.mdx'

<Categories/>

### Upgrade/Downgrade

> Updates the package tier of a subscription package within a specific category for this App.
import UpgradeDowngrade from '@site/../pages/endpoints/subscriptions-api.overwolf.com/_pgrade-downgrade.mdx'

<UpgradeDowngrade/>

#### Notes for Using the Categories and Upgrade/Downgrade Endpoints:

* To utilize the new `Categories` endpoint, you **must** create a new category and packages for that category in your Tebex store.
* If you have users subscribed to the "old" package type (which cannot be upgraded or downgraded), please implement the following UI changes in the subscription settings section of your app:
* inform the user that he can’t switch between plans and must cancel his current plan first.

* Allow the user to cancel his subscription and only then allow him to switch to the new package type that allows for Upgrading/Downgrading their package tier.

* When subscribing to the new package type, an initial purchase must be made using the `Checkout` endpoint. After the initial subscription, you can query the new `Categories` endpoint to check if the user has an active tier (subscription), and then display the Update/Downgrade buttons accordingly using the `prorate_price`.

## Deeplinks

The following is a list of deeplinks used by the Overwolf Subscriptions API, to handle calls back to the application.
Expand Down
6 changes: 3 additions & 3 deletions pages/api/live-game-data/supported-games/counter-strike-2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -352,23 +352,23 @@ Data Example:
Data Example:

```json
{"info":{"live_data":{"kills":10}},"feature":"match_info"}
{"info":{"match_info":{"kills":10}},"feature":"match_info"}
```

#### *deaths* note

Data Example:

```json
{"info":{"live_data":{"deaths":5}},"feature":"match_info"}
{"info":{"match_info":{"deaths":5}},"feature":"match_info"}
```

#### *assists* note

Data Example:

```json
{"info":{"live_data":{"assists":1}},"feature":"match_info"}
{"info":{"match_info":{"assists":1}},"feature":"match_info"}
```

#### *elo_points* note
Expand Down
12 changes: 12 additions & 0 deletions pages/api/live-game-data/supported-games/overwatch-2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ game_state | game_info | The current state of the game.|See [notes](#game_st
game_mode | game_info | Currently played game-mode.|See [notes](#game_mode-note)| 229.0 |
battle_tag | game_info | Player's battelnet tag | See [notes](#battle_tag-note) | 229.2 |
game_type | game_info | The type of the current played game | See [notes](#game_type-note) | 252.0 |
game_queue_type | match_info | The type of the current queue | See [notes](#game_queue_type-note) | 256.1 |

#### *game_state* note:

Expand Down Expand Up @@ -155,6 +156,17 @@ Data Example:
```json
{"feature":"game_info","category":"match_info","key":"game_type","value":"SKIRMISH"}
```
#### *game_queue_type* note:

possible game_queue_type values:
* OPEN_QUEUE
* ROLE_QUEUE

Data Example:

```json
{"feature":"game_info","category":"match_info","key":"game_queue_type","value":"OPEN_QUEUE"}
```

## `match_info`

Expand Down
2 changes: 1 addition & 1 deletion pages/api/media/replays/replays.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -550,7 +550,7 @@ Replay video options.
| keep_game_capture_on_lost_focus | bool | Keep capturing the game when the game loses focus (i.e do not show "Be Right Back"). Note: if game is minimized, BRB will be shown. | 0.180 |
| color_space | string &#124; [overwolf.streaming.enums.VideoColorSpec](../streaming#videocolorspec-enum) | The default value is: **Rec709**. | 0.254 |
| color_format | string &#124; [overwolf.streaming.enums.VideoColorFormat](../streaming#videocolorformat-enum) | The default value is: **NV12**. | 0.254 |
| fragmented_video_file | bool | Splits the video to smaller fragments which allows for the immediate start of video playback after downloading only a small initial segment. <br/>Defaults to **true**. | 0.254 |
| fragmented_video_file | bool | Splits the video to smaller fragments which allows for the immediate start of video playback after downloading only a small initial segment. <br/>Defaults to **false**. | 0.254 |

#### base_frame_size_source notes

Expand Down
2 changes: 1 addition & 1 deletion pages/api/streaming/streaming.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -789,7 +789,7 @@ Stream video options.
| disable_auto_shutdown_on_game_exit | bool | Should the recording engine stay running even after the relevant game was closed. | 0.236 |
| color_space | string &#124; [overwolf.streaming.enums.VideoColorSpec](#videocolorspec-enum) | The default value is: **Rec709**. | 0.254 |
| color_format | string &#124; [overwolf.streaming.enums.VideoColorFormat](#videocolorformat-enum) | The default value is: **NV12**. | 0.254 |
| fragmented_video_file | bool | Splits the video to smaller fragments which allows for the immediate start of video playback after downloading only a small initial segment. <br/>Defaults to **true**. | 0.254 |
| fragmented_video_file | bool | Splits the video to smaller fragments which allows for the immediate start of video playback after downloading only a small initial segment. <br/>Defaults to **false**. | 0.254 |

## VideoColorSpec enum

Expand Down
61 changes: 61 additions & 0 deletions pages/endpoints/subscriptions-api.overwolf.com/_categories.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
```yaml
Request Type: 'GET'
Hostname: 'https://subscriptions-api.overwolf.com'
Path: '/subscriptions/${STORE_ID}/categories'
Search Params:
extensionId: string
Headers:
Authorization: 'Bearer ${token}'

Result: Array of:
name: 'string'
description: 'string'
active_tier?:
tier_id: 'number'
package:
base_price: 'number'
category:
id: 'number'
name: 'string'
created_at: 'string'
description: 'string'
disable_gifting: 'boolean'
disable_quantity: 'boolean'
discount: 'number'
expiration_date?: 'string'
id: 'number'
image?: 'string'
name: 'string'
sales_tax: 'number'
total_price: 'number'
type: 'subscription' | 'single'
updated_at: 'string'
prorate_price?: 'number'
currency: 'string'
active: 'boolean'
created_at: 'string'
next_payment_date: 'string'
status:
id: 'string'
description: 'string'
packages: Array of:
base_price: 'number'
category:
id: 'number'
name: 'string'
created_at: 'string'
description: 'string'
disable_gifting: 'boolean'
disable_quantity: 'boolean'
discount: 'number'
expiration_date?: 'string'
id: 'number'
image?: 'string'
name: 'string'
sales_tax: 'number'
total_price: 'number'
type: 'subscription' | 'single'
updated_at: 'string'
prorate_price?: 'number'
currency: 'string'
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
```yaml
Request Type: 'PUT'
Hostname: 'https://subscriptions-api.overwolf.com'
Path: '/subscriptions/${STORE_ID}'
Search Params:
extensionId: string
Headers:
Authorization: 'Bearer ${token}'

Body:
{
// The tierId from the activeTier object received by the get categories method.
"tierId": number,
// The packageId you want to change to.
"packageId": number,
// Whether to upgrade or downgrade to a package.
"type": "upgrade" | "downgrade"
}
```
6 changes: 2 additions & 4 deletions pages/legal/developer-privacy-policy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_custom_props:
electron_platform: false
---

***Last Updated: March 19, 2024***
***Last Updated: July 09, 2024***

This privacy policy (“**Privacy** **Policy**” or “**Policy**”) describes how
**Overwolf Ltd.** (“**Overwolf**”, “**we**”, “**us**”, or “**our**”) collect,
Expand Down Expand Up @@ -42,10 +42,8 @@ that is collected and processed when they engage and use the Developer's applica
and services. The processing of the such end user's data shall be subject of the
terms of Overwolf Data Processing Agreement between Overwolf and the Developer.

import VendorCount from './vendor-count';

_Overwolf participates in the IAB Transparency & Consent Framework and complies
with its Specifications and policies. Overwolf's CMP number within the framework is <VendorCount />._
with its Specifications and policies. Overwolf's CMP number within the framework is 246._

_Overwolf's use and transfer of information received from Google APIs to any other
app will adhere to [Google API Services User Data Policy](http://strip/?q=http%3A%2F%2Fstrip%2F%3Fq%3Dhttps%253A%252F%252Fdevelopers.google.com%252Fterms%252Fapi-services-user-data-policy%2523additional_requirements_for_specific_api_scopes),
Expand Down
2 changes: 1 addition & 1 deletion pages/start/getting-started/app-creation-process.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,6 @@ But remember, the journey doesn't end once you're ready to go live. In fact, thi
Now that your app has is ready for release, there are many things you can do from here:
- Improve your app - More features, more improvements, better UX, better monetization, improved stability, better usability, the sky's the limit!
- Build and grow your community - You know what's better than one user? A whole community of users, all of which are invested in your app!
- Promote your app - No matter how great your app is, it would be sad if nobody knew about it. We can help you fix that, be it through planning and advice, or even [advertising it directly](/topics/request-a-service/promoting-your-app)!
- Promote your app - No matter how great your app is, it would be sad if nobody knew about it. We can help you fix that, be it through planning and advice, or even [advertising it directly](/topics/request-a-service/app-marketing-promotions)!

[submit]: /start/submit-your-app
16 changes: 0 additions & 16 deletions pages/start/getting-started/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,24 +24,8 @@ The next generation of games is just one click away. Let’s get started!

</div>

<SkipMe>
Overwolf Apps - Applications created by independent creators/teams, utilizing Overwolf's Frameworks to integrate with some of the biggest games out there,
in order to truly bring out the most legendary gaming experiences possible!

Using Overwolf's game integrations and overlay capabilities, these apps help gamers play smarter, better, and have more fun,
by creating useful information and tools, always just a single click away.
</SkipMe>

<VideoBox videoID={'1yMAR0JK1XA'} fullWidth={false} />

<SkipMe>

<div className="center-text">
<p>Sounds interesting? Then let's <a href="getting-started/app-creation-basics" title="Get Started">Get started!</a></p>
</div>

</SkipMe>

## Supported Frameworks

<Tabs groupId="frameworks">
Expand Down
2 changes: 1 addition & 1 deletion pages/start/monetize-your-app/advertising/_category_.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
position: 50
position: 0
collapsed: false
Loading

0 comments on commit 271a314

Please sign in to comment.