diff --git a/FlyingCircus.sty b/FlyingCircus.sty index 607dca4..7e43f1c 100644 --- a/FlyingCircus.sty +++ b/FlyingCircus.sty @@ -184,7 +184,10 @@ % Custom command for creating title page and table of contents. \newcommand{\InsertFCTitleAndTOC}[2]{ -{\let\cleardoublepage\clearpage +{ + \InsertFCCoverPicture{} + + \let\cleardoublepage\clearpage \begin{titlepage} \thispagestyle{LancerFancyTOC} \begin{center} @@ -408,9 +411,10 @@ \end{NiceTabular} \par \begin{multicols}{2} - \large - \justify - #2 + \raggedcolumns + \large + \justify + #2 \end{multicols} \vspace*{\fill} diff --git a/Main.tex b/Main.tex index 0b21510..0148c39 100644 --- a/Main.tex +++ b/Main.tex @@ -1,16 +1,25 @@ \documentclass[twoside,headings,a4paper]{article} \usepackage{FlyingCircus} +% Import FlyingCircus.sty \begin{document} -\InsertFCCoverPicture{} - +% SEt the document title, and you can add text at the bottom of the page. +% There's a \vfill pushing text to near the bottom, so you'll have to +% manually create spacing from that. Another \vfill is a convenient distance. \InsertFCTitleAndTOC{Document Title}{ Can add a Dedication \vfill Author Names } +% The basic Aircraft function. +% You have to set the top few manually, but everything below that +% Can be copied from the Save Catalog button on the plane builder. +% Things left unset generally appear as giant purple boxes, like the +% Nickname does for this one. +% There's also a `Box Loc' variable that can be any of the points on the image +% north, north east, east... north west, center, ect. \FCPlane[Nickname=\FrameDefault{Not Set}, %Box Text = {}, Image = {}, Name={Basic Biplane}, Price=11, Used=5, Upkeep=0, Stats = { @@ -28,13 +37,23 @@ Armament = {5 Bomb Mass Externally. \\ Seat \#1: 1x Fixed MG ✣ fires [Forward] for 2 damage with 4/3/2/1 hits with 10 ammunition. [Jam 2/3, Rapid Fire, AP 1, Fully Accessible]\\ Rotary: +1 to Dogfight! when turning right.\\ - },Link = {http://localhost:8080/PlaneBuilder/index.html?json=AAEAjATAdArMCwAhAhgZwJYGMAEj0AcAbZAOwFNgBAK4WgMFsfqcZBfZoHQAlACwHsSybAFl+AF34AnAEbIArtgBaYMNgAcABl75gAJGABcYACBa1GkzYAIVhw4B-h8FsAoex8-ngPAUNES0nKKKmpaOsAAwADq0QCSPnyCwmKSsgrKqhraurRmlACCUABmxQACAAmMAJBUAPwAAbSNzU32bEwWTp5mHL1RXvb9PZ2mjLa2HhPskXaj3p6zNZaDy6ssAKCe1BZsFhxbXku0k+sD9gDgZ8fnZx7UkdR0+4w7++-3d19AA} + },Link = {https://tetragramm.github.io/PlaneBuilder/index.html?json=AAEAjATAdArMCwAhAhgZwJYGMAEj0AcAbZAOwFNgBAK4WgMFsfqcZBfZoHQAlACwHsSybAFl+AF34AnAEbIArtgBaYMNgAcABl75gAJGABcYACBa1GkzYAIVhw4B-h8FsAoex8-ngPAUNES0nKKKmpaOsAAwADq0QCSPnyCwmKSsgrKqhraurRmlACCUABmxQACAAmMAJBUAPwAAbSNzU32bEwWTp5mHL1RXvb9PZ2mjLa2HhPskXaj3p6zNZaDy6ssAKCe1BZsFhxbXku0k+sD9gDgZ8fnZx7UkdR0+4w7++-3d19AA} ]{ - - + % This is where you put the text that goes between the bottom of the stats + % And the Plane Builder Link. It's a multi-column environment, so just use + % \columnbreak to go to the second column, or let it wrap by itself automatically. } -\FCPlane[Name = Bergziegel, Used = 8, +%Note that Price is empty. This plane cannot be bought new, for flavor reasons. +% If Price, Used, or Both are empty, the appropriate sections will be missing. +\FCPlane[Name = Bergziegel, Image = {Bergziegel_image.png}, + Box Text = { + Role & Transport\\ + First Flight & 1603\\ + Strengths & Room for Everything\\ + Weaknesses & Speed\\ + }, + Price = {}, Used = 8, Nickname = {Bring the bacon, and everything else!}, Upkeep = 2, Stats = { Full Load & 1 & 87 & 1 & 6 & 11 \\ @@ -50,20 +69,12 @@ Survivability = {Toughness 11, Max Strain 20, Escape 2, Crash Safety -1, Flight Stress 2}, Armament = {Passengers: 5 cabin seats and 0 first class or stretcher seats.\\ Large Cargo: Will fit a scout or fighter aircraft with the wings taken off.}, - Image = {Bergziegel_image.png}, - Box Text = { - Role & Transport\\ - First Flight & 1603\\ - Strengths & Room for Everything\\ - Weaknesses & Speed\\ - }, Link = {https://tetragramm.github.io/PlaneBuilder/index.html?json=AAEAjATAdArMBQAhApgJwOYC8CWz3IBtgBAE4cgMHOspupDvIFBzSAgYADACUALAewB2AQwAEAWX4AXfqgBGwgK6iAWpFFgwABl4AHYABRgAXGABgVpZpUAENQDgjJ8AD-L4AGhgABGd--ljwCIhLSsgrKahAa2nrmAOrxAJJcfEJikjLySqrqmjr65BzEAIKFAAIABdQAkCQA-AAyADMAs-UAAeSdfgw0pK7uVAHkQemhWRG50flxRqYWZEvUtg4j5G6ePus7gWkhmeE5UTEFCcmpwRlh2ZF5sYXAxWXkVbUNLe1dwD3OfdQDTbDXYcch1XYQyGMRaQmFkUHAACYCEYAyRKLoMLhyzRzjhdQRO3BkJYflIAwYhPW-3MNDsEOxNEcOzhjKhdFx7P8QA} ]{ After the end, helping communities get in touch with those around them and restoring trade was one of the most important things. Into the gap stepped the Baron, with the Bergziegel design. This innovative transport could move people and large cargos as far as it's escorts could keep it safe. One of the cheapest large transports you'll ever find, this steady, reliable plane has traveled the skies of Himmilgard for more than 15 years. - \vfill\null \columnbreak \begin{itemize} @@ -72,10 +83,14 @@ \item Trade cargo space for up to 15 additional passengers \item An extended fuselage can allow even huge cargos to be carried. \end{itemize} - - \vfill\null } +% This is an example Vehicle function +% It always starts on the left page, because it forms +% a double page spread, so count your pages. +% The text is placed on the left page. +% Anything below the stat block on the right page just goes after this function. +% So, you know, just keep typing after the last bracket. \FCVehicle[Name = What's A Tank?, Price = 30000, Nickname=The Worst Tank, Upkeep=200, Speed = 0, Torque = -0, Handling = 0, @@ -89,7 +104,8 @@ Loader & Closed & -3 & -4 & \\ x6 MG Crew & Closed & - & - & Guns? Guns! \\ Mechanic & Sealed & - & - & Engine Access \\ - }, Box Text = { + }, + Box Text = { Year Introduced: 2023\\ Served With: Rolling Circus\\ Engine: Lua\LaTeX\\ diff --git a/README.md b/README.md index f3dba8f..cd3589c 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ just right click on them and hit install. # What you Get In this folder are the fonts to install, some template files that are -used during processing, and the Python scripts Create.py and Compile.py. +used during processing, and the Python script Compile.py. That's it! That's all you need, besides your airplane designs. # How to Use @@ -54,73 +54,19 @@ That's it! That's all you need, besides your airplane designs. 1. Go to the [Plane Builder](https://tetragramm.github.io/PlaneBuilder/index.html) and load each of your aircraft designs. Save them using the \"Save Catalog\" button at the bottom of the page, in this folder. -2. +2. Copy Main.tex and rename it the name of your catalog. +3. Replace the demo calls with the contents of your Saved Catalog files +4. Fill in the Nicknames, Box Text, and the content for each. +5. Either run the Compile.py or directly run the command line call inside it. Be sure to run lualatex 3 times to ensure everything compiles nicely. +1. Open your PDF and enjoy. # What to Change -The file named AuthorInfo.text has the first line as the Title, and each -following line is an author's name. This way you don't need to re-enter -those if you add additional planes and need to re-run Create.py - -The folder \"images\" contains the aircraft images, or placeholders. You -can replace them with the images you want. The name of the file is what -is important. For example you may replace \"Basic_Biplane_image.png\" -with \"Basic_Biplane_image.jpg\" with no issues, but trying to use -\"Basic_Biplane.png\" will not work. The images are automatically -resized to fit, but you may wish to make or edit images into the -preferred aspect ratio for better appearances. - -The folder \"desc\" contains all of the text you edit. For each plane -there is a \"PlaneName_desc.txt\" and a \"PlaneName_table.txt\". - -## The Table - -The table is the simpler file. Each row consists of two parts, separated -by an = sign, like the default one, reproduced below. - -``` -Role=Edit, Add or -Served With=remove lines -First Flight=to fill -Strengths=out the -Weaknesses=table -Inspiration=like this. -``` - -The part to the left of the equal sign makes up the first column of the -plane's table. The part to the right, the second. Don't put more than -one equal sign per row, or it won't work. You can add or remove rows to -your heart's content, and are not limited to the ones already there, -which were chosen because that's what the first catalog used. - -## The Description - -The description file is actually a very simple LaTeX file. It has a two -line header, and a one line footer. In-between the \\begin and \\end is -the place where you put your aircraft descriptions. The text within it -will be distributed evenly over the two columns of the page. - -Because it is a LaTeX document, you can easily use simple commands, and -with a little effort, more complex formatting. Check out the lovely -tutorial at -[Overleaf](https://overleaf.com/learn/latex/Paragraphs_and_new_lines) -for how to do even complicated formatting. For basic work, see the next -section. When you make changes, you will notice they don't show up in -the PDF. To see the results, you must compile the document. If you have -added, removed, re-ordered an airplane (Or changed values in the save -file from the catalog), you will need to re-run the Create script. - - python .\Create.py - -It will read in everything and spit out a fully compiled version without -erasing any of the work you've done. It does replace the contents of -subfiles, and of the main .tex file. - -If you have not altered the aircraft, simply run the Compile script. - - python .\Compile.py - -Once complete, your file should be ready. +You need to set the name of your catalog and the author information in the InsertFCTitleAndTOC function. + +There are two airplanes and one ground vehicle in Main.tex, which need to be replaced with whatever you're actually putting in the catalog. + +If you're using Compile.py, you need to change the Title variable to the name of your tex file. # Basic LaTeX diff --git a/images/Bergziegel_image.png b/images/Bergziegel_image.png new file mode 100644 index 0000000..5f9ac9f Binary files /dev/null and b/images/Bergziegel_image.png differ