Get Started - labadserver/Adplayer GitHub Wiki

Download the latest release of the AdPlayer
Structure of the AdPlayer release archive
First simple AdPlayer scenario

Download the latest release of the AdPlayer

There are three main ways to get the latest release of the AdPlayer. You can either download the archive file from the German AdPlayer rollout communication platform, or download it from the GitHub download section. The third way is to check out the code from the git repository.

The German AdPlayer rollout communication platform provides a lot of information about the rollout project into the online advertising market in Germany. Here you can find technical and organizational discussion boards and official statements from the german Bundesverband Digitale Wirtschaft (BVDW) about this project. This website also informs you about new major AdPlayer releases.

It is also possible to downlad the latest release of the AdPlayer from the GitHub download section. For each release we will provide two different archive files. One of them consists of the built project files, the other holds the API documentation. Feel free to download them both.

Alternatively you can get a fresh and up to the minute version of the AdPlayer code. This can be accessed from GitHub by cloning the GitHub repository. Please read the Get Involved guide for further information.

Structure of the AdPlayer release archive

Note: In previous releases of the AdPlayer the files adplayer_server-xxx.js and adplayer_server-xxx.min.js were integrated in the archive file. It is strongly recommended to ignore these files and remove them from any existing installation.

After downloading and extracting the latest AdPlayer release file successfully you will find the following folder/file structure.

/css/
    adplayer.css
    adplayer.min.css
    oba_icon.png
/demo/
    ad.html
    ad.js
    demo.html
/js/
    adplayer-translation.js
    adplayer-translation.min.js
    adplayer.js
    adplayer.min.js
gpl.txt
README

The core AdPlayer script adplayer.js can be found in the folder js. It is responsable for all the AdPlayer's logic and functionality. The adplayer.min.js file is a compressed version of adplayer.js and should be used for production use cases.

Furthermore the AdPlayer translation file adplayer-translation.js can be found in the folder js. This file contains the translation of the header- and footer-texts in other languages than english and german. At this time there aren't any official translations in this file but we recommend to include this file on your server and your inclusion so this can be updated easily. The adplayer-translation.min.js file is a compressed version of adplayer-translation.js and should be used for production use cases.

The folder css contains all files which are responsable for the visualization of the AdPlayer's elements. The file adplayer.css holds all the necessary CSS properties to display the AdPlayer's elements in the correct way with a minimum of side-effects from the website's stylesheet. The oba_icon.png file is referenced relatively from the adplayer.css and must be accessable from the same URL ./oba_icon.png. The adplayer.min.cssfile is a compressed version of adplayer.css and should be used for production use cases.

The set of files you should choose depends on your intention. For testing/development purposes you can use the human-readable and uncompressed versions of the files. This can help you to analyse possible errors. For production use cases it is recommended to use the compressed versions to minify the amount of data to be loaded by the website's user.

Testing/Development

adplayer.js
adplayer-translation.js
adplayer.css
oba_icon.png

Production

adplayer.min.js
adplayer-translation.min.js
adplayer.min.css
oba_icon.png

First simple AdPlayer scenario

Work in progress ...