Exclusive Content Downloader for Unofficial Patch 1.6
Posted: 12 Apr 2020, 08:58
I'm glad to present a new feature for Unofficial Patch 1.6: Exclusive Content Downloader, available since ver. 157034 (April 2020).
It is designed to simplify the process of downloading files from users (maps, scenarios, playbacks, game saves, etc.).
How Does It Work?
Unofficial Patch 1.6 uses the registered protocols empireearth2:// and empireearth2aos:// to control the Launcher from EE2.eu websites.
Since Minor Update 157034, the Launcher is able to download files from our designers and automatically place them in correct folders (in Documents).
This tutorial is only needed for users who upload their maps, scenarios, saves. When the link is correctly prepared, all other users will be able to get files with a few clicks.
Safety, Security and Limits
Security was the biggest priority when this function was programmed. Although it's hard to unintentionally open the protocol, the Launcher protects users by:
- Confirmation of file downloading, with details about the file source, name, size and the destination folder.
- Questions if a file should be overwritten in case it already exists.
- Currently only ee2.eu domain and subdomains are accepted, to make sure files don't come from unknown, potentially dangerous sources.
- Every selected file type has got a few (usually only 1) file extensions allowed. There is no danger of some malicious code being executed.
Documentation:
Creating the protocol link is very simple, as long as you understand 4 important parts.
Example protocol link:
empireearth2://decode-downloader-ee2-playback-https://forum.ee2.eu/download/file.php?id=XXXX
1. Base command which tells Launcher that this is the Exclusive Content Downloader call. It should always be the same. Don't edit it.
empireearth2 (EE2.exe) or empireearth2aos (EE2X.exe) are the protocols.
"decode" tells Launcher to decode URL, to avoid problems with "%" characters.
"downloader" tells the Launcher to parse this request using the Exclusive Content Downloader function.
2. Game name. This can be either "ee2" or "aos". Nothing else.
"ee2" will use "Documents\Empire Earth II" folder.
"aos" will use "Documents\Empire Earth II The Art of Supremacy" folder.
3. This tells the launcher what type the destination file is for. Thanks to this we know the destination folder and allowed extensions:
"customciv" (AOS only) => Folder: "CustomCivs". Allowed extensions: .civ
"customforce" => Folder: "CustomForces". Allowed extensions: .cqs
"gamepace" => Folder: "GamePace". Allowed extensions: .cfg
"import" => Folder: "GamePace". Allowed extensions: .bin .hdr .fmt
"map" => Folder: "maps" (EE2), "mapx" (AOS). Allowed extensions: .map
"playback" => Folder: "playback". Allowed extensions: .e2s
"savegamesp" => Folder: "savegame_SP". Allowed extensions: .sav
"savegamemp" => Folder: "savegame_MP". Allowed extensions: .sav
"scenario" => Folder: "scenario" (EE2), "scenario_EE2X" (AOS). Allowed extensions: .scn
"script" => Folder: "Scripts". Allowed extensions: .ies
4. File download link. It doesn't need to contain the file name, as the Launcher will determine it automatically during verification.
In most cases, forum users will use attachments as the source file. Please simply go to the Attachments tab and upload it. When the file is uploaded, the file name of the attachment will be clickable (currently green font). Click on it with the right mouse button, and select: "Copy link address" from the list. Then simply paste at the end of our protocol link.
How to Make Protocol Links Look Good?
This will be updated later, with example BBCodes.
Request to developers: please help me create some nice information, and update your older posts to use protocols.
Tutorial Video:
Summary:
Searching the folders and other file operations could be challenging for users who "don't know much about computers". With this feature, they'll be able to get everything painless and quickly.
It is designed to simplify the process of downloading files from users (maps, scenarios, playbacks, game saves, etc.).
How Does It Work?
Unofficial Patch 1.6 uses the registered protocols empireearth2:// and empireearth2aos:// to control the Launcher from EE2.eu websites.
Since Minor Update 157034, the Launcher is able to download files from our designers and automatically place them in correct folders (in Documents).
This tutorial is only needed for users who upload their maps, scenarios, saves. When the link is correctly prepared, all other users will be able to get files with a few clicks.
Safety, Security and Limits
Security was the biggest priority when this function was programmed. Although it's hard to unintentionally open the protocol, the Launcher protects users by:
- Confirmation of file downloading, with details about the file source, name, size and the destination folder.
- Questions if a file should be overwritten in case it already exists.
- Currently only ee2.eu domain and subdomains are accepted, to make sure files don't come from unknown, potentially dangerous sources.
- Every selected file type has got a few (usually only 1) file extensions allowed. There is no danger of some malicious code being executed.
Documentation:
Creating the protocol link is very simple, as long as you understand 4 important parts.
Example protocol link:
empireearth2://decode-downloader-ee2-playback-https://forum.ee2.eu/download/file.php?id=XXXX
1. Base command which tells Launcher that this is the Exclusive Content Downloader call. It should always be the same. Don't edit it.
empireearth2 (EE2.exe) or empireearth2aos (EE2X.exe) are the protocols.
"decode" tells Launcher to decode URL, to avoid problems with "%" characters.
"downloader" tells the Launcher to parse this request using the Exclusive Content Downloader function.
2. Game name. This can be either "ee2" or "aos". Nothing else.
"ee2" will use "Documents\Empire Earth II" folder.
"aos" will use "Documents\Empire Earth II The Art of Supremacy" folder.
3. This tells the launcher what type the destination file is for. Thanks to this we know the destination folder and allowed extensions:
"customciv" (AOS only) => Folder: "CustomCivs". Allowed extensions: .civ
"customforce" => Folder: "CustomForces". Allowed extensions: .cqs
"gamepace" => Folder: "GamePace". Allowed extensions: .cfg
"import" => Folder: "GamePace". Allowed extensions: .bin .hdr .fmt
"map" => Folder: "maps" (EE2), "mapx" (AOS). Allowed extensions: .map
"playback" => Folder: "playback". Allowed extensions: .e2s
"savegamesp" => Folder: "savegame_SP". Allowed extensions: .sav
"savegamemp" => Folder: "savegame_MP". Allowed extensions: .sav
"scenario" => Folder: "scenario" (EE2), "scenario_EE2X" (AOS). Allowed extensions: .scn
"script" => Folder: "Scripts". Allowed extensions: .ies
4. File download link. It doesn't need to contain the file name, as the Launcher will determine it automatically during verification.
In most cases, forum users will use attachments as the source file. Please simply go to the Attachments tab and upload it. When the file is uploaded, the file name of the attachment will be clickable (currently green font). Click on it with the right mouse button, and select: "Copy link address" from the list. Then simply paste at the end of our protocol link.
How to Make Protocol Links Look Good?
This will be updated later, with example BBCodes.
Request to developers: please help me create some nice information, and update your older posts to use protocols.
Tutorial Video:
Summary:
Searching the folders and other file operations could be challenging for users who "don't know much about computers". With this feature, they'll be able to get everything painless and quickly.