Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
| igotcha:technicalguide [2020/04/23 16:23] – [Files] francis | igotcha:technicalguide [2023/08/11 12:18] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 6: | Line 6: | ||
| ===== Visual parts of the software ===== | ===== Visual parts of the software ===== | ||
| ==== The Player ==== | ==== The Player ==== | ||
| + | [{{ igotcha: | ||
| The player is the window where content is displayed. It usually starts fullscreen or at the resolution specified in the CMS. To get the window decoration, exit fullscreen and be able to resize and move this window, press CTRL+i. | The player is the window where content is displayed. It usually starts fullscreen or at the resolution specified in the CMS. To get the window decoration, exit fullscreen and be able to resize and move this window, press CTRL+i. | ||
| Line 18: | Line 19: | ||
| ==== The Manager ==== | ==== The Manager ==== | ||
| - | The manager is the black window with no decoration that sits behind the player. You will see the iGotcha logo top middle, console output scrolling on the bottom left and a hidden close button top right. There is also a pairing ID in the middle in big bold letters. | + | [{{ igotcha: |
| + | The manager is the black window with no decoration that sits behind the player. You will see the iGotcha logo top middle, console output scrolling on the bottom left and a hidden close button top right. There is also a pairing ID in the middle in big bold letters. Manager uses a TCP connection to communicate with the player, default port is 8888 and is defined in the file TCPPort.txt in the work folder. | ||
| You can use the activation ID to register your player on the platform. If you see " | You can use the activation ID to register your player on the platform. If you see " | ||
| Line 34: | Line 36: | ||
| === Manager config window === | === Manager config window === | ||
| + | [{{ igotcha: | ||
| Configuration of player, manager and server can be done here. | Configuration of player, manager and server can be done here. | ||
| Line 100: | Line 103: | ||
| * Sequence.xml : File downloaded from the CMS, contains all files, MD5, addesses, and configurations set on the CMS. | * Sequence.xml : File downloaded from the CMS, contains all files, MD5, addesses, and configurations set on the CMS. | ||
| * TCPPort.txt : TCP port the manager uses to communicate with the player. Default is 8888 | * TCPPort.txt : TCP port the manager uses to communicate with the player. Default is 8888 | ||
| - | === Sequence.xml === | ||
| - | === The contents folder ==== | ||
| ===== Reading the logs ===== | ===== Reading the logs ===== | ||
| + | The logs are pretty straight forward they are divided into two files and separated by day by adding the date after the filename. | ||
| + | They are located in Work/Logs. | ||
| + | |||
| + | Log structure looks like this: | ||
| + | < | ||
| + | There are 5 parts to it, time, flag, Thread, message, process. | ||
| + | * Time is the date in format day-month-year hour: | ||
| + | * Flags are capitalised and can be, '' | ||
| + | * Thread is inside square brackets [] and is the name of the thread writing to the log | ||
| + | * Message is the log message | ||
| + | * Process is in parenthesis () and is the process where the message occured | ||
| + | |||
| + | |||
| + | The logs for the managers are saved in the file named manager_debug.txt and players player_debug.txt | ||
| + | === Common messages and errors === | ||
| + | * Messages like this '' | ||
| + | * Any logs coming from [MainThread-child] should not be blocking and are most often related to system information or device status. | ||
| + | * At first launch, you will get a lot of ''//< | ||
| + | * Websockets state is also logged and should say something along the lines of '' | ||
| + | * Websocket is use for instant messaging between server and client it is not essential for functionality, | ||
| + | * Errors will often dump the C# error log in the message of the log line. They are important to include if you send error logs to the devs team. | ||
| + | * The players logs will have information about what is playing and the timer events setting that triggers various events, mainly changing content. You can trace back errors in playback by looking at these. | ||
| ===== Dependencies ===== | ===== Dependencies ===== | ||
| + | Right now, the software requires DotNet 4.7.8 or above and Visual C++ 2019 to function properly. It will not launch without DotNet, you will get a message saying that the version you have is not compatible and to get the one from Microsoft which will redirect you to the latest version of DotNet. | ||
| + | OS: either Win7 or Win10, __XP is not supported__ and Win8/8.1 is impractical to use due to the UI. Both x86 and x64 will work but some features are only x64. You can also expect higher resolution and smoother playback on x64. | ||
| + | ** We recommend x64**. | ||