Techwizz/pvpgn-server
1
0
Fork 0
Code Issues 68 Pull requests 2 Projects Releases 8 Packages Wiki Activity Actions

Define the ad.json format specification

Browse source
This commit is contained in:
xboi209 2016-08-04 21:22:49 -07:00
parent 38ae37fb5b
commit bb5b6a94ba
1 changed files with 20 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
docs/adbanners.md
View file

@ -1,21 +1,32 @@
# Ad Banners
---
- The only graphic formats that Blizzard clients support are
- PCX
- SMK
- MNG
### Configuration File
The configuration file consists of a single array named ````ads```` which can contain an unlimited number of elements. Each element contains 4 pairs in the following order: ````filename````, ````url````, ````client````, and ````lang````.
- ````filename````: A string containing the filename of the ad banner, should not include a path.
- ````url````: A string containing the URL that users should be directed to when clicking on the ad banner.
- ````client````: A string containing the 4 character client tag that the ad banner should be shown to, a string of "NULL" will cause the ad banner to be shown to any client.
- ````lang````: A string containing a 4 character language code that will be displayed to users who have enabled that particular language, a string of "any" will cause the ad banner to be shown to any user. (e.g. deDE for German, enUS for English)
- These are old and therefore uncommon formats that require specific software to create and modify. PCX allows still images while SMK and MNG formats allow animated images.
### File Formats
| Client | Banner Format |
|------------|---------------|
| StarCraft | PCX, SMK |
| Diablo 2 | ? |
| WarCraft 2 | PCX |
| WarCraft 3 | SMK, MNG, PNG |
### Banner Dimensions
- The dimensions for ad banners are **468 x 60** pixels
- It is not known how to create PCX files that will display properly in PvPGN
- Only WarCraft III supports the MNG format
---
1. Download the [Old Smacker Tools](http://www.broodwarai.com/downloads/tools/OldSmackerTools.exe)(this only works on Windows XP)
### How To Create SMK Files
1. Download the [Old Smacker Tools](http://files.campaigncreations.org/resources/sc/programs/RADTools.zip)(this only works on Windows XP)
2. Run *smackerw.exe* and then click on the *Smack (compress) a graphics file.*
3. On the left side, navigate to the folder where your ad banner is stored and select it.
4. Under *Options*, click on the *Palette* tab. Check *Total palette colors to use:*, set it to *64* and check *Starting palette index to use:*, set it to *32*.
5. Set *8-bit input palettes* to *Create new.*
5. Click on the *Frame* tab and check *Create ring?*
6. *Smack!*
### Notes
- It is not known how to create PCX files that will display properly in PvPGN