Latest revision as of 10:24, 22 March 2022

!!!! WIP !!!!

There are currently still 80 articles in preparation in the category "WIP"

Article in preparation. Please let the author finish it before you modify it.
The last editing was from Ledania on 22.03.2022.

•

This document describes ways how to make evidence in form of screenshots or videos. It is mainly helpful and intended for members of the Test Team however it might be useful for for regular users as well, especially when they need to document game issues for a ticket or game forum post. The document is separated into three sections by client platform and, in case of video recording, is not meant as help with live streaming.

The Ryzom client itself contains feature to capture screenshots and this functionality is described in Screenshot help on this wiki.

Windows

Windows 10 has some support for needed features but in case of older version you will probably need to install 3rd part software.

Screenshot

The way how to take a screenshot of your desktop in most of recent versions of Windows is very easy. In case of older version it consists of two steps, first the screenshot will be copied into the clipboard, then you need to start an image editor and paste the content of the clipboard in. Most of procedures use the Print Screen (sometimes PrtScn) key on your keyboard. It is located right to F12 key, above the Insert key.

Windows Game Bar interface

Build-in tools

With Windows 8.1 and newer you have an easy way how to take a screenshot of your desktop, it will be automatically saved into Pictures folder in your home folder.

Press Win+Print Screen

The other way will work with Windows 98 or newer but might also work with Windows 95 (not tested). First copy the desktop screenshot into your clipboard:

Press Print Screen key

Then you need to open Microsoft Paint, a simple image editor that is default part of all Windows, and paste the content of your clipboard. You can however use any other bitmap image editor.

Execute mspaint command (or find application Paint / MS Paint in your Start Menu)
Press Ctrl+V (or right-click in the drawing area and select Paste)
Save the image into a file

Windows Game Bar

Microsoft Windows 10 has a build-in feature to capture screenshots of you application related to other gamer extensions. It however is not possible to capture the whole desktop and you need to start the application you want to capture first.

Press Win+Alt+Print Screen to take a screenshot
Press Win+G to display Game Bar and access options

Greenshot

Greenshot screenshot tool preferences

Another option is to use Greenshot, an open source screenshot tool for Windows. Install the application and start it, it will be hidden in the panel notification area along with other icons. This will work with any Windows version that is supported by this software.

Press Ctrl + Print Screen to capture whole desktop, then save it to a file

The GIMP

GNU Image Manipulation Program, a powerful tool to edit bitmap images in various formats. It also have an interface to capture desktop screenshots.

Choose File > Create > Screenshot from the main menu

Video recording

Latest Microsoft Windows 10 includes support for video recording. In case you are using any older version, you will probably need to use 3rd party software to do the job.

Windows Game Bar

Microsoft Windows 10 has a build-in feature to record video of you application related to other gamer extensions. It however is not possible to record the whole desktop and you need to start the application you want to record first.

Press Win+Alt+R to start or stop video recording
Press Win+G to display Game Bar and access recording options

VLC media player

VLC capture device settings

VLC is open-source multimedia player and stream server application that can, along with many other functions, also record your desktop. This recording should work with every version of Windows in case you are able to install and run VLC, however it requires you to perform several steps:

1. Select Media > Convert/Save (or press Ctrl+R)
2. Switch to Capture Device tab
3. Select Desktop from Capture mode drop down menu
4. Set Desired frame rate for the capture using the spin box to at least 15 f/s
5. Click Convert/Save button
6. Select Profile from the drop-down menu (or click preferences button to adjust video output)
7. Select Destination file clicking on Browse button
8. Click Start button to start recording
9. To stop recording click standard ⏹ (stop) button as if you stop video/audio playback

Other tools

Carnac preferences and preview

There exist some additional tools and utilities that might help to make evidence for your (testing) report.

Carnac

In some special cases it might be needed to also record keys that you press on your keyboard. You can use the this utility in combination with desktop video recording. It requires Windows 7 or newer and Microsoft .NET Framework 4.5.2

Linux

Linux screenshot capture interface

Most of end-user desktop Linux distributions come with various tools that can do the job. Some of them are already part of your desktop environment, other can be installed from your distribution package repository. It is not aim of this document to describe all existing utilities.

Screenshot

Most of Linux graphical environments have built-in a way how to capture desktop screenshots already. It is usually accessible by pressing the Print Screen (sometimes PrtScn) key on your keyboard. It is located right to F12 key, above the Insert key. In case that your environment does not support this feature, you can use one of many alternatives.

Build-in tools

Taking screenshot by pressing Print Screen will work in case you are using Cinnamon, Gnome, KDE Plasma 5, MATE or Xfce desktop. Please consult help (accessible usually by pressing F1 key) for advanced options specific for your desktop environment. These are usually accessible by starting the application alone from menu or as an argument on the command line.

Press Print Screen key to take a screenshot

The GIMP

GIMP interface to take screenshot

GNU Image Manipulation Program, a powerful tool to edit images in various formats. It also have an interface to capture desktop screenshots.

Choose File > Create > Screenshot from the main menu

ImageMagick

A set of command line driven utilities for image manipulation. Consult the manual page page for more options.

Execute import -window root ~/file_name.png command to take screenshot of your desktop and save it to your home directory.

Video recording

SimpleScreenRecorder window with input settings

It might be important to record your activity in the game. It can help you to show a problem or describe a client behaviour to others. There exist various ways how to do this.

SimpleScreenRecorder

It is a small but powerful tool to record a video of your desktop environment. It is a Qt-based free (libre) software that allows you to specify shortcut to start and stop recording and set many other options. As first you need to configure the utility and then it can wait in the notification area until you need it.

1. Press Continue button on first window
2. Set video and audio input options and click Continue (optionally create a profile)
3. Select output file manually or by clicking on Browse... button
4. Check Separate file per segment (every video sequence will be save in a separated file)
5. Set video and audio output options and click Continue (optionally create a profile)
6. Set Hotkey combination to start/stop recording
7. Click SimpleScreenRecorder icon in notification area to hide main window

Now the tool is configured and you can start and stop recording any time you need.

Press selected shortcut (hotkey) to start/stop recording, Ctrl+R by default

byzanz

Another option is to use byzanz, a command line utility that will record your desktop as an animated GIF (Graphics Interchange Format) image. Please note that, by default, the record will suffer the format limitations with small colour palette because True color using separated image blocks is not supported. Please consult the manual page for more options and output formats.

Execute byzanz-record ~/file_name.gif to record your desktop and save it to your home directory.

OBS

For linux (but windows, macOS 10 too) OBS is a good solution too https://obsproject.com

Other tools

Screenkey preferences and preview

There exist some additional tools and utilities that might help to make evidence for your (testing) report.

Screenkey

In some special cases it might be needed to also record keys that you press on your keyboard. You can use the this utility in combination with desktop video recording.

macOS

Apple macOS is very friendly to all multimedia and you will have several ways to make evidence with tools shipped with the system.

Note: Following information were not tested and are based on public Apple macOS documentation. In case you are using this system, please help with this document.

Screenshot

By default, macOS comes with several applications to take screenshots of your desktop.

Screenshot app

The easiest way how to take a screenshot of your current desktop and let it be saved on your desktop is

Press Shift + Command ⌘ + 3 and wait a moment before it is saved on your desktop

Grab

Grab is another application that you can use to take screenshots of your desktop. You can find it in Applications > Utilities > Grab. When you see Grab menu...

Select Capture > Screen (or press Shift + Command ⌘ + W)
Click somewhere out of the dialog window

Video recording

Same as in case of screenshots, macOS comes with several ways how to record your desktop.

Mojave and newer

With macOS Mojave or newer there is a very easy way how to record your desktop or its part.

Press Shift + Command ⌘ + 5 to see bar with all possible options
Select appropriate button and click on a screen to start recording (or click Record button on the bar)

QuickTime Player

You can use the QuickTime Player on macOS systems older than Mojave.

Select File > New Screen Recording
Click the red button in the middle of the window
Click anywhere on the screen to start recording
Click black stop button in notification area of the menu bar to stop recording (or press Command ⌘ + Ctrl + Esc)

Portal of the Forge of Ryzom

@@ Line 1: / Line 1: @@
 {{WIP}}
 {{Trad
-|DE =The Test Team Handbook|DEs=5
+|DE =Das Test-Team-Handbuch/Beweise schaffen|DEs=3
-|EN =The Test Team Handbook|ENs=0
+|EN =Making evidence|ENs=0
 |ES =The Test Team Handbook|ESs=5
 |FR =The Test Team Handbook|FRs=5
@@ Line 18: / Line 18: @@
 ==Screenshot==
-The way how to take a screenshot of your desktop in most of recent versions of Windows consists of two steps. First the screenshot will be copied into the clipboard by pressing the '''Print Screen''' (sometimes '''PrtScn''') key on your keyboard. It is located right to F12 key, above the Insert key. Then you need to start an image editor and paste the content of the clipboard in.
+The way how to take a screenshot of your desktop in most of recent versions of Windows is very easy. In case of older version it consists of two steps, first the screenshot will be copied into the clipboard, then you need to start an image editor and paste the content of the clipboard in. Most of procedures use the '''Print Screen''' (sometimes '''PrtScn''') key on your keyboard. It is located right to F12 key, above the Insert key.
 [[File:Gamebar ui.png|thumb|150px|alt=Windows Game Bar interface|Windows Game Bar interface]]
-===Old build-in tools===
+===Build-in tools===
-This way will work with most of recent versions, probably with Windows 98 and newer but might work with Windows 95 as well. First copy the desktop screenshot into your clipboard
+With Windows 8.1 and newer you have an easy way how to take a screenshot of your desktop, it will be automatically saved into '''Pictures''' folder in your home folder.
+ Press '''Win+Print Screen'''
+The other way will work with Windows 98 or newer but might also work with Windows 95 (not tested). First copy the desktop screenshot into your clipboard:
   Press '''Print Screen''' key
-Then you need to open Microsoft Paint, a simple image editor that is default part of all Windows, and paste the content of your clipboard.
+Then you need to open Microsoft Paint, a simple image editor that is default part of all Windows, and paste the content of your clipboard. You can however use any other bitmap image editor.
-  Execute '''mspaint''' command (or find it in your '''Start Menu''')
+  Execute '''mspaint''' command (or find application '''Paint''' / '''MS Paint''' in your '''Start Menu''')
   Press '''Ctrl+V''' (or '''right-click''' in the drawing area and select '''Paste''')
+ Save the image into a file
 ===Windows Game Bar===
-Microsoft Windows 10 has a build-in feature to capture screenshots of you application related to other gamer extensions. It however is not possible to capture the whole desktop and you need to start the application you want to record first.
+Microsoft Windows 10 has a build-in feature to capture screenshots of you application related to other gamer extensions. It however is not possible to capture the whole desktop and you need to start the application you want to capture first.
- Press '''Win+G''' to display Game Bar and access recording options
   Press '''Win+Alt+Print Screen''' to take a screenshot
+ Press '''Win+G''' to display Game Bar and access options
 ===[https://en.wikipedia.org/wiki/Greenshot Greenshot]===
 [[File:Greensgot settings.png|thumb|150px|alt=Greenshot screenshot tool preferences|Greenshot screenshot tool preferences]]
-Another option is to use Greenshot, an open source screenshot tool for Windows. Install the application and start it, it will be hidden in the panel notification area along with other icons.
+Another option is to use Greenshot, an open source screenshot tool for Windows. Install the application and start it, it will be hidden in the panel notification area along with other icons. This will work with any Windows version that is supported by this software.
   Press '''Ctrl''' + '''Print Screen''' to capture whole desktop, then save it to a file
 ===[https://en.wikipedia.org/wiki/GIMP The GIMP]===
-GNU Image Manipulation Program, a powerful tool to edit images in various formats. It also have an interface to capture desktop screenshots.
+GNU Image Manipulation Program, a powerful tool to edit bitmap images in various formats. It also have an interface to capture desktop screenshots.
   Choose '''File''' > '''Create''' > '''Screenshot''' from the main menu
@@ Line 48: / Line 52: @@
 ===Windows Game Bar===
 Microsoft Windows 10 has a build-in feature to record video of you application related to other gamer extensions. It however is not possible to record the whole desktop and you need to start the application you want to record first.
+ Press '''Win+Alt+R''' to start or stop video recording
   Press '''Win+G''' to display Game Bar and access recording options
-  Press '''Win+Alt+R''' to start or stop video recording
+===[https://en.wikipedia.org/wiki/VLC_media_player VLC media player]===
+[[File:Vlc capture.png|thumb|150px|alt=VLC capture device settings|VLC capture device settings]]
+VLC is open-source multimedia player and stream server application that can, along with many other functions, also record your desktop. This recording should work with every version of Windows in case you are able to install and run VLC, however it requires you to perform several steps:
+. Select '''Media''' > '''Convert/Save''' (or press '''Ctrl+R''')
+. Switch to '''Capture Device''' tab
+. Select '''Desktop''' from '''Capture mode''' drop down menu
+. Set '''Desired frame rate for the capture''' using the spin box to at least '''15''' f/s
+. Click '''Convert/Save''' button
+. Select '''Profile''' from the drop-down menu (or click preferences button to adjust video output)
+. Select '''Destination file''' clicking on '''Browse''' button
+. Click '''Start''' button to start recording
+. To stop recording click standard '''⏹''' (stop) button as if you stop video/audio playback
+==Other tools==
+[[File:Carnac preferences preview.png|thumb|150px|alt=Carnac preferences and preview|Carnac preferences and preview]]
+There exist some additional tools and utilities that might help to make evidence for your (testing) report.
+=== [http://carnackeys.com/ Carnac] ===
+In some special cases it might be needed to also record keys that you press on your keyboard. You can use the this utility in combination with desktop video recording. It requires Windows 7 or newer and [https://www.microsoft.com/en-au/download/details.aspx?id=42643 Microsoft .NET Framework 4.5.2]
 =Linux=
-[[File:Screenshot capture.png|thumb|alt=Linux screenshot capture interface|Linux screenshot capture interface]]
+[[File:Screenshot capture.png|thumb|150px|alt=Linux screenshot capture interface|Linux screenshot capture interface]]
-Most of end-user Linux distributions come with various tools that can do the job. Some of them are already part of your desktop environment, other can be installed from your distribution package repository. It is not aim of this document to describe all existing utilities
+Most of end-user desktop Linux distributions come with various tools that can do the job. Some of them are already part of your desktop environment, other can be installed from your distribution package repository. It is not aim of this document to describe all existing utilities.
 ==Screenshot==
-[[File:Gimp screenshot ui.png|thumb|alt=GIMP interface to take screenshot|GIMP interface to take screenshot]]
 Most of Linux graphical environments have built-in a way how to capture desktop screenshots already. It is usually accessible by pressing the '''Print Screen''' (sometimes '''PrtScn''') key on your keyboard. It is located right to '''F12''' key, above the '''Insert''' key. In case that your environment does not support this feature, you can use one of many alternatives.
 ===Build-in tools===
 Taking screenshot by pressing '''Print Screen''' will work in case you are using [https://en.wikipedia.org/wiki/Cinnamon_(desktop_environment) Cinnamon], [https://en.wikipedia.org/wiki/GNOME Gnome], [https://en.wikipedia.org/wiki/KDE_Plasma_5 KDE Plasma 5], [https://en.wikipedia.org/wiki/MATE_(software) MATE] or [https://en.wikipedia.org/wiki/Xfce Xfce] desktop. Please consult help (accessible usually by pressing '''F1''' key) for advanced options specific for your desktop environment. These are usually accessible by starting the application alone from menu or as an argument on the command line.
+ Press '''Print Screen''' key to take a screenshot
 ===[https://en.wikipedia.org/wiki/GIMP The GIMP]===
+[[File:Gimp screenshot ui.png|thumb|150px|alt=GIMP interface to take screenshot|GIMP interface to take screenshot]]
 GNU Image Manipulation Program, a powerful tool to edit images in various formats. It also have an interface to capture desktop screenshots.
   Choose '''File''' > '''Create''' > '''Screenshot''' from the main menu
@@ Line 71: / Line 96: @@
 ==Video recording==
-[[File:Simplescreenrecorder.png|thumb|alt=SimpleScreenRecorder window with input settings|SimpleScreenRecorder window with input settings]]
+[[File:Simplescreenrecorder.png|thumb|150px|alt=SimpleScreenRecorder window with input settings|SimpleScreenRecorder window with input settings]]
 It might be important to record your activity in the game. It can help you to show a problem or describe a client behaviour to others. There exist various ways how to do this.
 ===[https://en.wikipedia.org/wiki/SimpleScreenRecorder SimpleScreenRecorder]===
-It is a small but powerful tool to record a video of your desktop environment. It is a Qt-based free (libre) software that allows you to specify shortcut to start and stop recording and set many other options.
+It is a small but powerful tool to record a video of your desktop environment. It is a Qt-based free (libre) software that allows you to specify shortcut to start and stop recording and set many other options. As first you need to configure the utility and then it can wait in the notification area until you need it.
+. Press '''Continue''' button on first window
+. Set video and audio input options and click '''Continue''' (optionally create a profile)
+. Select output file manually or by clicking on '''Browse...''' button
+. Check '''Separate file per segment''' (every video sequence will be save in a separated file)
+. Set video and audio output options and click '''Continue''' (optionally create a profile)
+. Set '''Hotkey''' combination to start/stop recording
+. Click SimpleScreenRecorder icon in notification area to hide main window
+Now the tool is configured and you can start and stop recording any time you need.
+ Press selected shortcut (hotkey) to start/stop recording, '''Ctrl+R''' by default
 ===byzanz===
 Another option is to use '''byzanz''', a command line utility that will record your desktop as an animated GIF (Graphics Interchange Format) image. Please note that, by default, the record will suffer the format limitations with small colour palette because  True color using separated image blocks is not supported. Please consult the manual page for more options and output formats.
   Execute '''byzanz-record ~/file_name.gif''' to record your desktop and save it to your home directory.
+=== OBS ===
+For linux (but windows, macOS 10 too) OBS is a good solution too https://obsproject.com
 ==Other tools==
+[[File:Screenkey preferences preview.png|thumb|150px|alt=Screenkey preferences and preview|Screenkey preferences and preview]]
 There exist some additional tools and utilities that might help to make evidence for your (testing) report.
@@ Line 88: / Line 126: @@
 =macOS=
-(TODO)
+Apple macOS is very friendly to all multimedia and you will have several ways to make evidence with tools shipped with the system.
+<font style="color: red;">'''Note:''' Following information were not tested and are based on public Apple macOS documentation. In case you are using this system, please [[Help#Help_on_wiki|help]] with this document.</font>
+==Screenshot==
+By default, macOS comes with several applications to take screenshots of your desktop.
+===[https://support.apple.com/en-us/HT201361 Screenshot app]===
+The easiest way how to take a screenshot of your current desktop and let it be saved on your desktop is
+ Press '''Shift + Command ⌘ + 3''' and wait a moment before it is saved on your desktop
+===[https://en.wikipedia.org/wiki/Grab_(software) Grab]===
+Grab is another application that you can use to take screenshots of your desktop. You can find it in '''Applications''' > '''Utilities''' > '''Grab'''. When you see Grab menu...
+ Select '''Capture''' > '''Screen''' (or press '''Shift + Command ⌘ + W''')
+ Click somewhere out of the dialog window
+==Video recording==
+Same as in case of screenshots, macOS comes with several ways how to record your desktop.
+===Mojave and newer===
+With macOS Mojave or newer there is a very easy way how to record your desktop or its part.
+ Press '''Shift + Command ⌘ + 5''' to see bar with all possible options
+ Select appropriate button and click on a screen to start recording (or click '''Record''' button on the bar)
+===[https://en.wikipedia.org/wiki/QuickTime QuickTime Player]===
+You can use the QuickTime Player on macOS systems older than Mojave.
+ Select '''File''' > '''New Screen Recording'''
+ Click the red button in the middle of the window
+ Click anywhere on the screen to start recording
+ Click black stop button in notification area of the menu bar to stop recording (or press '''Command ⌘ + Ctrl + Esc''')

From EncyclopAtys

Latest revision as of 10:24, 22 March 2022

Contents

Windows

Screenshot

Build-in tools

Windows Game Bar

Greenshot

The GIMP

Video recording

Windows Game Bar

VLC media player

Other tools

Carnac

Linux

Screenshot

Build-in tools

The GIMP

ImageMagick

Video recording

SimpleScreenRecorder

byzanz

OBS

Other tools

Screenkey

macOS

Screenshot

Screenshot app

Grab

Video recording

Mojave and newer

QuickTime Player