DotP 2014: Potential Community Wad

by Xander9009
UPDATE (14-02-15):
For those who are new, the Community Wad project is a project I started awhile back with the goal of eventually having one single file with all the available cards. Well, two files: Core and Art. Along with this minimum number of files, there is a ready to use implementation of automatic updating using Google Drive. Setting it up is very simple (unless you're a novice with computers, in which case, feel free to ask for help). As a user, there are two basic ways you can use this mod. You can either download it and use it like any other mod: here, or you can read the section for making it automatically update. As a modder, there is a single, easy to use method of adding cards, functions, or other assets to the project.
Also, I need some feedback. I have no idea how any of this is being received or if anyone wants it. If I make it work for 2015 (if it works relatively the same way, it'll already work for it with some absurdly simple fixes), would anyone use it?
- The sync utility has been updated and is not combined. The same utility will now sync both loose files and packed files. The reason it was updated is because the art wad's format has been updated. It now resides in a collection of folder packed into a collection of wads as opposed to a single file. I chose to pack them based on blocks, though this may change. There are currently 38, but their average size is only 48 MB, where it was previously a single 2 GB file. Now, users should be able to download the files more easily even on slower connections that tend to time-out. I've done my best to ensure all files remained intact, but the overall size has somehow decreased to by roughly 300MB. This might be due to some higher quality images being replaced with lower quality ones (planeswalkers being a notable one). However, upgrading these again will now be much easier since I can update one small file and have users get that file rather that being forced to redownload the massive one from before. Due to space limitations on GD, the single-file-version of the art wad has been removed. If you'd like to use it, you'll need to email me so I can send them to you.
- Please read through this file if you are adding cards.
For those who are new, the Community Wad project is a project I started awhile back with the goal of eventually having one single file with all the available cards. Well, two files: Core and Art. Along with this minimum number of files, there is a ready to use implementation of automatic updating using Google Drive. Setting it up is very simple (unless you're a novice with computers, in which case, feel free to ask for help). As a user, there are two basic ways you can use this mod. You can either download it and use it like any other mod: here, or you can read the section for making it automatically update. As a modder, there is a single, easy to use method of adding cards, functions, or other assets to the project.
- Make this automatically update | Open
- I've written a small tool so you don't have to bother making sure you're up to date. To make this automatic, you'll need do a couple of things. They're not terribly complicated, and they're a one-time deal. If you have any trouble, feel free to post here and I'll do my best to help. Before you go any further, decide if you want the packed wad version or the loose files version. The packed wad version should work better if you plan to use this for multi-player purposes, but my computer only packs it once a day. The loose file version doesn't depend on my computer at all, and as such, if I disappear, this method will still work (although, someone may need to reupload the files to Google Drive and share that with everyone). Faster updates that don't require that I am up and running vs a single file usable in multi-player.
- Open the packed wad folder folder/webpage or the loose files folder/webpage.
- In the top right, you'll see "Add to Drive". It'll put this folder into your root Google Drive folder. From there, you can drag it into whatever Google Drive sub-folder you want. This will only affect where the files are downloaded to. Note, if you do NOT want the art file(s) to be automatically downloaded by Google Drive to your local Google Drive folder, go here (packed) or here (loose) instead.
- Next, go here. Download the sync utility and place it where you want it to reside long-term (Community Wad Sync.exe).
- Create a shortcut to the exe and place that shortcut in your startup folder (or just put the exe directly in it).
- The startup folder, in case you don't know, is generally found by pasting this after your user folder's address, "\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup". Mine reads, "C:\Users\Xander\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup" in total (except that Xander is a pseudonym). Put the shortcut (or exe) here and it will make this file run automatically every time you log in.
- Run the exe (or shortcut, of course), and you should be presented with a box asking you for some options. Once these are set, you should be good to go. Note that when it asks whether it will be syncing loose files or packed files, it will not give you an error if you tell it packed but point it to the loose files directory. It simply won't work. Same goes for the reverse. Please point it to the folder containing the type of files you tell it to sync.
Whenever the file (or files, for the loose version) is updated, those changes will automatically be downloaded through your Google Drive application. This utility runs however often you tell it to and detects changes. When it finds those changes, it overrides your game folder's files with the ones in your Google Drive folder.
- Add cards as a modder | Open
- Adding cards as a modder, once it's set up, is easier than making a wad yourself. Once you have everything set up, you simply drop the finished files into a folder which is set up exactly like the setup for making a wad (because that's 100% exactly how it's used). That folder is here (it's the same link as the loose-file-core-only link above). You can view and save those files all you like, but to change them or add your own, you'll need to email me or message me with your email so I can give you access. Only those with access have write privileges. Basically, open that folder up after getting access and upload the file there when it's in a finished, working state.
If you email me at Xander9009@gmail.com (which is where you should, if you go the email route), please make the subject read "Community Wad" without quotes. My email notifier has some trouble remembering this email address, but if that's the subject line, it'll be forwarded to my main email, which I check (almost) every day.
Please note these things:- Art files are almost entirely unnecessary. If you do add art files in the illustrations folder, they will be removed. The entire folder will automatically be moved to the Art wad. They will not remain in the core folder, but they'll still be available to anyone using the mod. This only affects the illustrations folder, not the other folders in the ART_ASSETS folder. Anything in the textures folder will remain right where you put it. If this becomes too large, I'll move the entire Art_Assets folder. This transfer will happen when the core wad is repacked (happens once per day if I have internet access).
- Do not delete non-game related files (except desktop.ini/similar) unless it's something you personally added (or that you know you can delete).
- Please don't upload cards which require external files. If you need external files, first, make sure you have permission to add assetts created by the maker of the file, and then simply add the file to the CW.
- All ArtIDs should link to the community wad art file. Link to art with CW[MultiverseID] as found in the URL of the card's page on Gatherer.Wizards.com (e.g. CW249 is the ArtID for Disenchant from Alpha and CW201162 is the ArtID for Disenchant from Master's Edition III). Let me know if it's missing something and I'll stick in the file. Note: you can convert the image yourself and drop it into the correct folder if you wish, but this will cause the nearly 2 GB art wad to be repacked and synced to everyone. Because of this, all I ask is that you make it worthwhile: don't just drop in a single image. Add a few that are higher quality than the ones present.
- Cards should have as few approximations as possible. If you upload a file with an approximation, please add it here.
- All cards except tokens (because I made every token in a batch creation) should have three tags. These tags are:
- Code: Select all
<AUTHOR><![CDATA[Creator]]></AUTHOR>
<EDITORS><![CDATA[Creator, first editor, second editor, ...]]></EDITORS>
<DATE><![CDATA[DD-MM-YY created, DD-MM-YY edited first, DD-MM-YY edited second, ...]]></DATE>
- Within the Loose Files directory, you'll find a Requirements and Naming.txt. Please give this a quick read (this is the same as the first link at the top of this post). It'll explain how all files should be named, how to use all of the tokens, and it has a couple more examples for the new tags.
Any cards (and of course other accompanying files in the other wad folders such as FUNCTIONS) added to this folder will be automatically packed and made available in the packed wad from the section above and will be immediately available in the loose file version.
Alternatively, if you want a card, request it in the formal requests thread. If you have a mod and you would like for me to incorporate it, I would love to grow this project and I'd be more than willing to do the work to make that happen.
- Future | Open
- I've got a working Multiplayer Syncing utility working for my friend and I. It wouldn't work for playing with strangers, but it works quite well for keeping your game and a group of others (or just one) in sync so you can easily play multiplayer games even if you've been adding mods. It also works through Google Drive. It had some problems, but they should be fixed now. This is available in the tools folder along with the other syncing tools (Community Mod Sync).
- Incorporate Neo's new frames for planeswalkers.
- Find a way to compile a list of localized text variables missing from the TEXT_PERMANENTS files.
- Reduce the number of TEXT_PERMANENTS files. This is already done, but I don't know if it's working.
- Consolidate function files and rename all functions (excluding Riiak's functions, which he will make sure can override these if he updates them).
If there are any requests, I would be more than happy to consider them. As long as they're within my ability, don't detriment the project, and are within the scope of this project, then I'll probably put it on my nonexistent to-do list. Feel free to ask.
- Tools | Open
- I've put all of the tools I've made while working on this project into a publicly available folder. That folder can be found here. These tools aren't really meant for general use, but they're there. You can open them using any text editor. If you change the directories to refer to directories of your own, you could easily recompile the entire project yourself. The sync utilities are located there in the Public folder. The one in the "Working" folder may change even before I've tested it. These tools may all change without notice. Plus, the only read-me explaining what any of them do is not likely to be updated often (if at all) and it only covers a few of them. If there's a question about them, I'd be more than happy to try to answer it.
- Links | Open
- Packed wads
- Loose files
- Packed core
- Packed art
- Loose core
- Loose art
- Public Tools (sync utility exe's)
- All tools (source code to sync files and other tools I use)
- Archives
- Main folder (everything above is a subfolder of this)
Also, I need some feedback. I have no idea how any of this is being received or if anyone wants it. If I make it work for 2015 (if it works relatively the same way, it'll already work for it with some absurdly simple fixes), would anyone use it?
- Original post | Open
- What is this?
So, I was thinking about some things that have been posted in a couple of other threads and I wanted to get started on making some kind of community wad file that we could all work on. The purpose of this thread is to initiate a test of the system I made. As it stands, you need Google Drive access to contribute, but anyone can use the final file.
I have set up an invitation-only directory on Google Drive with the necessary file structure of a DotP 2014 wad. Any cards or other assets placed in the folder by someone with access will, using the normal Google Drive system, be synced to everyone else with access, and importantly, to me. My computer is running a file that monitors the folder for any changes. If there are any changes, it will pack the folder into a new wad, which is available to anyone with the link.
Files wouldn't normally be added to the folder until they've been tested by whoever makes it, but for testing, I changed one of the files (simply added a subtype to a creature) and the final file was replaced from the public's point of view in under 10 seconds. So, it does work. Of course, this is only with a couple of files in the folder, but it should generally work with any number. I may have to increase the delays, thus slowing the final file's availability, but it would still be available quickly and easily.
The end user wouldn't be required to have any extra utilities or anything, but I do have a small utility which could be run to monitor your Google Drive folder for the wad to change, and if it does, it'll automatically move it to your game's folder. This allows your used file to always be up-to-date without any extra effort beyond having a small file running all the time. It only runs once every 5 seconds, and it's incredibly small and simple, so its resource usage is negligible on any system that can run the game. I changed a card on one computer, and the other computer's wad in the game folder updated in under 15 seconds. So, bug fixes and the like could be nearly instantly distributed.
The near-instantaneous times I listed won't be the final result. Those were a test to see the capabilities. It is currently set to check for new/changed files every 6 hours. If you put in a card, it'll be in a usable wad in under 6 hours.
What isn't this?
The art assets are available. They're in a single wad and each pictures name is the MultiverseID for that version of the card. A few cadrds are still missing, but most are included. It will be updated as new sets are of cards are released by the CCGHQ team. This means BNG cards aren't included, yet, because they're still missing 4 of them. This is currently not included in the automatic transfer performed by the provided utility. This will need to be downloaded and managed manually, but you shouldn't need to do it often. Tokens are not yet included.
Does anyone want this?
This is useless if no one wants to use it, of course. So, let me know if you want to take part in it. Once it's set up, all that you should have to do is drop your files into the Community Wad folder so the directories match, and everything else should be automatic and available for download.
So, anyone interested? Any suggestions or advice? Should I make it so anyone with the link can edit the files, instead of only viewing them? Then you wouldn't need to be invited, but it's possible others will corrupt it. I could go that route, though. Google Drive has a revision system that should allow me to undo any changes if there are problems (not that I think there will be).
How do I use this?
What you need to add cards to the community wad: send me your email on here, via pm, or email me at Xander9009@gmail.com and I'll add you as an editor. You'll be given access to the folder on Google Drive so you can add cards and other files to it like it was a directory in your Magic 2014 folder. Drop in the cards you're ready to release, and they'll appear in the community wad. That's it. Use the MultiverseID without any prefix for the ArtID and it should automatically have art as long as the user has the Community Art wad as well, so you shouldn't need to worry about part.
What you need to use the community wad: you can find the file here (it's a subfolder of the links above). In that folder, you'll see two subfolders. Community Wad Core contains the small file for the cards themselves. Community Wad Art contains the very large Art wad. Grab both if you want both. The only reason they're in different folders is so the next section (automatic updating) can be done without having the art file saved in multiple locations. Just save the wad files in those subfolders to your Magic 2014 folder and you'll have the current community wad. Take the Community Wad Version.txt file as well so you will know what version you have without having to unpack the wad.
What you need to have the wad automatically used in your game:- Add the Core folder from the above section (not the main folder, thought you can do that) from the above link to your own google drive. Do this by opening the link, opening the Core folder, and choosing Open in Drive in the top right. Click the arrow next to the folder name at the top (Community Wad Public Folder, the doesn't appear until you put your mouse over the name) and choose "Move to...". Place the folder anywhere you want inside your own Google Drive. This will mean that as long as your Google Drive is running on your computer, you'll have the updated wad on your PC.
- Extract this file: It can go anywhere you want, though I have mine inside my game folder.
- Open Community Wad Directories.txt. The top two lines need changed to your corresponding directories. The top line must point to the "Community Wad Core" folder in the "Community Wad Public Folder" in your Google Drive (if you named it something else, use the name you gave it). In other words, the folder this points to has to have the actual core wad, NOT another subfolder with the core wad inside that subfolder. The second line should be your Magic 2014 folder like it currently is (mine is in C:\Games, yours probably isn't). The third line is how often it will check for the COMMUNITY_WAD.wad to have changed. It is currently set to 60 seconds. It can easily be made however many seconds you want (including thousands if you want it to update once a day), but you should know this script really doesn't use much of your system's resources.
- Save and exit. Double click the .exe so it runs, and wait until it updates. That's all. If you want to run automatically after restarting/logging off, create a shortcut to it, and place that shortcut in your startup folder.
As long as both directories are correct and the file is running, Data_DLC_Community_Wad.wad and its version file from the Google Drive directory you set will replace the same wad in your game folder any time they're not identical. If your game folder is in your Program Files folders (Steam defaults there, so the normal game by default will be if you didn't change it), this might not work. I don't know. You can try running it as an admin.
I would love for at least one person to help me verify it's working at all.