diff --git a/TODO.md b/TODO.md index 0dc0d849..c7530e17 100644 --- a/TODO.md +++ b/TODO.md @@ -3,34 +3,20 @@ This is an unordered list of possible todo items for Cockatrice. Note that "improve" and "write" always also means: "document and comment" -##Docs -* Improve README.md, it is very minimalistic and technical - ##Improve packaging: -* Add SSL libraries to Windows build to support https links in oracle.exe * Improve nsis file git hash extraction, it only works if the build directory is cleared as version_string.cpp does not seem to get updated by git pull/cmake -* Fix prepareMacRelease.sh to use default installation paths for Qt and protobuf -* Add Mac compile+package howto to the documentation * Create script/... for creating Linux packages (deb, rpm, ebuild, ...) or at least an official tarball/git tags; package maintainers dislike using git snapshots so much that they rather ignore software without stable tarballs. -* Move everything package related into one directory ##Scripts * Write example init script for servatrice. -##Webinterface -* Write a default cgi webinterface in some language for the servatrice database. Keep it simple and think about SQL-injections and other security risks - especially if you do it in PHP :-P - ##Improve usermanual: * Improve Layout, Text, Screenshots; nearly everything is still quick n dirty copy and paste. * Add missing TODOs * Translate the Documentation -* Include faq.txt and shortcuts.txt in usermanual, then remove them. * Rename the picture filenames to something more meaningful. * Create an index, lists of tables/figures/... -## Storage -* Find a better place for sets.xml than doc. - ##Create developer documentation: * Create developer manual * Add comments to code @@ -38,20 +24,11 @@ Note that "improve" and "write" always also means: "document and comment" * Describe the *.proto files * Comment and document servatrice.sql * Document everything!1!! -* Coding guidelines ##Else * Update SFMT library (http://www.math.sci.hiroshima-u.ac.jp/~m-mat@math.sci.hiroshima-u.ac.jp/MT/SFMT/) in common/sfmt and adapt common/rng_sfmt.cpp -* Prepare to update to Qt5, as Qt4 will die some day. See http://qt-project.org/wiki/Transition_from_Qt_4.x_to_Qt5 for relevant information. - * Move hardcoded URLs (especially from oracle and cockatrice) into a config file. -* Update the oracle to find all MtG extensions by itself, why the need for sets.xml when the oracle could ask the Gatherer or magiccards.info directly for this information? - -* Update the oracle with some intelligence or improve it otherwise to deal with changes from the Gatherer. - -* Remove cockatrice/resources/mtgforum.png as it is unused. Find other dead files or dead references to websites and files in the program code and documentation. - * Search git log for useful information/problems/bugs/... diff --git a/doc/add_sets.md b/doc/add_sets.md deleted file mode 100644 index 5dce7944..00000000 --- a/doc/add_sets.md +++ /dev/null @@ -1,62 +0,0 @@ -Add Sets -=== - -The oracle program creates the cockatrice card database and needs a set database to achieve this. -The set database is written in XML and has the following skeleton: - -``` - - - http://www.wizards.com/global/images/magic/general/%1.jpg - http://gatherer.wizards.com/Pages/Search/Default.aspx?output=spoiler&method=text&set=["!longname!"] - - - Set Code - Set Name - - - - Another Set Code - Another Set Name - - - ... - - -``` - -The full set database file called "set.xml" should be included in the cockatrice git-sources. - -* You could change the picture_url to another source if you want, e.g. if you have HQ scans or another alternative server. -* The set_url is the search URL for Wizard's Gatherer, where the oracle program will fetch it's information from. -* If the Gatherer changes, adapt the URL and keep in mind that '&', '"' and other special characters should be HTML encoded (like '&' and '"'). -* Further, the oracle replaces substrings included in '!' characters with information from the set entries, like '!longname!' with the set name. -* If you add a new set to the database, you have to create a new set entry like - - AVR - Avacyn Restored - -and update the date in the version string. If you set import="1" the set's checkbox in the oracle's GUI will be set, otherwise unset. - - -Here is a more detailed step by step manual found in the internet: - -1. Load the Oracle program that's installed with Cockatrice. The Oracle program can usually be found by click the Start button and going to All Programs > Cockatrice. -2. Click the File menu item and select 'Download sets information...' -3. Copy the URL from the 'Load sets' screen (the URL should be something like http://www.cockatrice.de/files/sets.xml) and paste it into your internet browser. -4. Right click on the web page and select Save As -5. Save the XML file to somewhere on your PC, preferably somewhere that's easy to get to -6. Right click on the XML file and select 'Open With...' and choose Notepad from the list -7. Before the end of the notepad document (should be something like ) add: - - RTR - Return to Ravnica - -8. Save and close the XML file -9. Back in the Oracle progam if the 'Load Sets' screen is still open click the Cancel button -10. Click the File menu item and click 'Load Sets from File' -11. Browse to where you saved the XML file and double click on it to select it -12. Click the Start Download button -13. Once the download is complete close the Oracle program and run Cockatrice. The Return to Ravnica cards should now be displayed. - -Hopefully the steps above are helpful and easy to follow. \ No newline at end of file diff --git a/doc/create_sets_xml.sh b/doc/create_sets_xml.sh deleted file mode 100755 index 14abd0e3..00000000 --- a/doc/create_sets_xml.sh +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/sh - -# Print the header -echo '' -echo '' -echo 'http://gatherer.wizards.com/Handlers/Image.ashx?multiverseid=!cardid!&type=card' -echo 'http://gatherer.wizards.com/Pages/Search/Default.aspx?output=spoiler&method=text&set=["!longname!"]&special=true' - -# Download the sets and print them in XML -lynx -dump -source http://magiccards.info/sitemap.html |grep Gatecrash|sed 's/
  • @\t@g'|sed 's@\n\t\t"toupper($1)"\n\t\t"$2"\n\t"}' - -# Print the footer -echo '' diff --git a/doc/faq.md b/doc/faq.md deleted file mode 100644 index 32703d20..00000000 --- a/doc/faq.md +++ /dev/null @@ -1,138 +0,0 @@ -FAQ -=== - -How to update the card database ---- - -When a new set comes out, you need to update your card database to be able to -see the new cards in the deck editor and use them in the game. To do this, -open the Oracle tool in the Cockatrice folder. It's a stand-alone program and -is run directly out of the folder without running Cockatrice. - -When the Oracle tool is running, open the menu and select 'Download sets -information'. Use the suggested address and click OK. After at most a few -seconds, you should be presented a list of sets to be downloaded. Do not -uncheck the ones you already have: they should be downloaded again. Click -'Start download' and wait. When the process is finished, the database should -be up to date. - - -Change Card Art / Custom Card Art ---- - -Is it possible to change the card art for a specif card, not by changing the -set order in my deck editor? - -YES! It is actually very simple. - -All you have to do is get a .JPG of the card you wish to change and name the -actual file of the image to the cards (exact) name and add ”.Full” to the end. -You can then take this new card image and replace the old one in your -downloaded image folder. - -*NOTE: Image size does not matter. Try to use a high resolution .JPG of the -card you want to use for best quality.* - -EXAMPLE: Let's say you wish to turn your M11 Sun Titan from its original art -to a promo version. - -If you are using Windows 7, you can find the default location for the -Cockatrice card art files under - -``` -C:\Program Files (x86)\Cockatrice\pics\downloadedPics -``` - -Once there, look for the folder of the -set for the card we are replacing. For this example, Sun Titan is in the M11 -folder. Open the folder and paste/replace your new “Promo” Sun Titan.full[.JPG] -into this folder, discarding the original copy. (If you have -not yet downloaded the original image of a card by selecting it in the deck -editor or playing it in an online game, the card image will not yet be there) - -Once you have the new card image in the proper folder, you can now start -Cockatrice (Or re-start if you already had the program open)and select the -deck editor to see your new card image. - -If you are changing the art of a card that has multiple versions in other -sets, make sure you put the new card in whatever folder (or set) is highest -on your card database set list. - -*NOTE: Other players on Cockatrice will NOT see your new card image. They will -only see whatever version of the card is in their database.* - - -Use Higher Resolution Cards ---- - -Can you get better/higher resolution card art than the default downloaded card -images already used? - -Yes! - -When you click on a card for the first time in the Deck Editor, Cockatrice -goes onto the internet and finds an image of that card from a database on -another website. - -If you find a higher resolution .JPG of a card that you wish to use on your -Cockatrice, you can replace the image with no problem. If you can find a card -image in the 3,000 by 1,000 pixel range, and save it as the cards (exact) name -and add .Full to the end. - -If you are using Windows 7, you can find the default location for the -Cockatrice card art files under - -``` -C:\Program Files(x86)\Cockatrice\pics\downloadedPics -``` - -Once there, look for the folder of the set for the card you are replacing. If you are not running Cockatrice as an -administrator, look in - -``` -C:\Users\username\AppData\Local\VirtualStore\Program Files (x86)\Cockatrice\pics\downloadedPics -``` - -Open the folder of the set with the card, and paste/replace the new higher -resolution .JPG image with the old low quality one. - -This process is the same for changing cards to custom images. - - -*NOTE: Other Cockatrice players will not see your higher resolution card art, -they will only see the image they have in their own database.* - - -Booster Drafts ---- -Cockatrice does not support booster drafts, so players need to use an -external service for this. - -Most people use [ccgdecks.com](http://ccgdecks.com/) so it's probably not a bad idea to -register an account there before joining a game in Cockatrice. - - -How to link a card in the Cockatrice chat. ---- - -To link a card in the Cockatrice chat, type out the full name of the card, -surrounded by the [card] and [/card] tags. - -For example: - -``` -[card]Black Lotus[/card] -``` - -How to link a URL in the Cockatrice chat. ---- -To link a URL in the Cockatrice chat, type out the url, surrounded by the -[url] and [/url] tags. - -For example: - -``` -[url]http://www.cockatrice.de[/url] -[url]cockatrice.de[/url] -``` - diff --git a/doc/sets.xml b/doc/sets.xml deleted file mode 100644 index bcc7c20e..00000000 --- a/doc/sets.xml +++ /dev/null @@ -1,514 +0,0 @@ - - -http://gatherer.wizards.com/Handlers/Image.ashx?multiverseid=!cardid!&type=card - -http://mtgjson.com/json/!name!.json - - ARB - Alara Reborn - - - ALL - Alliances - - - ATQ - Antiquities - - - APC - Apocalypse - - - ARN - Arabian Nights - - - ARC - Archenemy - - - AVR - Avacyn Restored - - - BRB - Battle Royale Box Set - - - BTD - Beatdown Box Set - - - BOK - Betrayers of Kamigawa - - - BNG - Born of the Gods - - - CHK - Champions of Kamigawa - - - CHR - Chronicles - - - 6ED - Classic Sixth Edition - - - CSP - Coldsnap - - - CON - Conflux - - - CMA - Commander's Arsenal - - ^M - C13^M - Commander 2013 Edition^M - - - DST - Darksteel - - - DKA - Dark Ascension - - - DIS - Dissension - - - DGM - Dragon's Maze - - - DDH - Duel Decks: Ajani vs. Nicol Bolas - - - DDC - Duel Decks: Divine vs. Demonic - - - DDF - Duel Decks: Elspeth vs. Tezzeret - - - EVG - Duel Decks: Elves vs. Goblins - - - DDD - Duel Decks: Garruk vs. Liliana - - - DDL - Duel Decks: Heroes vs. Monsters - - - DDJ - Duel Decks: Izzet vs. Golgari - - - DD2 - Duel Decks: Jace vs. Chandra - - - DDM - Duel Decks: Jace vs. Vraska - - - DDG - Duel Decks: Knights vs. Dragons - - - DDE - Duel Decks: Phyrexia vs. the Coalition - - - DDK - Duel Decks: Sorin vs. Tibalt - - - DDI - Duel Decks: Venser vs. Koth - - - 8ED - Eighth Edition - - - EVE - Eventide - - - EXO - Exodus - - - FEM - Fallen Empires - - - 5DN - Fifth Dawn - - - 5ED - Fifth Edition - - - 4ED - Fourth Edition - - - DRB - From the Vault: Dragons - - - V09 - From the Vault: Exiled - - - V11 - From the Vault: Legends - - - V12 - From the Vault: Realms - - - V10 - From the Vault: Relics - - - V13 - From the Vault: Twenty - - - FUT - Future Sight - - - GPT - Guildpact - - - GTC - Gatecrash - - - HML - Homelands - - - ICE - Ice Age - - - ISD - Innistrad - - - INV - Invasion - - - JOU - Journey into Nyx - - - JUD - Judgment - - - LEG - Legends - - - LGN - Legions - - - LEA - Limited Edition Alpha - - - LEB - Limited Edition Beta - - - LRW - Lorwyn - - - M10 - Magic 2010 - - - M11 - Magic 2011 - - - M12 - Magic 2012 - - - M13 - Magic 2013 - - - M14 - Magic 2014 Core Set - - - CMD - Magic: The Gathering-Commander - - - CNS - Magic: The Gathering—Conspiracy - - - MED - Masters Edition - - - ME2 - Masters Edition II - - - ME3 - Masters Edition III - - - ME4 - Masters Edition IV - - - MMQ - Mercadian Masques - - - MIR - Mirage - - - MRD - Mirrodin - - - MBS - Mirrodin Besieged - - ^M - MMA^M - Modern Masters^M - ^ - - MOR - Morningtide - - - NMS - Nemesis - - - NPH - New Phyrexia - - - 9ED - Ninth Edition - - - ODY - Odyssey - - - ONS - Onslaught - - - PLC - Planar Chaos - - - HOP - Planechase - - - PC2 - Planechase 2012 Edition - - - PLS - Planeshift - - - POR - Portal - - - PO2 - Portal Second Age - - - PTK - Portal Three Kingdoms - - - PD2 - Premium Deck Series: Fire and Lightning - - - PD3 - Premium Deck Series: Graveborn - - - H09 - Premium Deck Series: Slivers - - - PPR - Promo set for Gatherer - - - PCY - Prophecy - - - RAV - Ravnica: City of Guilds - - - RTR - Return to Ravnica - - - 3ED - Revised Edition - - - ROE - Rise of the Eldrazi - - - SOK - Saviors of Kamigawa - - - SOM - Scars of Mirrodin - - - SCG - Scourge - - - 7ED - Seventh Edition - - - SHM - Shadowmoor - - - ALA - Shards of Alara - - - S99 - Starter 1999 - - - S00 - Starter 2000 - - - STH - Stronghold - - - TMP - Tempest - - - 10E - Tenth Edition - - - DRK - The Dark - - - THS - Theros - - - TSP - Time Spiral - - - TSB - Time Spiral "Timeshifted" - - - TOR - Torment - - - UGL - Unglued - - - UNH - Unhinged - - - 2ED - Unlimited Edition - - - UDS - Urza's Destiny - - - ULG - Urza's Legacy - - - USG - Urza's Saga - - - VAN - Vanguard - - - VIS - Visions - - - WTH - Weatherlight - - - WWK - Worldwake - - - ZEN - Zendikar - - diff --git a/doc/shortcuts.md b/doc/shortcuts.md deleted file mode 100644 index 68e512e9..00000000 --- a/doc/shortcuts.md +++ /dev/null @@ -1,48 +0,0 @@ -Keyboard Shortcuts -================== - -Keyboard Shortcuts can be used while playing a game on Cockatrice. Players use -them to do simple and recurring tasks without the use of looking though menus -to find the proper action. - -Shortcut Action ----------------------- - -| key | action -| ------------------------ | --------------------------------------------------------------------- -| F3 | View library -| F4 | View graveyard -| Ctrl+F3 | View sideboard -| Ctrl+W | View top car(s) of library (Choose a number) -| Ctrl+S | Shuffle deck -| Ctrl+I | Roll dice -| Ctrl+M | Draw 7, then mulligan successively -| Ctrl+D | Draw a card -| Ctrl+E | Draw Cards (Choose a number) -| Ctrl+Shift+D | Undo last draw -| Ctrl+L | Set Life (useful when adding or subtracting a large number of life) -| F11 | Minus 1 life -| F12 | Add 1 life -| Ctrl+U | Untap all permanents you control -| Ctrl+R | Remove all local arrows -| Ctrl+T | Brings up menu to Create a token -| Ctrl+G | Creates last token you made -| (Select card) Ctrl+Del | Move to graveyard -| (Select card) Ctrl+A | Attach Card (For equipment and auras) -| (Select card) Ctrl+H | Clone (Make copy of) selected card -| (Select card) Ctrl++ | Increase power -| (Select card) Ctrl+- | Decrease power -| (Select card) Alt++ | Increase toughness -| (Select card) Alt+- | Decrease toughness -| (Select card) Ctrl+Alt++ | Increase power and toughness -| (Select card) Ctrl+Alt+- | Decrease power and toughness -| (Select card) Ctrl+P | Set power and toughness -| Ctrl+Enter (Return) | Next turn -| Ctrl+Space | Move to next phase -| F5 | Untap step -| F6 | Draw step -| F7 | First main phase -| F8 | Beginning of combat step -| F9 | Second main phase -| F10 | End of turn step -| F2 | Concede game