Contribute to the site!

Industria, shot by nyxikri

We want you!
We're looking for authors! Don't know what to write? Check our issue tracker.

framedsc.com is an open-collaboration project, written and maintained by a community of volunteers. We welcome anyone willing to contribute their own knowledge and expertise on anything relevant, be it to our game guides, a cool technique you know of, or anything you think could be useful to someone!


Writing guides

If you're interested in writing a guide for the site, please download this template. It contains everything you need to get started - a Markdown template for a game guide and a .PSD + font file to generate a header. There are two versions of guide templates, one for PC guides and one for Console guides.

We recommend writing with Visual Studio Code as it has a Markdown preview similar to how the site looks. The site is built with DocNet, however, which includes Markdown extensions not found in the VS Code preview. Learn more about DocNet's additional features, or continue reading to learn about some handy formatting features.

The site also supports HTML in Markdown if you want the formatting of your guides to be a little fancier. The centred text above was written in the .MD like so:

<center> <b><font size=+3 face="Galano Grotesque Alt">We want you!</font></b> <br>
<i>We're looking for authors! Don't know what to write? Check our</i> <a href="<URL>" target="_blank"><b>issue tracker</b></a>. </center>

Hosting files

We don't host any tools or utilities in the repository itself. If you would like to contribute any tool or utility, we recommend using a filehost like mega.nz. If the tool is hosted publicly on say a modding site or forum, please link to the post instead.

An exception to this is cheat tables. We prefer to archive those internally, provided that you are the author or have been given permission by the author to have them archived on the site. Include them alongside your submitted files.

Updating guides

If you notice an error in a guide or you simply want to extend an existing guide, you may access the site source. From there, open the markdown folder and navigate to the .md file of the guide you wish to edit.

Etiquette

We're generally not too concerned with how you write and format a guide, so long as the information is coherent and presentable. A site admin will help to clean up any incorrect syntax before publishing.

When it comes to updating game guides, headers will not be updated.

Unless all download pages are dead and the author is uncontactable, we will not rehost files without the author's permission.

Crediting yourself

You may credit yourself at the end of your non-game guides if you feel like it. Game guides don't have credits, but more often than not the headers used are from the guide authors themselves.


Making headers

When making a header for your guide, you may use any shot from the game, including your own. We recommend picking one that allows for good readability of text.

Here are two examples of great headers. The text lies wholly in the dark left side of the shot, contrasting and reading well.
good header eg1 good header eg2

After you've picked your shot, place it above the Base layer and ensure it's clipped to it. If it isn't, alt-click on the divider between the two layers. You should see a small down-arrow appear. Arrange the shot as you see fit.

Once the shot has been arranged, duplicate it by alt-clicking and dragging the layer below the Base layer. You can also Ctrl + J to duplicate and move it below. Go up to Filter > Blur > Gaussian Blur... and add a 26.3 radius blur to this duplicated layer to create the blurred border.

Your Photoshop layers should look like so:
photoshop layers

Export it as a .PNG and rename appropriately.

The header template includes a network of guides that can be enabled and disabled with Ctrl + ;. These can be used to help you compose a header or as safety margins. In the rare case that a game title is so long it doesn't fit in the header, decrease the font size until it fits in the rightmost margin.

long game title

Font size had to be reduced to 31


Images

If your guide has images, use this line to embed them:

![alt text](Images\image.png "This is the subtitle"){.shadowed .autosize}

For the subtitle to show, there has to be an empty line above this line.

Images will be sorted into the Images folder by the site admins. You may place them in a subfolder if you'd like to organise them.

There are a few CSS classes you can use in the Markdown line above to further format your images.

Class Description
.shadowed Adds a drop shadow to the image. Please include this class.
.autosize Resizes the image if it's too large. Please include this class.
.center Centers an image.
.smaller Reduces the width of an image. Useful if including long vertical images.

These are added at the end of the Markdown line, in between {}.

You can also use HTML to embed them instead, if you want a bit more formatting.

<div class="figure">
<img src="Images/image.png" alt="title" title="Tooltip that appears when you hover" class="autosize shadowed" />
<p>subtitle</p>
</div>

Accepted images

Images on the site should be in a .PNG / high-quality .JPG format, under 1MB. While there are no current size limits, images on the site are resized to 896px width (with the .autosize tag, which should be added to all images). They don't have to be resized to that width, but we would prefer it if you kept image sizes reasonable.

For excessively large images (say you want to include a full-res screenshot for some reason), they may be hosted externally. Use a trusted, reliable imagehost like Imgur.


Alert boxes

Info

You may have noticed that the site has a bunch of these alert boxes!

Tip

They're handy for highlighting certain pieces of information!

Info

Whether you want to break off a part of your guide to talk about it more in detail...

Warning!

...or if you want to warn users about something that could happen...

Important!

Alert boxes are a useful addition to your guide!

Danger!

FAILURE TO READ THE README WILL RESULT IN PROSECUTION.

Alert boxes can be added by wrapping text around @alert [box type] and @end, like so:

@alert neutral
You may have noticed that the site has a bunch of these alert boxes!
@end

The box types mostly correspond to their title above, @alert tip produces a green alert box, @alert info produces a blue alert box, so on and so forth. The exception is @alert neutral, which produces the black alert boxes.


Summaries

Some parts of your guides can be hidden away by a dropdown if necessary.

Click me! Hello! I'm some text that's been hidden away because I don't want to be visible all the time!

These can be used to hide tables, images, or anything else that you feel might break the flow of the guide.

<details>
<summary>Click me!</summary>
Hello! I'm some text that's been hidden away because I don't want to be visible all the time!
</details>

These summaries also support an important class, if you need the dropdown to stand out. Use <summary class=important> to add one.

Now you really have to click me! Hello! I'm even more text that's been hidden away, but my author really wanted you to read me. Maybe I'm supposed to be hiding a super long table that would interrupt the guide, but it's still an important table for you to be referencing at some point.

While we're here, it's a good time to should mention that these summary dropdowns don't support punctuation formatting. You need to use HTML to bold, italicise, and further format your text in these.


Image comparisons

The site supports sliders to compare two images, if you'd like to show off a before/after or anything similar.

after ReShade

before ReShade

Subtitle. Shots by ItsYFP

This is done wholly through HTML in your Markdown file:

<div class="slider container" style="aspect-ratio: 64/27">
  <div class="slider__img slider__img-after">
    <p>This is the after text.</p>
    <img src="Images/after.jpg" />
  </div>
  <div class="slider__img slider__img-before">
    <p>This is the before text.</p>
    <img src="Images/before.jpg" />
  </div>
  <input type="range" min="0" max="100" value="50" step="0.01" 
    id="slider" class="slider__input" 
    autocomplete="off" onwheel="this.blur()" 
  />
</div>
<div class="figure"><p>This is the subtitle text.</p></div>

The 'before' image does come after the 'after' image. Ensure both images are of the same aspect ratio and change aspect-ratio in the first line to match.


Controller buttons

The site supports display of Xbox buttons through a font. You can use these to embellish a controls table like so:

Gamepad Command
{ / } Move camera up / down
[ / ] Tilt camera left / right
W / X Zoom in / out

The syntax for this is a little messy as it involves wrapping the specific glyphs in HTML:

<font face="Controller">{ / }</font> | Move camera up / down
<font face="Controller">[ / ]</font> | Tilt camera left / right
<font face="Controller">W / X</font> | Zoom in / out

The site also supports PlayStation buttons, if you'd like to use [ ] { } instead of [ ] { }. To switch to them, use "ControllerPS" instead of "Controller".

This feature is unique to the site and not supported by Markdown previews. You may generate previews of the site following our readme if you'd like to see how they look.

Input Output Input Output
7 8 9
4 5 6
1 2 3
7 8 9
4 5 6
1 2 3
7 8 9
4 5 6
1 2 3
7 8 9
4 5 6
1 2 3
< > < > < > < >
Q W E
A S D
Z X C
Q W E
A S D
Z X C
Q W E
A S D
Z X C
Q W E
A S D
Z X C
x y
a b
x y
a b
s t
x c
s t
x c
[ ]
{ }
[ ]
{ }
[ ]
{ }
[ ]
{ }
v g m v g m o h r o h r

Inputs are case-sensitive!
Controller Font by Dean Tersigni


Publishing guides

Once you're done writing a guide, you may contact one of the site admins (listed on the homepage) to get it added. Please zip up your guide and all relevant assets into one compressed folder. Alternatively, you may submit a pull request to the GitHub repository.

Once sent over, a site admin will look through your submission to ensure everything'll look good on the site before we put it up.

Thanks for contributing to FRAMED!