Our Most Powerful SDKs
Right at Your Fingertips

This is a test description for Android SDK, but in JP

Photon Android NDK SDK
------------------------------------------

Photon is the world's #1 independent networking engine and multiplayer platform - Fast, reliable, scalable.

Use the Photon Android NDK SDK to easily add multiplayer to your games.
Run them in the global Photon Cloud or host your own Photon Servers.
Match your players to a shared game session (called "room") and transfer messages synchronously, in real-time, between connected players across platforms.
All client SDKs can interact with each other, no matter if iOS, Android, web, console or standalone.


Package Contents
------------------------------------------

/Chat-cpp              - Photon Chat sources
/Common-cpp            - common sources
/doc                   - Release history, API documentation
/LoadBalancing-cpp     - Photon Realtime sources
/Photon-cpp            - common Photon sources
/PhotonVoice-cpp       - Photon Voice sources
/Demos

	/demo_basics:
	The demo client is basically a 'Hello World'. So it's the best place to start if you are new to the SDK.

	/demo_chat:
	The demo shows a basic way of using the Photon Chat API with a graphical user interface. This uses the Cocos2D-x graphics engine.

	/demo_loadbalancing:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game.

	/demo_memory:
	This demo displays Photon's asynchronous turnbased features in a game of Memory. This uses the Cocos2D-x graphics engine.

	/demo_particle:
	The demo client connects to a master server and shows the random matchmaking mechanism, how to create a room and how to send and receive events within a running game.
	Players move 'their' blocks around and the positions are updated in realtime between clients. The UI shows areas of interest when activated. This uses the Cocos2D-x graphics engine.

	/demo_typeSupport:
	This demo displays the proper use of Photon's serializable data types.


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

All C++ based Photon SDKs are compatible with Cocos2d-x off the shelf! Find the SDKs you can gear it up with linked to below.

Photon SDK for Scirra Construct 2 readme.  
(C) Exit Games GmbH 2016

Overview 
----------------------------------------------------------------------------------------------------
Photon SDK contains Scirra Construct 2 plugins exposing underlying Photon Javascript library 
functionality:
- Photon Realtime Plugin allows to develop multiplayer games with clients communicating through 
  Photon Cloud or self-hosted Photon Server. 
  Follow https://www.photonengine.com/en/Realtime for info on Photon Realtime.
- Photon Chat Plugin adds chat functionality to your game.
  Follow https://www.photonengine.com/en/Chat for info on Photon Chat.

Installation
----------------------------------------------------------------------------------------------------
- Drag and drop photon.c2addon and photon-chat.c2addon files into the Construct 2 window. 
  See Construct 2 documentation on plugins installation details.
- Register a new realtime app at https://www.photonengine.com/en/Dashboard/Realtime 
- Register a new chat app at https://www.photonengine.com/en/Dashboard/Chat

Running demos
----------------------------------------------------------------------------------------------------
- Find Photon object in project tree and set its AppId property to application id value from dashboard.
- Select Main layout.
- Run the application. Editor will open browser page. Copy url and open it in new browser pages.
- Check browser console for helpful info.
- Pool demo: all clients automatically join single room, each spawns the fish and notifies others 
  with fish positions. Click on the pool makes owned fish move to the click location.
- Test demo: automatically joins or creates new room. Pressing Leave will bring the client to the lobby 
  where client can create new room or join existing from list. Also, test event firing is available 
  inside the room (check other clients log for events receive report).
- Chat demo: start 2 or more clients. For every client, choose user id and press Connect. 
  When client is connected to front end, enter channel names separated by comma and press Subscribe. 
  Select channel in list, enter message and press Publish. Or specify destination user id and send 
  private message by pressing Send.

Package Contents
----------------------------------------------------------------------------------------------------
- license.txt         - the license terms
- readme.txt          - this readme text
- release_history.txt - changelog
- photon.c2addon      - Photon Realtime Plugin
- photon-chat.c2addon - Photon Chat Plugin
- demo-test.capx      - application for testing Photon Realtime features
- demo-pool.capx      - Realtime demo application
- demo-chat.capx      - Chat demo application

Documentation
----------------------------------------------------------------------------------------------------
There is no Photon Construct 2 Plugin specific documentation or tutorials available currently.  
General documentation on Photon Realtime: http://doc.photonengine.com/en-us/realtime/current/getting-started/realtime-intro  
Photon Chat documentation: http://doc.photonengine.com/en-us/chat/current/getting-started/chat-intro  
Underlying Photon Javascript API reference: http://doc-api.photonengine.com/en/javascript/current  

Demos included in the package show clear how plugin works and may be used as tempaltes for real projects.  
Short descriptions available for each plugin item in editor.

Download
----------------------------------------------------------------------------------------------------
The latest version of Photon Plugin for Scirra Construct 2 can be found at
https://www.photonengine.com/Realtime/Download

Contact
----------------------------------------------------------------------------------------------------
To get in touch with other Photon developers and our engineers, visit our Developer Forum:
http://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com  

Photon Corona SDK
------------------------------------------

The Photon Lua library provides a simple to use framework to access the Photon Server
and the Photon Cloud from Lua scripts. 
Cross platform communication is possible, so Lua clients can send events to DotNet or
native clients. This might require some adjustments on other platforms. This is shown 
by the "Particle" demo.

The LoadBalancing API is compatible with the Photon Cloud and servers you host yourself, 
using the Photon Server SDK.

Find the latest Photon downloads at https://www.photonengine.com/en-us/realtime/download

The reference documentation is in this package.
More documentation for Photon development is available at http://doc.photonengine.com/.


Package Contents
------------------------------------------

license.txt           - the license terms
install.txt           - installation info
readme.txt            - this readme text
release_history.txt   - release history
doc                  - the Lua API reference documentation
lib                  - library
src/demo-console/autochat.lua                  - console automatic chat test using Lite
src/demo-console/autochat-lb.lua               - console automatic chat test using Cloud suport
src/demo-helloworld-cloud/main.lua             - Corona simple test using Lite
src/demo-particle/main.lua                     - Corona demo showing more of the API's features (Cloud, cross platform)
src/demo-particle/console.lua                  - console variant of particle demo
src/demo-memory/main.lua                       - Corona demo showing Photon Turnbased features
src/demo-chat/main.lua                         - Corona demo showing Photon Chat API's features

	
	
Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

Photon Realtime SDK for .Net (non-Unity) - Readme
www.photonengine.com


Content
----------------------------------------------------------------------------------------------------
	- Photon Client libraries (.Net Standard 2.0, "non-Unity")
	- Realtime API (C# source)
	- Chat API (C# source)



Versions
----------------------------------------------------------------------------------------------------
	The v5 version includes several breaking API changes compared to v4.
	Pick the one fitting to your project, unless you deliberately want to update. 
	Breaking changes ahead! Backup your project.
	
	v4 is used by PUN 2, Fusion, Quantum 2 and Voice 2
	v5 is used by Quantum 3. A special Voice 2 version for Quantum 3 is available on request.



Documentation
----------------------------------------------------------------------------------------------------
    The API reference is included in this package as CHM file.
    Find the manuals, tutorials, API reference and more online.

    http://doc.photonengine.com



Running the Demos
----------------------------------------------------------------------------------------------------
    Our demos are built for the Photon Cloud for convenience.
    The service is free for development. Signing up is instant and without obligation.

    https://dashboard.photonengine.com

    Each application type has it's own AppId (e.g Realtime and Chat).
    This must be copied into the clients: Update the property "AppId" in the source files of the demos.

    You will find specific sections of the Dashboard per application type.


    Alternatively host the Photon Server yourself. The AppId is not needed in that case.
    https://www.photonengine.com/sdks#server

    How to start the server:
    https://doc.photonengine.com/en-us/onpremise/current/getting-started/photon-server-in-5min



Chat Documentation
----------------------------------------------------------------------------------------------------
    http://doc.photonengine.com/en/chat
    http://forum.photonengine.com



Implementing Photon Chat
----------------------------------------------------------------------------------------------------
    Photon Chat is separated from other Photon Applications, so it needs it's own AppId.
    Our demos usually don't have an AppId set.
    In code, find "<your appid>" to copy yours in. In Unity, we usually use a component
    to set the AppId via the Inspector. Look for the "Scripts" GameObject in the scenes.

    Register your Chat Application in the Dashboard:
    https://dashboard.photonengine.com

    The class ChatClient and the interface IChatClientListener wrap up most important parts
    of the Chat API. Please refer to their documentation on how to use this API.
    More documentation will follow.

    If you use Unity, copy the source from the ChatApi folder into your project.



Unity Notes
----------------------------------------------------------------------------------------------------
    If you don't use Unity, skip this chapter.


    We assume you're using Unity 2017.4 or newer.
    The demos are prepared to export for Standalone only.

    The SDK contains an "Assets" folder. To import Photon into your project, copy the content
    into your project's Asset folder. You may need to setup the DLLs in the Inspector to export
    for your platform(s).


    Currently supported export platforms are:
        Standalone (Windows, OSx and Linux)
        WebGL
        iOS
        Android
        Windows 10 UWP
        Consoles			(see: https://doc.photonengine.com/en-us/pun/current/consoles)


    All Unity projects must use ExitGames.Client.Photon.Hashtable!
    This provides compatibility across all exports.
    Add this to your code (at the beginning), to resolve the "ambiguous Hashtable" declaration:
    using Hashtable = ExitGames.Client.Photon.Hashtable;


    How to add Photon to your Unity project:
    1) The Unity SDK contains an "Assets" folder.
       Copy the content into your project's Assets folder.
    2) Make sure to have the following line of code in your scripts to make it run in background:
       Application.runInBackground = true; //without this Photon will loose connection if not focussed
    3) Add "using Hashtable = ExitGames.Client.Photon.Hashtable;" to your scripts. Without quotation.
    5) If you host a Photon Server change the server address in the client. "localhost:5055" won't work on device.
    6) Implement OnApplicationQuit() and disconnect the client when the app stops.

Photon Emscripten SDK
------------------------------------------

Photon is the world's #1 independent networking engine and multiplayer platform — Fast, reliable, scalable.

Use the Photon Emscripten SDK to easily add multiplayer to your games.
Run them in the global Photon Cloud or host your own Photon Servers.
Match your players to a shared game session (called "room") and transfer messages synchronously, in real-time, between connected players across platforms.
All client SDKs can interact with each other, no matter if iOS, Android, web, console or standalone.


Package Contents
------------------------------------------

/Chat-cpp              - Photon Chat sources
/Common-cpp            - common sources
/doc                   - Release history, API documentation
/LoadBalancing-cpp     - Photon Realtime sources
/Photon-cpp            - common Photon sources
/Demos

	/demo_loadbalancing:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game.

	/shared:
	This folder holds all applications used by various demos.


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

Photon Game Core SDK
------------------------------------------

Please contact the console producer on additional setup information or required authorization.

Photon is the world's #1 independent networking engine and multiplayer platform — Fast, reliable, scalable.

Use the Photon SDK to easily add multiplayer to your games.
Run them in the global Photon Cloud or host your own Photon Servers.
Match your players to a shared game session (called "room") and transfer messages synchronously, in real-time, between connected players across platforms.
All client SDKs can interact with each other, no matter if iOS, Android, web, console or standalone.


Package Contents
------------------------------------------

/Chat-cpp              - Photon Chat sources
/Common-cpp            - common sources
/doc                   - Release history, API documentation
/LoadBalancing-cpp     - Photon Realtime sources
/Photon-cpp            - common Photon sources
/PhotonVoice-cpp       - Photon Voice sources
/Demos

	/demo_loadbalancing:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game.


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

Photon Game Core Unity Plugin
------------------------------------------

You must be logged in and a verified Game Core developer to download this Unity addon.

If the download is blocked, get in touch with us.
Mail to: [email protected] to get your Photon account setup.


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

Photon iOS SDK
------------------------------------------

Photon is the world's #1 independent networking engine and multiplayer platform — Fast, reliable, scalable.

Use the Photon iOS SDK to easily add multiplayer to your games.
Run them in the global Photon Cloud or host your own Photon Servers.
Match your players to a shared game session (called "room") and transfer messages synchronously, in real-time, between connected players across platforms.
All client SDKs can interact with each other, no matter if iOS, Android, web, console or standalone.


Package Contents
------------------------------------------

/Chat-cpp              - Photon Chat sources
/Chat-objc             - Photon Chat sources Objective-C
/Common-cpp            - common sources
/Common-objc           - common sources Objective-C
/doc                   - Release history, API documentation
/LoadBalancing-cpp     - Photon Realtime sources
/LoadBalancing-objc    - Photon Realtime sources Objective-C
/Photon-cpp            - common Photon sources
/Photon-objc           - common Photon sources Objective-C
/PhotonVoice-cpp       - Photon Voice sources
/Demos

	/demo_basics:
	The demo client is basically a 'Hello World'. So it's the best place to start if you are new to the SDK. It is implemented in C++.

	/demo_chat:
	The demo shows a basic way of using the Photon Chat API with a graphical user interface. This uses the Cocos2D-x graphics engine and is implemented in C++.

	/demo_chat_objc:
	The demo shows a basic way of using the Photon Chat API within a console. It is implemented in Objective-C.

	/demo_iPhone_realtime_objc:
	The demo client connects to a Photon Server running the Lite application and and shows how to create a room and how to send and receive events within a running game.
	Players move 'their' blocks around and the positions are updated in realtime between clients. It uses the Cocos2D-iPhone graphics engine and is implemented in Objective-C.

	/demo_loadBalancing:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game. It is implemented in C++.

	/demo_loadBalancing_objc:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game. It is implemented in Objective-C.

	/demo_loadBalancing_swift:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game. It is implemented in Swift.

	/demo_memory:
	This demo displays Photon's asynchronous turnbased features in a game of Memory. This uses the Cocos2D-x graphics engine. It is implemented in C++.

	/demo_particle:
	The demo client connects to a master server and shows the random matchmaking mechanism, how to create a room and how to send and receive events within a running game.
	Players move 'their' blocks around and the positions are updated in realtime between clients. The UI shows areas of interest when activated. This uses the Cocos2D-x graphics engine.
	It is implemented in C++.

	/demo_typeSupport:
	This demo displays the proper use of Photon's serializable data types. It is implemented in C++.

	/demo_typeSupport_objc:
	This demo displays the proper use of Photon's serializable data types. It is implemented in Objective-C.


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

Photon JavaScript SDK

(C) Exit Games GmbH 2024


Overview 
----------------------------------------------------------------------------------------------------
The Photon Javascript library provides a simple to use framework to access the Photon Server and the Photon Cloud.
Cross platform communication is possible, so Javascript clients can interact with DotNet or native clients.
The SDK supports 2 APIs.


Realtime (LoadBalancing) API
----------------------------------------------------------------------------------------------------
Allows to access Photon Cloud Realtime service: https://doc.photonengine.com/en-us/realtime/current/getting-started/realtime-intro


Chat API
----------------------------------------------------------------------------------------------------
Allows to access Photon Chat service: https://doc.photonengine.com/en-us/chat/current/getting-started/chat-intro


Documentation
----------------------------------------------------------------------------------------------------
The reference documentation is in this package. Follow links per API above for more documentation for Photon development.


Download
----------------------------------------------------------------------------------------------------
The latest version of Javascript SDK can be found at https://www.photonengine.com/sdks#realtime-sdkrealtimejavascript


Installation
----------------------------------------------------------------------------------------------------
- Extract the Photon Javascript SDK to a location of your choice

- Create an application in https://dashboard.photonengine.com/
  Use Chat for demo-chat-api and Realtime for other demos.
- Set up you application info with a text editor in cloud-app-info.js file found in the demo root folder.
- Optionally for demo-particle and demo-pairs-mc samples, set FbAppId to your Facebook App id 
  in cloud-app-info.js for Facebook login. Place your HTML5 / JavaScript client code on one of 
  App Domains specified in your Facebook App settings. This required for proper Facebook Login 
  button work.
- Open default.html in browser.


Contact
----------------------------------------------------------------------------------------------------
To get in touch with other Photon developers and our engineers, Join our Discord Server https://dashboard.photonengine.com/account/profile
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames and our blog http://blog.photonengine.com


Package Contents
----------------------------------------------------------------------------------------------------
- license.txt         - the license terms
- readme.txt          - readme text
- release_history.txt - release history
- /doc                - the JavaScript API reference documentation
- /lib                - Photon JavaScript libraries
  -  /photon.js              - Photon Realtime library
  -  /photon.min.js          - minimized version
  -  /photon-em.js           - Photon Realtime Emscripten library (binary protocol)
  -  /photon-em.min.js       - minimized version
  -  /photon.d.ts            - Photon Realtime Typescript declaration file
- /src    
  -  /demo-loadbalancing     - basic Realtime (LoadBalancing) API demo application
  -  /demo-particle          - demo showing more of the Realtime API's features
  -  /demo-pairs-mc          - Turnbased Realtime application demo
  -  /demo-chat-api          - Chat API demo application

Photon Linux SDK
------------------------------------------

Photon is the world's #1 independent networking engine and multiplayer platform — Fast, reliable, scalable.

Use the Photon Linux SDK to easily add multiplayer to your games.
Run them in the global Photon Cloud or host your own Photon Servers.
Match your players to a shared game session (called "room") and transfer messages synchronously, in real-time, between connected players across platforms.
All client SDKs can interact with each other, no matter if iOS, Android, web, console or standalone.


Package Contents
------------------------------------------

/Chat-cpp              - Photon Chat sources
/Common-cpp            - common sources
/doc                   - Release history, API documentation
/LoadBalancing-cpp     - Photon Realtime sources
/Photon-cpp            - common Photon sources
/PhotonVoice-cpp       - Photon Voice sources
/Demos

	/demo_basics:
	The demo client is basically a 'Hello World'. So it's the best place to start if you are new to the SDK.

	/demo_chat:
	The demo shows a basic way of using the Photon Chat API in a console.

	/demo_loadBalancing:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game.

	/demo_particle:
	The demo client connects to a master server and shows the random matchmaking mechanism, how to create a room and how to send and receive events within a running game.
	Blocks are being moved automatically and the positions are updated in realtime between clients. This is a console application.

	/demo_typeSupport:
	This demo displays the proper use of Photon's serializable data types.


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

Photon Mac OS X SDK
------------------------------------------

Photon is the world's #1 independent networking engine and multiplayer platform — Fast, reliable, scalable.

Use the Photon Mac OS X SDK to easily add multiplayer to your games.
Run them in the global Photon Cloud or host your own Photon Servers.
Match your players to a shared game session (called "room") and transfer messages synchronously, in real-time, between connected players across platforms.
All client SDKs can interact with each other, no matter if iOS, Android, web, console or standalone.


Package Contents
------------------------------------------

/Chat-cpp              - Photon Chat sources
/Chat-objc             - Photon Chat sources Objective-C
/Common-cpp            - common sources
/Common-objc           - common sources Objective-C
/doc                   - Release history, API documentation
/LoadBalancing-cpp     - Photon Realtime sources
/LoadBalancing-objc    - Photon Realtime sources Objective-C
/Photon-cpp            - common Photon sources
/Photon-objc           - common Photon sources Objective-C
/PhotonVoice-cpp       - Photon Voice sources
/Demos

	/demo_basics:
	The demo client is basically a 'Hello World'. So it's the best place to start if you are new to the SDK. It is implemented in C++.

	/demo_chat:
	The demo shows a basic way of using the Photon Chat API within a console. It is implemented in C++.	

	/demo_loadBalancing:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game. It is implemented in C++.

	/demo_loadBalancing_objc:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game. It is implemented in Objective-C.

	/demo_loadBalancing_swift:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game. It is implemented in Swift.

	/demo_particle:
	The demo client connects to a master server and shows the random matchmaking mechanism, how to create a room and how to send and receive events within a running game.
	Blocks are being moved automatically and the positions are updated in realtime between clients. This is a console application which is implemented in C++.

	/demo_typeSupport:
	This demo displays the proper use of Photon's serializable data types. It is implemented in C++.

	/demo_typeSupport_objc:
	This demo displays the proper use of Photon's serializable data types. It is implemented in Objective-C.


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

Photon Nintendo Switch SDK
------------------------------------------

Please contact the console producer on additional setup information or required authorization.

Photon is the world's #1 independent networking engine and multiplayer platform — Fast, reliable, scalable.

Use the Photon SDK to easily add multiplayer to your games.
Run them in the global Photon Cloud or host your own Photon Servers.
Match your players to a shared game session (called "room") and transfer messages synchronously, in real-time, between connected players across platforms.
All client SDKs can interact with each other, no matter if iOS, Android, web, console or standalone.


Package Contents
------------------------------------------

/Chat-cpp              - Photon Chat sources
/Common-cpp            - common sources
/doc                   - Release history, API documentation
/LoadBalancing-cpp     - Photon Realtime sources
/Photon-cpp            - common Photon sources
/PhotonVoice-cpp       - Photon Voice sources
/Demos

	/demo_loadbalancing:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game.


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

Photon PS4 SDK
------------------------------------------

Please contact the console producer on additional setup information or required authorization.

Photon is the world's #1 independent networking engine and multiplayer platform — Fast, reliable, scalable.

Use the Photon SDK to easily add multiplayer to your games.
Run them in the global Photon Cloud or host your own Photon Servers.
Match your players to a shared game session (called "room") and transfer messages synchronously, in real-time, between connected players across platforms.
All client SDKs can interact with each other, no matter if iOS, Android, web, console or standalone.


Package Contents
------------------------------------------

/Chat-cpp              - Photon Chat sources
/Common-cpp            - common sources
/doc                   - Release history, API documentation
/LoadBalancing-cpp     - Photon Realtime sources
/Photon-cpp            - common Photon sources
/PhotonVoice-cpp       - Photon Voice sources
/Demos

	/demo_chat:
	The demo shows a basic way of using the Photon Chat API.

	/demo_loadbalancing:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game.

	/demo_particle:
	The demo client connects to a master server and shows the random matchmaking mechanism, how to create a room and how to send and receive events within a running game.
	Players move 'their' blocks around and the positions are updated in realtime between clients.


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

Photon PS5 SDK
------------------------------------------

Please contact the console producer on additional setup information or required authorization.

Photon is the world's #1 independent networking engine and multiplayer platform — Fast, reliable, scalable.

Use the Photon SDK to easily add multiplayer to your games.
Run them in the global Photon Cloud or host your own Photon Servers.
Match your players to a shared game session (called "room") and transfer messages synchronously, in real-time, between connected players across platforms.
All client SDKs can interact with each other, no matter if iOS, Android, web, console or standalone.


Package Contents
------------------------------------------

/Chat-cpp              - Photon Chat sources
/Common-cpp            - common sources
/doc                   - Release history, API documentation
/LoadBalancing-cpp     - Photon Realtime sources
/Photon-cpp            - common Photon sources
/PhotonVoice-cpp       - Photon Voice sources
/Demos

	/demo_loadbalancing:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game.


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

Photon tvOS SDK
------------------------------------------

Photon is the world's #1 independent networking engine and multiplayer platform — Fast, reliable, scalable.

Use the Photon tvOS SDK to easily add multiplayer to your games.
Run them in the global Photon Cloud or host your own Photon Servers.
Match your players to a shared game session (called "room") and transfer messages synchronously, in real-time, between connected players across platforms.
All client SDKs can interact with each other, no matter if iOS, Android, web, console or standalone.


Package Contents
------------------------------------------

/Chat-cpp              - Photon Chat sources
/Chat-objc             - Photon Chat sources Objective-C
/Common-cpp            - common sources
/Common-objc           - common sources Objective-C
/doc                   - Release history, API documentation
/LoadBalancing-cpp     - Photon Realtime sources
/LoadBalancing-objc    - Photon Realtime sources Objective-C
/Photon-cpp            - common Photon sources
/Photon-objc           - common Photon sources Objective-C
/PhotonVoice-cpp       - Photon Voice sources
/Demos

For demos please look into the iOS SDK: http://doc.photonengine.com/en/realtime/current/sdks-and-api/sdk-ios 


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

Photon Realtime SDK for Unity - Readme
www.photonengine.com


Content
----------------------------------------------------------------------------------------------------
	- Photon Client libraries for Unity (.Net Standard 2.0)
	- Realtime API (C# source)
	- Chat API (C# source)



Versions
----------------------------------------------------------------------------------------------------
	The v5 version includes several breaking API changes compared to v4.
	Pick the one fitting to your project, unless you deliberately want to update. 
	Breaking changes ahead! Backup your project.
	
	v4 is used by PUN 2, Fusion, Quantum 2 and Voice 2
	v5 is used by Quantum 3. A special Voice 2 version for Quantum 3 is available on request.



Documentation
----------------------------------------------------------------------------------------------------
    The API reference is included in this package as CHM file.
    Find the manuals, tutorials, API reference and more online.

    http://doc.photonengine.com



Running the Demos
----------------------------------------------------------------------------------------------------
    Our demos are built for the Photon Cloud for convenience.
    The service is free for development. Signing up is instant and without obligation.

    https://dashboard.photonengine.com

    Each application type has it's own AppId (e.g Realtime and Chat).
    This must be copied into the clients: Update the property "AppId" in the source files of the demos.

    You will find specific sections of the Dashboard per application type.


    Alternatively host the Photon Server yourself. The AppId is not needed in that case.
    https://www.photonengine.com/sdks#server

    How to start the server:
    https://doc.photonengine.com/en-us/onpremise/current/getting-started/photon-server-in-5min



Chat Documentation
----------------------------------------------------------------------------------------------------
    http://doc.photonengine.com/en/chat
    http://forum.photonengine.com



Implementing Photon Chat
----------------------------------------------------------------------------------------------------
    Photon Chat is separated from other Photon Applications, so it needs it's own AppId.
    Our demos usually don't have an AppId set.
    In code, find "<your appid>" to copy yours in. In Unity, we usually use a component
    to set the AppId via the Inspector. Look for the "Scripts" GameObject in the scenes.

    Register your Chat Application in the Dashboard:
    https://dashboard.photonengine.com

    The class ChatClient and the interface IChatClientListener wrap up most important parts
    of the Chat API. Please refer to their documentation on how to use this API.
    More documentation will follow.

    If you use Unity, copy the source from the ChatApi folder into your project.



Unity Notes
----------------------------------------------------------------------------------------------------
    If you don't use Unity, skip this chapter.


    We assume you're using Unity 5.6. or newer.
    The demos are prepared to export for Standalone only.

    The SDK contains an "Assets" folder. To import Photon into your project, copy the content
    into your project's Asset folder. You may need to setup the DLLs in the Inspector to export
    for your platform(s).


    Currently supported export platforms are:
        Standalone (Windows, OSx and Linux)
        WebGL
        iOS
        Android
        Windows 10 UWP
        Consoles			(see: https://doc.photonengine.com/en-us/pun/current/consoles)


    All Unity projects must use ExitGames.Client.Photon.Hashtable!
    This provides compatibility across all exports.
    Add this to your code (at the beginning), to resolve the "ambiguous Hashtable" declaration:
    using Hashtable = ExitGames.Client.Photon.Hashtable;


    How to add Photon to your Unity project:
    1) The Unity SDK contains an "Assets" folder.
       Copy the content into your project's Assets folder.
    2) Make sure to have the following line of code in your scripts to make it run in background:
       Application.runInBackground = true; //without this Photon will loose connection if not focussed
    3) Add "using Hashtable = ExitGames.Client.Photon.Hashtable;" to your scripts. Without quotation.
    5) If you host a Photon Server change the server address in the client. "localhost:5055" won't work on device.
    6) Implement OnApplicationQuit() and disconnect the client when the app stops.

All C++ based Photon SDKs are compatible with the UNREAL ENGINE off the shelf!
Find the SDKs you can gear it up with linked to below. 

This is a demo project for using Photon Realtime on Unreal Engine.
All C++ based Photon SDKs are compatible with the UNREAL ENGINE off the shelf!
Find the SDKs you can gear it up with linked to below. 

Photon Windows SDK
------------------------------------------

Photon is the world's #1 independent networking engine and multiplayer platform — Fast, reliable, scalable.

Use the Photon Windows SDK to easily add multiplayer to your games.
Run them in the global Photon Cloud or host your own Photon Servers.
Match your players to a shared game session (called "room") and transfer messages synchronously, in real-time, between connected players across platforms.
All client SDKs can interact with each other, no matter if iOS, Android, web, console or standalone.


Package Contents
------------------------------------------

/Chat-cpp              - Photon Chat sources
/Common-cpp            - common sources
/doc                   - Release history, API documentation
/LoadBalancing-cpp     - Photon Realtime sources
/Photon-cpp            - common Photon sources
/PhotonVoice-cpp       - Photon Voice sources
/Demos

	/demo_basics:
	The demo client is basically a 'Hello World'. So it's the best place to start if you are new to the SDK.

	/demo_chat:
	The demo shows a basic way of using the Photon Chat API.

	/demo_loadbalancing:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game.

	/demo_memory:
	This demo displays Photon's asynchronous turnbased features in a game of Memory. This uses the Cocos2D-x graphics engine.

	/demo_particle:
	The demo client connects to a master server and shows the random matchmaking mechanism, how to create a room and how to send and receive events within a running game.
	Players move 'their' blocks around and the positions are updated in realtime between clients.

	/demo_typeSupport:
	This demo displays the proper use of Photon's serializable data types.


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

Photon Windows Store SDK
------------------------------------------

Photon is the world's #1 independent networking engine and multiplayer platform — Fast, reliable, scalable.

Use the Photon Windows Store SDK to easily add multiplayer to your games.
Run them in the global Photon Cloud or host your own Photon Servers.
Match your players to a shared game session (called "room") and transfer messages synchronously, in real-time, between connected players across platforms.
All client SDKs can interact with each other, no matter if iOS, Android, web, console or standalone.


Package Contents
------------------------------------------

/Chat-cpp              - Photon Chat sources
/Common-cpp            - common sources
/doc                   - Release history, API documentation
/LoadBalancing-cpp     - Photon Realtime sources
/Photon-cpp            - common Photon sources
/PhotonVoice-cpp       - Photon Voice sources
/Demos

	/demo_loadBalancing:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game.


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

Photon XB1 SDK
------------------------------------------

Please contact the console producer on additional setup information or required authorization.

Photon is the world's #1 independent networking engine and multiplayer platform — Fast, reliable, scalable.

Use the Photon SDK to easily add multiplayer to your games.
Run them in the global Photon Cloud or host your own Photon Servers.
Match your players to a shared game session (called "room") and transfer messages synchronously, in real-time, between connected players across platforms.
All client SDKs can interact with each other, no matter if iOS, Android, web, console or standalone.


Package Contents
------------------------------------------

/Chat-cpp              - Photon Chat sources
/Common-cpp            - common sources
/doc                   - Release history, API documentation
/LoadBalancing-cpp     - Photon Realtime sources
/Photon-cpp            - common Photon sources
/PhotonVoice-cpp       - Photon Voice sources
/Demos

	/demo_loadbalancing:
	The demo client connects to a master server and shows how to create a room, join a random game and how to send and receive events within a running game.


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.

Photon Xbox One Unity Plugin
------------------------------------------

You must be logged in and a verified Xbox One developer to download this Unity addon.

If the download is blocked, get in touch with us.
Mail to: [email protected] to get your Photon account setup.


Contact
------------------------------------------

To get in touch with other Photon developers and our engineers, visit our Developer Forum:
https://forum.photonengine.com  
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames
and our blog at http://blog.photonengine.com/.