FAQ

From ShockvoiceWiki

Jump to: navigation, search

Contents

Frequently asked questions

What is Shockvoice?

Shockvoice is a GPL-licensed voice-over-ip communication tool. This tool is slightly different in its features. It's coded in C# and therefore runs on almost any platform of interest, be it windows, Unix, Macintosh or Solaris. The client will only be available for windows at the beginning.

What's the deal with Mono and .NET?

.NET is the framework we're using to run Shockvoice. You can download Microsoft's .NET Framework here. It is absolutely necessary to install this to run Shockvoice. Mono is a free implementation of the .NET Framework which was originally intended to make .NET applications available on Linux/Unix and other platforms, but which is also available for Windows. As a rule of thumb, you should always use the Microsoft .NET framework when you're on Windows, even if you don't like Microsoft, because it's alot more complete than Mono and contains everything that is needed to run the Shockvoice Client. Mono is currently in development and can only run the Server, so install this, when you want to run the Shockvoice Server on Linux.

Will there be a *nix based client available?

Definitely yes! We are currently working on a Linux client. Unfortunately the latest Mono version 1.9 will still have some issues with the treeview. Also there are issues with displaying the User Interface on certain distributions like Ubuntu. Hopefully Mono version 2.0 will fix that.

Is there a way to test the Server?

Yes, you only have to download the latest Shockvoice client and you can connect to one of our official public Shockvoice Servers which are listed at SVNetwork. They are marked yellow.

How to install Shockvoice on *nix based servers?

Instructions can be found in the INSTALL file supplied in the distribution archive.

Does the Shockvoice server run on 64bit based host systems?

Yes, but you have to delete the libsvcodec.so file. "Serverside mixing" will not be available then.

Where to find the latest version of Mono?

You can download the latest version of Mono on the Developer Website Mono-Project

Which ports does Shockvoice use?

Shockvoice uses port 8040 TCP/UDP for the main application. Port 8010 is used for the sv_query plugin that shows your server on SVNetwork. The Hosterinterface uses port 8020.

Where can i change the ports?

You can edit the config.xml file in your installation directory and change to ports for the sv_query plugin and the Hosterinterface. The main application port can be configured via the Shockvoice client inside the Administrator Menu by clicking on 'Manage this server instance'.

How do I administrate the Shockvoice Server?

Shockvoice is administrateable through the Shockvoice client.

What is the default Admin Login for an new installed Server?

The default Login for Admin is Username:admin and Password:admin

How do I set the max. users to another value?

You can define the MAX users for your server be editing the server instance in the Administrator Menu.

Where are my servers's log files?

The Logfiles are located the the 'logs' folder inside your application directory.

Which Codec does Shockvoice use?

Shockvoice use the Speex Codec. You are able to change between wideband(16khz) and ultra-wideband(32khz) audio and bitrates between 8 and 44kbps

How can I register with a server?

At this time you need an admin to register your account with the server.

My Shockvoice client is constantly starting up when I reboot my system.

You probably have a G15 Keyboard. Check the settings from your LCD-Manager and turn-off auto start for Shockvoice.

Sometimes I hear echos of people speaking. How to fix this?

You can try to fix this by increasing your latency setting in your client. This latency is the audio buffer latency which will cause your soundcard to wait a little longer with playback of incoming audio giving your network connection and CPU more time to react and lessening the chance of annoying loops.

I'am connected to a Server and can't talk to anyone, but I can hear other people talking!?

You are probably using Vista. Just start Shockvoice with Administrator rights to fix this problem.

After Install reaches 100% I get the Error " */shockvoice_reg.exe CreateProcess failed; Code 14001"

Make sure you have at least WinXp Servicepack 2 installed. The easyest way is using the Microsoft Windows Update.

I can't talk when I am connected to a Server.

It's possible that your router is blocking loads of incoming UDP packets. You can avoid this by changing the routing option inside your client. Configuration -> Routing -> Route audio over TCP

Is there a way for other users to see who is online?

Linux: Yes, inside the package is a file named query_script.tar.gz. Just unpack it and place the files in your Webbrowser root directory. Edit the query.php to your needs and point your Webbrowser to http://yourdomain.tld/query.php

Windows: The query_script.tar.gz is also located inside the Shockvoice installation directory. Just unpack it and put the files to a location where your Webbrowser will find them.

Where are the config files located?

Vista: You can find the config files in X:\Users\<username>\AppData\Roaming\Shockvoice

WindowsXP: You can find the config files in X:\Document and Settings\<username>\Applicationdata\Shockvoice

How can I register my Server on SVNetwork?

Choose Manage this server instance from the Administrator Menu. Mark the checkbox that says Register Server on SVNetwork.

Directly connect from a website or what is the svlink protocol

Svlink needs to be added to your registry to let windows know how to handle svlink:// requests. Like http:// will open your default webbrowser Shockvoice will open the client when you click on a svlink:// link. Just complete svlink with your own serverip. svlink://myownserver.com:8040.

What is the Shockvoice Whiteboard Plugin for?

You can load a backdrop picture into your Whiteboardsession. This picture will be distributed to all users who were invited to your session. You are now able to draw on top of your picture. This is a really good way to share your tactics with other players. You can even give rights to other players and allow them to draw on the same picture. Every member of your session will see all changes in Realtime.

What are virtual channels?

You can use virtual channels to talk to other Players, Groups, or Channels. You can for example create a hot key to talk to a different channel. You can create a new virtual channel to talk to all members of a specific group. It is even possible to mix that all together. e.g. Build a virtual channel to talk to the users Fred and Bob. Now add the channel Public-1 and group Operators to the same virtual channel. Fred, Bob, all people are in the channel Public-1 and all members of the Operators group will be able to hear you.

Error while loading shared libraries: libgthread-2.0.so.0

Linux Shockvoice server is not starting because of this error message. Solution: install libglib2.0-0 and libglib2.0-dev

Using svctl.exe

Administrate your server by using the "svctl.exe"

With "svctl.exe“ we are providing a seperate interface to administrate your Shockvoice server by feeding him with commands straight from the command shell. For Linux servers you have to use the "svctl“ Shell script. This interface can be used to give the Shockvoice server directly commands from your own website or adminpanel.

Our serverspecs:

domain: example.com

login: admin

pass: admin

serverport: 8040 → config.xml

port for hosterinterface: 8020 → config.xml


Overview of commands accepted by "svctl.exe“:

Shockvoice Hoster Interface Client v0.8.2

Usage:svctl <login> <password> <host> <port> <command>

Commands:

server_stop <server-id>

server_start <server-id>

server_create <name> <description> <password> <max-users> <port> <no-anonymous> <active> <homepage> <register> <list-on-svn>

server_modify <server-id> <name> <description> <max-users> <port> <no-anonymous> <active> <homepage> <register> <list-on-svn>

server_clone <server-id> <newname> <newport>

server_delete <server-id>

server_reload <server-id>

server_stats

plugin_activate <server-id> <plugin-id>

plugin_deactivate <server-id> <plugin-id>

user_create <name> <password> <is-admin> <server-id>

user_modify <user-id> <password> <is-admin> <server-id>

user_delete <user-id>

user_clone <user-id> <server-id> <username> <password>

Response:server_create / server_clone / user_create will respond with the ID of the new server/user.

all other commands will respond with message codes or 'FAILED:<reason>'


Examples:

We want to check how many instances are running.

svctl <login> <password> <host> <port> <server_stats>


svctl.exe admin admin example.com 8020 server_stats


Found mono binary in /usr/bin/mono .. good

Connected to example.com:8020


337 Server stats start.

338 "Mainserver" 1 256 0

339 Server stats end.


As you can see we have our "Mainserver“ up and running with id 1 and 256 slots.


How can I deactivate/activate an instance?

svctl <login> <password> <host> <port> <server_stop> <server-id>


svctl.exe admin admin example.com 8020 server_stop 1

This command will stop our "Mainserver“ (with server-id 1), but the main process is still running.


svctl.exe admin admin example.com 8020 server_start 1

This will start the "Mainserver“ again.


How to create a new server instance?

svctl <login> <password> <host> <port> <server_create> <name> <description> <password> <max-users> <port> <no-anonymous> <active> <homepage> <register> <list-on-svn>

<name> - servername to display (text)

<description> - server description optional (text)

<password> - server password optional (text or blank)

<max-users> - how many available slots (digits)

<port> - server port (digits)

<no-anonymous> - are anonymous user allowed? ('0' for no or '1' for yes)

<active> - server active? ('0' for no or '1' for yes)

<homepage> - server homepage to display optional (text/URL)

<register> - register server on SVNetwork? ('0' for no or '1' for yes)

<list-on-svn> - list server on SVNetwork? ('0' for no or '1' for yes)


svctl.exe admin admin example.com 8020 server_create 'Second instance' 'My second server instance' 'mypassword' '50' '8021' '1' '1' 'http://www.example.com' '1' '1'


As you can see we have some options that require either a '1' for „yes“ or '0' for „no“. Just leave the optional fields blank if you don't want to set them, but don't forget the quotes!

The server_stats should now show something like this:


svctl.exe admin admin example.com 8020 server_stats


Found mono binary in /usr/bin/mono .. good

Connected to example.com:8020

337 Server stats start.

338 "Mainserver" 1 256 0

338 "Second instance" 2 50 0

339 Server stats end.


The "Second instance“ is up and running with server-id 2


Cloning a server.

svctl <login> <password> <host> <port> <server_clone> <server-id> <newname> <newport>


svctl.exe admin admin example.com 8020 server_clone '2' 'Clone instance' '8022'


svctl.exe admin admin example.com 8020 server_stats

Found mono binary in /usr/bin/mono .. good

Connected to example.com:8020


337 Server stats start.

338 "Mainserver" 1 256 0

338 "testbude" 2 50 0

338 "Clone instance" 3 50 0

339 Server stats end.


Activate/deactivate plugins

svctl <login> <password> <host> <port> <plugin_activate> <server-id> <plugin-id>

<plugin-id> - so far the following plugin-ids are available sv_chat, sv_query, sv_vmail, sv_wboard. The names of plugin-ids can be found in the "''Manage server plugins''“ menu inside the client administration panel.


svctl.exe admin admin example.com 8020 plugin_activate '2' 'sv_wboard'

or

svctl.exe admin admin example.com 8020 plugin_deactivate '2' 'sv_wboard'


How to create/modify/delete a user using the hosterinterface?

svctl <login> <password> <host> <port> <user_create> <name> <password> <is-admin> <server-id>

<name> - user login name

<password> - user password

<is-admin> - user is admin? ('0' for no or '1' for yes)


svctl.exe admin admin example.com 8020 user_create 'testuser' 'mypass' '0' '2'

Found mono binary in /usr/bin/mono .. good

Connected to 127.0.0.1:8020


420 2 (where 2 is the user-id)


svctl <login> <password> <host> <port> <user_modify> <user-id> <password> <is-admin> <server-id>

<user-id> - get the user-id directly from the database or get the ID form the "''Manage users''“ menu inside the client administration panel. This can be used to reset user passwords.


svctl.exe admin admin example.com 8020 user_modify '2' 'mynewpass' '0' '2'


svctl <login> <password> <host> <port> <user_delete> <user-id>

svctl.exe admin admin example.com 8020 user_delete '2'


Cloning a user

svctl <login> <password> <host> <port> <user_clone> <user-id> <server-id> <username> <password>

This can be usefull if you have created a standard adminuser with limited access on the "Mainserver“ and you want to create other users with the same access on a different instance.


svctl.exe admin admin example.com 8020 user_clone '3' '2' 'instanceadmin' 'mypass'

This will clone the user with "user-id“ 3 to serverinstance 2 with username "instanceadmin“ and password "mypass

Personal tools