Getting Started

Installation

To install Pointshop2 simply extract the zip you downloaded into the addons folder. This will give you two folders: addons/pointshop2 and addons/libk.

Next install PAC3, the newest version can always be found here. Download and extract the zip, too. This will give you addons/pac3-master.

Final structure when everything is installed:

  • garrysmod
    • addons
      • libk
      • pac3
      • pointshop2

Installing Workshop Content to the Server

Installing the workshop content is required to use the airdrops addon. You can skip this step if you do not use airdrops.

You need to add the Content Addon to you server’s workshop collection airdrops to work.

If you have not set up a server workshop collection, follow these steps:

  1. Generating a web api authorization key: In order to use a workshop collection on your server, it must first have a web api authorization key. You can get one here. Once you have your key, add a new launch parameter to your srcds.exe command line: -authkey YOURAUTHKEYHERE.
  2. Creating a workshop collection: Next create a workshop collection here. Select Server Content as Type and fill the rest of the fields. Next add the Content Addon. It’s easier to find if you subscribe/fav it first.
  3. Publish the collection: On the last page when creating the collection, click “Publish”. You might have to agree to the Steam TOS to proceed. The URL of the collection should look something like this when you are finished: http://steamcommunity.com/sharedfiles/filedetails/?id=913621233. Write down the numbers from the URL.
  4. Add the collection to your server: Once you have written down the workshop id from the previous step, add a new launch parameter to your srcds.exe command line: +host_workshop_collection 123123123, replacing the numbers with the id. Your launch parameters should now include both, the workshop collection and the authkey from step 1: +host_workshop_collection 123123123 -authkey YOURAUTHKEYHERE.

Configuration

Pointshop2 requires no initial configuration! Once it is installed you are ready to go! Restart your server and press F3 to open the menu. You can find all settings under the “Management” tab.

Advanced Configuration

There are a few options in Pointshop2 that can be used to integrate the script more tightly into your system.

MySQL Setup

By default SQLite (via sv.db) is used to store all player and pointshop data. If you have a MySQL server you can also use MySQL with the script. This has the advantage of being more efficient for large amounts of data, enabling you to share items across multiple servers and allowing you to display data on the web.

If you want to switch from SQLite to MySQL you need to convert your database. We have created a tool where you can upload your SQLite database (located in your server’s garrysmod folder) and download a .sql.gz file that you can import with phpmyadmin. SQLite to MySQL

To enable MySQL please follow these steps:

  1. Install the gmsv_mysqloo module: Download the module from facepunch and follow the installation instructions for your operating system at the bottom of the post.
  2. Enable MySQL within LibK: LibK is used for all database operations of Pointshop2. To enable MySQL support go into the configuration file addons/libk/lua/libk/server/sv_libk_config.lua. Set LibK.SQL.UseMysql = true and update the remaining settings with your database connection details. If you are hosting the database on a different machine than the gamemserver, make sure to allow external connections to the database.
  3. Test the configuration: After a server restart Pointshop2 will now connect to MySQL. If there are any errors when connecting to the database they will be shown in the server console and logged to garrysmod/data/LibK_Error.txt serverside.

Troubleshooting and reporting bugs

When you are experiencing issues with pointshop 2 please follow these steps. For a fast solution include as much information as possible. Report bugs and problems only through scriptfodder tickets.

  1. Turn on debug mode: Follow the steps outlined here to enable verbose logging: Developer Options.
  2. Create a minimal test case: Try to reduce the steps needed to create the problem. Once you have found the quickest reliable way to create a problem note down the steps in a step by step fashion.
  3. Capture the load log: When the script loads it outputs a lot of information to the console. In your report include this, from both server and client console. If something goes wrong during load other errors can happen. The load log is printed on connect (clientside) and after a map change (serverside).
  4. Include client and server console logs: Include the client and server console logs from when the issue happens. Include a bit before and after, including too much is not a problem. Use a pastebin like http://hastebin.com/ for storing the information.
  5. Include server configuration: Are you using MySQL or SQLite? Do you use any custom extensions or any DLC? Which administration mod do you use? Which gamemode do you run?

Importing and exporting items and categories

Pointshop 2 allows importing and exporting items to text. You can use this feature to make backups of the shop or to transfer the item and category setup between servers.

Exporting and importing items can only be done trough lua commands. You can however run these through the server console by prefixing them with lua_run. Check Export & Import

Example workflow:

-- On Server 1:
        Pointshop2Controller:getInstance():exportItems() -- A filename is printed to the console
        Pointshop2Controller:getInstance():exportCategoryOrganization() -- A filename is printed to the console

-- You would now go into the data directory and transfer files from the first to the second server

-- On Server 2:
        Pointshop2Controller:getInstance():importItemsFromFile( "filename_1.txt" ) -- The filename from the first command
        Pointshop2Controller:getInstance():importCategoriesFromFile( "filename_2.txt" ) -- The filename from the second command

Note

Graphical import/export features and importing/exporting of wallets and inventories is planned and will be added in a future update.