Skip to content

Setup & First Steps

Carina aka Neko Cari edited this page May 17, 2023 · 5 revisions

Setup

  1. Download a release (preferably the latest)
  2. Create a new MySQL database
    you can use an existing one, but you might run into problems if table names are already being used
  3. Open config/constants.php
    Update it with your database information. Also, do not forget to set up your languages and default timezone.
  4. Upload all files onto your web server via FTP
  5. Open \setup\setup.php in your browser
    and follow the instructions to create the database tables and default entries, as well as your admin account.
  6. delete the setup folder
    This is important!
  7. Customize the application
    Login to the application using your new account and head to administration first, to customize the app. See "First Steps" for details.

First Steps

Default setting values

You'll find them under Administration > Application > Settings
Go through each setting. A short explanation of what it does is provided. Most important are the following:

  • app_mail
  • app_name
  • cards_decks_public
  • cards_decks_upcoming_public
  • cards_file_type
  • cards_startdeck_num
  • currency_name
  • levelup_gift_cards
  • master_gift_cards
  • members_profil_public
  • shop_max_stock

TCG structure

Categories

Administration > Structure > Categories
There are placeholder categories you can edit. You need to at least define one main with one subcategory.

Level

Administration > Structure > Level
The app comes with some predefined levels for you to override. Just make sure your first level starts at 0 cards. Here you can also upload your level badge images.

Deck Types

Administration > Structure > Deck Types
Whenever adding a new deck, you'll need to assign a deck type.
You can define as many deck types as you need. Initially, there are 3 different customizable types, to showcase what's possible.

Within a deck type, you can define how many cards there are in a deck of that type, as well as the size of the card images.

Filler images for missing cards can also be set for each deck type. There are two variants for filler images: identical where you provide a single image used for every card number, or individual, where you have to upload different images for each number, e.g. for puzzle decks. (As of now, filler images have to be uploaded via ftp. But a file upload feature is planned.)

You can either decide how many cards will be displayed per row, or add your own HTML template to apply special styling, which will be used whenever the whole deck or a collection is displayed. Position the cards by using placeholders for each number [1] [2] etc.

If a template was created, but you no longer want to use it, simply remove the template path value.

Manager Categories

Administration > Structure > Manager Categories

Members sort cards in different categories using the card manager.
You can decide what categories you want to use for your TCG. You can name them and decide what they are used for.

For your TCG to work properly, you will need at least 3 categories:

  • one where newly acquired cards go
  • one for collections
  • one for tradable cards

If "visible" is checked, the category shows up in a members profile.

Cards

Upload Decks

Administration > Cards > upload
Decks can be added by uploading the cards via the provided form. The app takes care of renaming the files and putting them in a folder on the server.
The "Info text" accepts HTML, so you can use it however needed.

Updates

Administration > Cards > Update
After some decks were added, they can't be collected right away, they have to be published in an Update.
When creating an Update, you get to choose which decks you want to publish.

If you enable the visibility for upcoming decks, your members can vote for them. The number of votes will be displayed here for your information.

Updates are not published right away. This can be done in the list view. For future versions of the app, publishing updates may be scheduled, using crone jobs.

Games

Take a look at the games list and decide which ones you want to use, and change the possible results if you wish.

News

Write your first news entry, to welcome your visitors!
Deck updates can be linked to your news entry in list view, so the decks mastercards will be appended to your text.