thegamesdb / thegamesdbv2

Version 2 of TGDB

TheGamesDB.net

http://thegamesdb.net

This site serves as a frontend to a complete database of video games.

The site includes artwork and metadata that can be incorporated into various HTPC software and plug-ins via our API.

Getting Started

First, you will need to download a copy of the code. If you are unfamiliar with GitHub, the easiest way to do this is to click the "ZIP" button at the top of our GitHub page.

To get the site to run locally, you will need to install and configure the following components:

> Apache (v2.4.2 or Recommended)

Additional Requirements: rewrite_module

> MySQL (v5.5.8 or Recommended)

Additional Requirements: fulltext minimum word length should be set to 1 for searching game titles that include a single number in the title.

> PHP 5 (v5.3 or v5.4 Recommended)

Additional Requirements: Settings - short open tag (on) - Please Note: as of 23/09/2013 "register globals" is no longer required to be enabled... since PHP 5.4 has removed support for this, we had to introduce a Shiv in the code. As a result, you may want to alter your php error reporting settings to not display errors, as several uninitialized variables currently remain in use.

The quickest way to install and configure these components is by using XAMPP/LAMP on Linux, MAMP on Mac, or XAMPP/WAMP on Windows. You can also use vagrant, as described below.

Once these components are installed you will want to extract the site code into your www or httpdocs directory.

The next step is to create a blank database and then configure the basic system settings. To do this copy and rename the "config.template.php" file to "config.php". Then open up this new file in your favorite text editor, and insert your database connection settings and Base URL settings. Please note that the base url you enter should not contain a trailing slash.

The easiest way to get sample data for this system is to use our TGDB Development Pack, you could also use the "sample_db.sql" file that is in the root of our GitHub repository, however we cannot guarantee that this file is up to date and is has no sample data to work with, just a blank database schema for posterity.

The TGDB Development Pack:

Where do I get it?

You can download the TGDB Dev Pack from the following link: http://thegamesdb.net/tgdb-dev-pack.zip

It is roughly 40MB so be sure to do it on a connection that doesn't charge you per MB!

What is it?

The TGDB Dev Pack is a resource pack that is intended to aid the coding community to contribute to TheGamesDB.net's source code. The pack provides you with a small set of sample data and imagery which can be used as a test bed when coding for this project. Two users have already been created for you. There is an administrator account (username: "admin"), and a standard user account (username: "user")... The password for either of these users is very simply "password". To assist you in finding useful games, any games that have associated art available have been added as "favourite" games for both of these users.

How do I install it?

Simply overwrite the "banners" folder that came with the original source code that you should have already grabbed, using the one included in this pack as a replacement.

Finally, import the "tgdb-dev[dd-mm-yyyy].sql" file into your pre-configured MySQL database using your tool of choice (PhpMyAdmin, Navicat, MySQL Workbench, MySQL Console).

That's It!

Now you should be good to go! Navigate to your web-server's url (typically "http://localhost" for local web-servers such as WAMP/LAMP/MAMP/XAMPP)in your favorite browser and see if it all works!

Vagrant

There is a "Vagrantfile" in this repository that can be used to bring up a VirtualBox test VM with the site and the TGDB development pack. It basically follows the instructions provided above inside a base Ubuntu 14.04 installation. Just issue a "vagrant up" and access http://localhost:8888/

thegamesdbv2's Issues

Add an End Point for releasing soon and recently added

As outlined in https://forums.thegamesdb.net/viewtopic.php?f=9&t=2120

There is no current end points to view releasing soon and recently added.

Malformed swagger spec

I haven't looked too far into the underlying issue, but it looks like the swagger spec (https://api.thegamesdb.net/) references explicit items in the models. For example, Publishers > Data > Publishers has 4271 subobjects because it explicitly lists every single publisher.

When trying to auto-generate API clients (e.g. using something like openapi-generator), this ends up with 12k files/types generated.

Would it be possible to generalize the swagger definitions for the models so that the actual values aren't encoded into it? I really like that you are offering the swagger interface, and it will greatly ease migration from the old style clients if the swagger spec gets cleaned up.

Thanks!

Show favicon in browser

There is no favicon shown on tabs of a browser when on the website. One needs to be added.

TODO

Listed in no particular order:

• API, add recently added API (I still think this will be abused as an update API)
• API, basic statistics dash board
• API, Update API endpoint needs to be revised to be more transparent with the changes
  e.g: if an image is added/removed, the API doesnt provide image id, nor does it provide side (front back)
• game collection, allow the user to mark games as owned, completed, incomplete
• game collection, game play time, allow the user to specify how long it took them to complete a game
• game collection, allow game sorting
• game collection, "Missing Info" (show the user games they have in their collection that are missing info)
• game collection, add api, requires use permission
• a way to detect accidental double game submissions
• recently added pages support
• show contributors to game (done, UI needs improving?, add pagination and platform filter)
• report system (partially completed, needs improving)
• Add Game Hashes to Database, implementation done(not tested), require user UI
• lock games, some games have complete set of info, lock them so they can't be edited (or add edits into a queue that must be approved by mods)
• return games with greater than specific ID (could be useful for project that only poll specific platforms, and would periodically check for updates)
• link related games
• link same game across platform
• make platform addable/editable
• basic mod dash
• increase image limit and size limit
• sort genre by name

add new platform: Evercade handheld

Add region property on a game

This database is missing a really important element of game collecting, which is the region of the game. A game from different regions does not have the same market value and is essentially different in itself. I'm willing to work on this.

Make numbered items appear in alphabetical order

is there a way to make it so those entries appear correctly alphabetically? cause for some reasons, even though they are in the 100s, they appear in the 10s

disc 106, 115 & 120 in the image as an example

Game UIDs

Add support for SNES Nintendo UIDs -

e.g

• SNS-MW-USA
• SNS-MW-USA-1
• SNS-MW-USA-2

Remove Google+ share button

The bottom of the page has a Google+ share icon that needs to be removed since that service has been retired.

filter[platform] not working anymore

Hi,

Since a few days, the filter[platform] parameter in the API doesn't work anymore.

With this request : https://api.thegamesdb.net/v1.1/Games/ByGameName?apikey=xxx&name=Batman

You get 20 results which corresponds to what you get on the TGDB website with this URL : https://thegamesdb.net/search.php?name=Batman

However, doing this should bring me only the games for the "6" platform (SNES) :

https://api.thegamesdb.net/v1.1/Games/ByGameName?apikey=xxx&name=Batman&filter[platform]=6

but it doesn't work.

Search on the website work however : https://thegamesdb.net/search.php?name=Batman&platform_id[]=6 and gives the expected results.

Website not working

Is the website down?