diff --git a/README.md b/README.md index be38fa7..d8a934a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,30 @@ -# Minimalistic Yugioh Proxy Maker +

+

Minimalistic Yugioh Proxy Maker

+

A Minimalistic Yu-Gi-Oh Proxy Generator where it generates a printable PDF with only the information you need. -All card information is pulled from `yugioh.fandom.com` +
+All card information is pulled from +
+ Yu-Gi-Oh Fandom +

-## How to use +## Table of Contents +* [How to Use](#how-to-use) + * [Usage](#usage) + * [Running the Code](#running-the-code) +* [Generating a Deck](#generating-a-deck) + * [Steps](#steps) + * [The Command](#the-command) + * [Examples](#examples) + * [Printing](#printing-the-deck) + +## How to Use ### Usage 1. Make sure you have atleast **Java 8** installed on your machine -### To run the code +### Running the Code 1. You will also need to download 2 libraries (should be located in the libs folder) 1. JSoup 1.12.1.jar @@ -21,22 +37,50 @@ You can generate 3 types of proxies - Informational Proxies (Text based card using information from real life card) - Colored Informational Proxies - Full Card Art Proxies (Image taken from `yugioh.fandom.com`) +## Steps +1) Download the lastest version of the [Yugioh Proxy Maker](https://github.com/Kingal1337/YugiohProxyMaker/releases) +2) Open the command prompt +3) Navigate to where you have downloaded the .jar file in the command promt +4) Type `java -jar Yugioh-Proxy-Maker-1.1.0.jar ` to generate a Simple Deck (Be sure to replace `` with the .ydk file located on your computer) +5) The pdf that was generated should be located in the folder where you downloaded the .jar file +6) Print the PDF. +## The Command - -`DeckListLocation [DestinationLocation] [Colored MarginLeft MarginTop MarginRight MarginBottom]` +**Usage** + +`java -jar Yugioh-Proxy-Maker-1.1.0.jar ` +
+`java -jar Yugioh-Proxy-Maker-1.1.0.jar ` +
+`java -jar Yugioh-Proxy-Maker-1.1.0.jar ` +
+`java -jar Yugioh-Proxy-Maker-1.1.0.jar [--left=] [--top=] [--right=] [--bottom=]` + +**Arguments** +``` + Where the .ydk file is located + Where to save the file (Note: you must include a file name) + (true/false), set to true,to use the image on the fandom website + instead of using the minimalistic design + (true/false), if you want colored images or grayscale +``` -- - 1. Open the command prompt and navigate to where you downloaded the jar file - 2. type `java -jar Yugioh-Proxy-Maker-1.0.0.jar DECK_LIST_LOCATION` - 3. The deck should then be generated in the game folder where the jar file is +**Options** +``` + --left= the left margin of the pdf in pixels [default: 36] + --top= the top margin of the pdf in pixels [default: 50] + --right= the right margin of the pdf in pixels [default: 36] + --bottom= the bottom margin of the pdf in pixels [default: 50] +``` ## Examples - java -jar Yugioh-Proxy-Maker-1.0.0.jar "decklist.txt" +- **Simple Deck** - This will generate a minimalistic deck with just text and will be saved on the desktop + - `java -jar Yugioh-Proxy-Maker-1.1.0.jar "C:/Users//Desktop/Decklist.ydk"` +- **Deck with Original Images** - This will generate a deck with the image of the card pulled from the Yugioh Fandom + - `java -jar Yugioh-Proxy-Maker-1.1.0.jar "C:/Users//Desktop/Decklist.ydk" true true` ## Printing the Deck In order to print with the correct dimensions of a Yu-Gi-Oh card, set the scale of the print to 100% -## To-Do -- Add User-Friendly GUI -- Add text overlay to full card art proxies that lack an english card description/image/TCG printing +Recommended Software: `Adobe Acrobat Reader`