Jared Miller
d84d1d809b
Move all root .py files into playscii/ package directory. Rename playscii.py to app.py, add __main__.py entry point. Convert bare imports to relative (within package) and absolute (in formats/ and games/). Data dirs stay at root.
56 lines
2.2 KiB
Python
56 lines
2.2 KiB
Python
import traceback
|
|
|
|
from .art import ART_DIR
|
|
|
|
|
|
class ArtExporter:
|
|
"""
|
|
Class for exporting an Art into a non-Playscii format.
|
|
Export logic happens in run_export; exporter authors simply extend this
|
|
class, override run_export and the class properties below.
|
|
"""
|
|
|
|
format_name = "ERROR - ArtExporter.format_name"
|
|
"User-visible name for this format, shown in export chooser."
|
|
format_description = "ERROR - ArtExporter.format_description"
|
|
"String (can be triple-quoted) describing format, shown in export chooser."
|
|
file_extension = ""
|
|
"Extension to give the exported file, sans dot."
|
|
options_dialog_class = None
|
|
"UIDialog subclass exposing export options to user."
|
|
|
|
def __init__(self, app, out_filename, options={}):
|
|
self.app = app
|
|
self.art = self.app.ui.active_art
|
|
# add file extension to output filename if not present
|
|
if self.file_extension and not out_filename.endswith(f".{self.file_extension}"):
|
|
out_filename += f".{self.file_extension}"
|
|
# output filename in documents/art dir
|
|
if not out_filename.startswith(self.app.documents_dir + ART_DIR):
|
|
out_filename = self.app.documents_dir + ART_DIR + out_filename
|
|
self.success = False
|
|
"Set True on successful export."
|
|
# store final filename for log messages
|
|
self.out_filename = out_filename
|
|
# remove any cursor-hover changes to art in memory
|
|
for edit in self.app.cursor.preview_edits:
|
|
edit.undo()
|
|
try:
|
|
if self.run_export(out_filename, options):
|
|
self.success = True
|
|
else:
|
|
line = f"{self.__class__.__name__} failed to export {out_filename}, see console for errors"
|
|
self.app.log(line)
|
|
self.app.ui.message_line.post_line(line, hold_time=10, error=True)
|
|
except Exception:
|
|
for line in traceback.format_exc().split("\n"):
|
|
self.app.log(line)
|
|
# store last used export options for "Export last"
|
|
self.app.last_export_options = options
|
|
|
|
def run_export(self, out_filename, options):
|
|
"""
|
|
Contains the actual export logic. Write data based on current art,
|
|
return success.
|
|
"""
|
|
return False
|