Steam Editor Tools: Help You Write Guides and Reviews

This package offers editor tools helping users write Steam guides and reviews.

This package supports:

• Steam information queries
• Image editing tools
• BBCode text processing tools

Users can write their documents with Markdown, use this package to process the images in the document, and convert the document to the Steam BBCode format.

1. Install

Intall the latest released version of this package by using the PyPI source:

python -m pip install steam-editor-tools

2. Usage

The following minimal example shows a simple customization, where we convert a Markdown file into Steam BBCode, and print each header during the conversion.

import os
import steam_editor_tools as stet


class CustomizedRenderer(stet.BBCodeRenderer):
    def render_heading(self, node: stet.bbcode.nodes.HeadingNode) -> str:
        print(self.render_children(node.children))
        return super().render_heading(node)


def convert(file_path: str) -> None:
    out_file_path = os.path.splitext(file_path)[0].strip() + ".bbcode"
    doc = stet.DocumentParser().parse_file(file_path)
    with open(out_file_path, "w", encoding="utf-8") as fobj:
        fobj.write(CustomizedRenderer().render(doc))


convert("example.md")

Currently, we support the following features:

2.1. Steam information query

2.2. Image editing tools

Actually, the title banner of this Readme file is created by the image editing tools. See the examples.

2.3. BBCode text processing tools

3. Why using this package

1. Compared to other BBCode conversion packages such as html2bbcode and html2phpbbcode, our package strictly follows the current Steam BBCode format. Different forums may have different BBCode standards.
2. Compared to ihroteka-converter, we fully support every format provided by Steam. Unlike that regular-expression-based conversion, the BBCode reconstruction in this package is based on a recursive analysis of the HTML structure. Therefore, our package will not omit any text as long as it appears in the original document.
3. We offer flexibility of customization. Users can inject any rendering step of this package by simply overriding the methods of steam_editor_tools.bbcode.BBCodeRenderer. For example, we can customize a BBCodeRenderer to create a title image for each header.
4. We offer convenient approaches for integrating the store page information into the output data. For example, users can easily convert a store page to BBCode if needed.

4. Examples

Currently, we offer the following examples in ./examples folder:

The following two guides are written with the help of this tool. Check them for viewing the details:

5. Documentation

Check the documentation to find more details about the examples and APIs.

https://cainmagi.github.io/steam-editor-tools/

See the articles discussing this tool:

6. Contributing

See CONTRIBUTING.md 📖

7. Changelog

See Changelog.md 📖

8. Future plan

• HTML/Markdown to BBCode
• Support the conversion of extensive Markdown alert block.
• Multi-layer image synthesis
• Query Steam app ID by name
• Get Steam app details by ID
• Screenshot formatting
• System/User font file detection
• Image overlay with alpha channel
• Image layer properties
• Improved image anchor interfaces
• More Steam queries based on public APIs