Difference between revisions of "Player FAQ"

Latest revision as of 16:36, 14 April 2017

Known issues

Android: no information about wrong data files
Android & iOS: no screenshots -> use the savegame images
Android & iOS: no 3D character model support

Windows XP

Visionaire Studio (Player and Editor) needs the runtime library for Visual Studio 2012. This can be missing on older windows installations and must be installed manually: http://www.microsoft.com/en-US/download/details.aspx?id=30679

Windows 10

Visionaire Studio published games currently require you to right click on the game executable & set the compatibility mode for a previous version of windows, such as: Windows XP, 7 or 8. This is just a temporary solution & should be fixed in a future update of Visionaire Studio.

Publish on Steam

Once your game has been added to steam, you should promptly receive instructions from them, detailing how to use the steam wrapper. After the steam wrapper has been included, you should then be allowed to use the Steam API commands with Visionaire. https://www.steampowered.com/steamworks/FAQ.php

Here are the steam API commands for Visionaire (accessible via Lua script):

Visionaire Version 4.0

steam: The steam API update has disabled the DRM legacy support. We have updated the API. For Windows 7 users see: Change Data Execution Prevention settings

Building a game for different target platform

Export options are already included in the editor. You need to download the available platform first in case you want to build your game for a different platform (e.g. if you use the Visionaire Editor on Windows and want to export your game to Mac OS X).

Developer Platform (Visionaire Editor)

Windows

Download the platform target you would like to build for.
Copy the downloaded player into the "platform" directory of your Visionaire Editor installation.
Use build game in the Editor (full version only) and select the specific platform target you would like to build.

Mac

Download the platform target you would like to build for.
Right click on the Visionaire Editor application
Select "Show Package Contents"
Open the Directory Contents / Resources
Create a folder named: platform
Open the Directory "platform"
Drop (but do not extract) the player into the opened "platform" directory.
Use build game in the Editor (full version only) and select the specific platform target you would like to build.

Target Platform (Visionaire Player)

Linux

export your game to Linux in the Visionaire Editor (will be available in Visionaire 4.0 final)
Linux dependencies: openAL (libopenal1, GL)
linux users modify & execute the included "start" shell script
required: glibc 2.13 or higher; If you use note, that the libsteam_api.so has her own glibc version requirements

Android

ogg and opus recommended, videos are working now.
Download JDK http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html You need jarsigner from that
Download Android SDK http://developer.android.com/sdk/index.html#download You need zipalign from that
Download the Visionaire Player for Android
Download the Signing Keystore
Copy the file visionaire.apk and visionaire.apk.keystore to the platform directory in your Visionaire Studio installation
Export your game for Android, you need to select jarsigner and zip align
Connect your Android device per usb
Copy the <game>_android.apk to your device using the explorer
Install the Apk per file manager on your device (you may have to enable untrusted sources)
Run & good luck

The Application will continue running in the background if you home-out of it, to reload the file you need to close the application. It will drain your battery if you don't close it, just so you know. See here for more information.

Available Platforms for 4.2.5

Download the Visionaire Player for Windows
Download the Visionaire Player for MacOS
Download the Visionaire Player for Linux
Download the Visionaire Player for iOS
Download the Visionaire Player for Android

@@ Line 1: / Line 1: @@
-=Known issues=
+== Known issues ==
-* Android: no movies
-* Android: no savegames
 * Android: no information about wrong data files
-* iOS: no screenshots in savegames
+* Android & iOS: no screenshots -> use the savegame images
+* Android & iOS: no 3D character model support
-=Publish on Steam=
+== Windows XP ==
+Visionaire Studio (Player and Editor) needs the runtime library for Visual Studio 2012. This can be missing on older windows installations and must be installed manually:
+http://www.microsoft.com/en-US/download/details.aspx?id=30679
+== Windows 10 ==
+Visionaire Studio published games currently require you to right click on the game executable & set the compatibility mode for a previous version of windows, such as: '''Windows XP, 7 or 8'''. This is just a temporary solution & should be fixed in a future update of Visionaire Studio.
+== Publish on Steam ==
 * Once your game has been added to ''steam'', you should promptly receive instructions from them, detailing how to use the steam wrapper. After the steam wrapper has been included, you should then be allowed to use the Steam API commands with Visionaire. https://www.steampowered.com/steamworks/FAQ.php
-Here are the steam API commands for Visionaire (accessible with Lua scripting):
+Here are the steam API commands for Visionaire (accessible via Lua script):
 * [[GetSteamAchievement|getSteamAchievement]]
 * [[GetSteamStat|getSteamStat]]
@@ Line 15: / Line 22: @@
 * [[SetSteamStat|setSteamStat]]
-===Visionaire Version 4.0===
+=== Visionaire Version 4.0 ===
 * steam: The steam API update has disabled the DRM legacy support. We have updated the API. For Windows 7 users see: [http://windows.microsoft.com/en-us/windows7/Change-Data-Execution-Prevention-settings?SignedIn=1 Change Data Execution Prevention settings]
-=Android HowTo=
-===Installing a game with the beta version===
-There's no export option from the editor yet, the game therefore searches in a fixed path for the config.ini.
+== Building a game for different target platform ==
-# Download the [http://www.visionaire2d.net/visionaire/VisDownload/index.php?op=download&myfile=visplayer_android.apk Visionaire Player for Android]
+Export options are already included in the editor. You need to download the available platform first in case you want to build your game for a different platform (e.g. if you use the Visionaire Editor on Windows and want to export your game to Mac OS X).
-# Copy the file visplayer_android.apk to the platform directory in your Visionaire Studio installation
+=== Developer Platform (Visionaire Editor) ===
+===== Windows =====
+# Download the platform target you would like to build for.
+# Copy the downloaded player into the "platform" directory of your Visionaire Editor installation.
+# Use build game in the Editor (full version only) and select the specific platform target you would like to build.
+===== Mac =====
+# Download the platform target you would like to build for.
+# Right click on the Visionaire Editor application
+# Select "Show Package Contents"
+# Open the Directory Contents / Resources
+# Create a folder named: platform
+# Open the Directory "platform"
+# Drop (but do not extract) the player into the opened "platform" directory.
+# Use build game in the Editor (full version only) and select the specific platform target you would like to build.
+=== Target Platform (Visionaire Player) ===
+==== Linux ====
+# export your game to Linux in the Visionaire Editor (will be available in Visionaire 4.0 final)
+# Linux dependencies: openAL (libopenal1, GL)
+# linux users modify & execute the included "start" shell script
+# required: glibc 2.13 or higher; If you use note, that the libsteam_api.so has her own glibc version requirements
+==== Android ====
+# ogg and opus recommended, videos are working now.
+# Download JDK http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html You need jarsigner from that
+# Download Android SDK http://developer.android.com/sdk/index.html#download You need zipalign from that
+# Download the [http://www.visionaire2d.net/visionaire/VisDownload/index.php?op=download&myfile=visionaire.apk Visionaire Player for Android]
+# Download the [http://www.visionaire2d.net/visionaire/VisDownload/index.php?op=download&myfile=visionaire.apk.keystore Signing Keystore]
+# Copy the file visionaire.apk and visionaire.apk.keystore to the platform directory in your Visionaire Studio installation
+# Export your game for Android, you need to select jarsigner and zip align
 # Connect your Android device per usb
-# Copy the visplayer_android.apk to your device using the explorer
+# Copy the <game>_android.apk to your device using the explorer
-# Create the folder visionaire in the root of your internal sdcard
-# Copy config.ini plus all vis files in that directory
 # Install the Apk per file manager on your device (you may have to enable untrusted sources)
 # Run & good luck
-The Application will continue running in the background if you home-out of it, to reload the file you need to close the application (see here http://www.wikihow.com/Close-Apps-on-Android).
+''The Application will continue running in the background if you home-out of it, to reload the file you need to close the application. It will drain your battery if you don't close it, just so you know. See [http://www.wikihow.com/Close-Apps-on-Android here] for more information.''
-It will drain your battery if you don't close it, just so you know.
-=iOS HowTo=
-===Building a game with the beta version===
-Export option is already included in the editor, everything works out of the box with Mac OS. If you are working on Windows you need to download the iOS package first.
+=== Available Platforms for 4.2.5 ===
+# Download the [http://www.visionaire2d.net/visionaire/VisDownload/index.php?op=download&myfile=visplayer_win32.zip Visionaire Player for Windows]
+# Download the [http://www.visionaire2d.net/visionaire/VisDownload/index.php?op=download&myfile=visplayer_macos.zip Visionaire Player for MacOS]
+# Download the [http://www.visionaire2d.net/visionaire/VisDownload/index.php?op=download&myfile=visplayer_linux.zip Visionaire Player for Linux]
 # Download the [http://www.visionaire2d.net/visionaire/VisDownload/index.php?op=download&myfile=visplayer_iOS.ipa Visionaire Player for iOS]
-# Copy the file visplayer_iOS.ipa to the platform directory in your Visionaire Studio installation
+# Download the [http://www.visionaire2d.net/visionaire/VisDownload/index.php?op=download&myfile=visionaire.apk Visionaire Player for Android]
+{{toc}}