flatpaker 0.0.1__tar.gz

flatpaker-0.0.1/.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.toml]
+indent_size = 2

flatpaker-0.0.1/.gitignore

@@ -0,0 +1,132 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Flatpak files
+.flatpak-builder

flatpaker-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Dylan Baker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

flatpaker-0.0.1/PKG-INFO

@@ -0,0 +1,150 @@
+Metadata-Version: 2.1
+Name: flatpaker
+Version: 0.0.1
+Summary: Utilities to convert various kinds of native binaries into flatpaks.
+Keywords: flatpak,renpy,rpgmaker
+Author-email: Dylan Baker <dylan@pnwbakers.com>
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Archiving :: Packaging
+Requires-Dist: tomli; python_version<"3.11"
+
+# flatpaker
+
+Script to mostly automate creating flatpaks from published Ren'Py and Linux
+builds of RPGMaker MV and MZ. open to additional support
+
+## What is it?
+
+It's a script that automatically handles much of the task of generating a
+flatpak for pre-built projects, including adding patches or mods. You
+write a small, simple toml file, fetch the sources, and get a ready to publish
+flatpak.
+
+It currently automatically does the following automatically:
+
+- Generates an appstream xml file
+- Generates a .desktop file
+- Extracts an icon from the game source, and installs it
+- patches the game to honor $XDG_DATA_HOME for storing game data inside the sandbox (instead of needing $HOME access)
+- sets up the sandbox to allow audio and display, but nothing else
+- recompiles the program when mods are applied
+- strips .rpy files to save space (keeping the rpyc files)
+- strips windows and macos specific files
+- allows local install or publishing to a repo
+
+## Why?
+
+I like playing Ren'Py games sometimes. I also don't always trust random
+pre-compiled binaries from the internet. Flatpak provides a nice, convenient
+way to sandbox applications. It also makes supporting Steam Deck and Fedora
+immutable a breeze. But generating flatpaks by hand is a lot of work, especially
+when most of the process will be exactly the same for every renpy project.
+
+## How do I use it?
+
+1. Download the compressed project
+2. Download any mods or addons (optional)
+3. Write a toml description
+4. run the program
+
+### Toml Format
+
+```toml
+[common]
+  name = 'Game or VN'  # use properly formatted name like "The Cool Adventures of Bob", or "Bob's Quest 7: Lawnmower Confusion"
+  reverse_url = 'com.example.JDoe'  # name will be appended
+  # "Game" is added automatically
+  # used freedesktop menu categories. see: https://specifications.freedesktop.org/menu-spec/latest/apas02.html
+  categories = ['Simulation']
+  engine = ['renpy']  # Or 'rpgmaker'
+
+[appdata]
+  summary = "A short summary, one sentence or so."
+  description = """
+    A longer description.
+
+    probably on multiple \
+    lines
+    """
+
+  # This is an optional value for the license of the renpy project itself.
+  # If unset it defaults to LicenseRef-Proprietary.
+  # if you have specific terms which are not an Open Source license, you can use the form:
+  # LicenseRef-Proprietary=https://www.example.com/my-license
+  # See: https://spdx.org/specifications for more information
+  license = "SPDX identifier"
+
+[appdata.content_rating]
+  # optional
+  # Uses OARS specifications. See: https://hughsie.github.io/oars/
+  # keys should be ids, and the values are must be a rating (as a string):
+  # none, mild, moderate, or intense
+  language-profanity = "mild"
+
+[appdata.releases]
+  # optional
+  # in the form "date = version"
+  "2023-01-01" = "1.0.0"
+
+# Optional, alternatively may be passed on teh command line
+[[sources.archives]]
+  # path must be set if this is provided
+  path = "relative to toml or absolute path"
+
+  # Optional, defaults to 1. How many directory levels to remove from this component
+  strip_comonents = 2
+
+# Optional, cannot be set from command line
+[[sources.patches]]
+  # path must be set if this is provided
+  path = "relative to toml or absolute path"
+
+  # Optional, defaults to 1. How many directory levels to remove from this component
+  strip_comonents = 2
+
+# Optional, cannot be set from command line
+[[sources.files]]
+  # path must be set if this is provided
+  path = "relative to toml or absolute path"
+
+  # Optional, if set the file will be installed to this name
+  # Does not have to be set for .rpy files that go in the game root directory
+  dest = "where to install"
+```
+
+### Configuration
+
+Some options can be given on the command line or via a configuration file.
+That file must be written to `$XDG_CONFIG_HOME/flatpaker/config.toml` (if unset
+`$XDG_CONFIG_HOME` defaults to `~/.config`).
+
+```toml
+[common]
+  # A gpg private key to sign with, overwritten by the --gpg option
+  gpg-key = "0x123456789"
+
+  # The absolute path to a repo to write to. overwritten by the --repo option
+  repo = "/path/to/a/repo/to/export"
+```
+
+
+## What is required?
+
+- python 3.11 or a modern version of python3 with tomli
+- flatpak-builder
+
+### Schema
+
+A Json based schema is provided, which can be used with VSCode's EvenBetterToml
+extension. It may be useful elsewhere.
+

flatpaker-0.0.1/README.md

@@ -0,0 +1,129 @@
+# flatpaker
+
+Script to mostly automate creating flatpaks from published Ren'Py and Linux
+builds of RPGMaker MV and MZ. open to additional support
+
+## What is it?
+
+It's a script that automatically handles much of the task of generating a
+flatpak for pre-built projects, including adding patches or mods. You
+write a small, simple toml file, fetch the sources, and get a ready to publish
+flatpak.
+
+It currently automatically does the following automatically:
+
+- Generates an appstream xml file
+- Generates a .desktop file
+- Extracts an icon from the game source, and installs it
+- patches the game to honor $XDG_DATA_HOME for storing game data inside the sandbox (instead of needing $HOME access)
+- sets up the sandbox to allow audio and display, but nothing else
+- recompiles the program when mods are applied
+- strips .rpy files to save space (keeping the rpyc files)
+- strips windows and macos specific files
+- allows local install or publishing to a repo
+
+## Why?
+
+I like playing Ren'Py games sometimes. I also don't always trust random
+pre-compiled binaries from the internet. Flatpak provides a nice, convenient
+way to sandbox applications. It also makes supporting Steam Deck and Fedora
+immutable a breeze. But generating flatpaks by hand is a lot of work, especially
+when most of the process will be exactly the same for every renpy project.
+
+## How do I use it?
+
+1. Download the compressed project
+2. Download any mods or addons (optional)
+3. Write a toml description
+4. run the program
+
+### Toml Format
+
+```toml
+[common]
+  name = 'Game or VN'  # use properly formatted name like "The Cool Adventures of Bob", or "Bob's Quest 7: Lawnmower Confusion"
+  reverse_url = 'com.example.JDoe'  # name will be appended
+  # "Game" is added automatically
+  # used freedesktop menu categories. see: https://specifications.freedesktop.org/menu-spec/latest/apas02.html
+  categories = ['Simulation']
+  engine = ['renpy']  # Or 'rpgmaker'
+
+[appdata]
+  summary = "A short summary, one sentence or so."
+  description = """
+    A longer description.
+
+    probably on multiple \
+    lines
+    """
+
+  # This is an optional value for the license of the renpy project itself.
+  # If unset it defaults to LicenseRef-Proprietary.
+  # if you have specific terms which are not an Open Source license, you can use the form:
+  # LicenseRef-Proprietary=https://www.example.com/my-license
+  # See: https://spdx.org/specifications for more information
+  license = "SPDX identifier"
+
+[appdata.content_rating]
+  # optional
+  # Uses OARS specifications. See: https://hughsie.github.io/oars/
+  # keys should be ids, and the values are must be a rating (as a string):
+  # none, mild, moderate, or intense
+  language-profanity = "mild"
+
+[appdata.releases]
+  # optional
+  # in the form "date = version"
+  "2023-01-01" = "1.0.0"
+
+# Optional, alternatively may be passed on teh command line
+[[sources.archives]]
+  # path must be set if this is provided
+  path = "relative to toml or absolute path"
+
+  # Optional, defaults to 1. How many directory levels to remove from this component
+  strip_comonents = 2
+
+# Optional, cannot be set from command line
+[[sources.patches]]
+  # path must be set if this is provided
+  path = "relative to toml or absolute path"
+
+  # Optional, defaults to 1. How many directory levels to remove from this component
+  strip_comonents = 2
+
+# Optional, cannot be set from command line
+[[sources.files]]
+  # path must be set if this is provided
+  path = "relative to toml or absolute path"
+
+  # Optional, if set the file will be installed to this name
+  # Does not have to be set for .rpy files that go in the game root directory
+  dest = "where to install"
+```
+
+### Configuration
+
+Some options can be given on the command line or via a configuration file.
+That file must be written to `$XDG_CONFIG_HOME/flatpaker/config.toml` (if unset
+`$XDG_CONFIG_HOME` defaults to `~/.config`).
+
+```toml
+[common]
+  # A gpg private key to sign with, overwritten by the --gpg option
+  gpg-key = "0x123456789"
+
+  # The absolute path to a repo to write to. overwritten by the --repo option
+  repo = "/path/to/a/repo/to/export"
+```
+
+
+## What is required?
+
+- python 3.11 or a modern version of python3 with tomli
+- flatpak-builder
+
+### Schema
+
+A Json based schema is provided, which can be used with VSCode's EvenBetterToml
+extension. It may be useful elsewhere.

flatpaker-0.0.1/flatpaker/__init__.py

@@ -0,0 +1,15 @@
+# SPDX-License-Identifier: MIT
+# Copyright © 2024 Dylan Baker
+
+"""Utilities to convert various kinds of native binaries into flatpaks.
+
+Current support includes Ren'Py and some versions of RPGMaker (MV and MZ, when
+they have Linux packages).
+
+Attempts to make some optimizations of the packages, such as recompiling
+bytecode, and patches various games to honor XDG variables, so that flatpaks
+don't need access to the user home directory. This increases security and is
+generally beneficial for end users.
+"""
+
+__version__ = "0.0.1"

flatpaker-0.0.1/flatpaker/config.py

@@ -0,0 +1,38 @@
+# SPDX-License-Identifier: MIT
+# Copyright © 2024 Dylan Baker
+
+from __future__ import annotations
+import os
+import typing
+
+from flatpaker.util import tomllib
+
+if typing.TYPE_CHECKING:
+
+    Common = typing.TypedDict(
+        'Common',
+        {
+            'gpg-key': str,
+            'repo': str,
+        },
+        total=False,
+    )
+
+    class Config(typing.TypedDict):
+        common: Common
+
+
+def load_config() -> Config:
+    root = os.environ.get('XDG_CONFIG_HOME', os.path.expanduser('~/.config'))
+    conf = os.path.join(root, 'flatpaker', 'config.toml')
+    raw: typing.Dict[str, typing.Any]
+    if os.path.exists(conf):
+        with open(conf, 'rb') as f:
+            raw = tomllib.load(f)
+        assert isinstance(raw, dict), 'invalid config file?'
+    else:
+        raw = {}
+
+    if 'common' not in raw:
+        raw['common'] = {}
+    return typing.cast('Config', raw)

flatpaker-0.0.1/flatpaker/entry.py

@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: MIT
+# Copyright © 2022-2024 Dylan Baker
+
+from __future__ import annotations
+import argparse
+import importlib
+import pathlib
+import typing
+
+import flatpaker.config
+import flatpaker.util
+
+if typing.TYPE_CHECKING:
+    JsonWriterImpl = typing.Callable[[flatpaker.util.Description, pathlib.Path, str, pathlib.Path, pathlib.Path], None]
+
+    class ImplMod(typing.Protocol):
+
+        write_rules: JsonWriterImpl
+
+
+def select_impl(name: typing.Literal['renpy', 'rpgmaker']) -> JsonWriterImpl:
+    mod = typing.cast('ImplMod', importlib.import_module(name, 'flatpaker.impl'))
+    assert hasattr(mod, 'write_rules'), 'should be good enough'
+    return mod.write_rules
+
+
+def main() -> None:
+    config = flatpaker.config.load_config()
+    parser = argparse.ArgumentParser()
+    parser.add_argument('description', help="A Toml description file")
+    parser.add_argument(
+        '--repo',
+        default=config['common'].get('repo', 'repo'),
+        action='store',
+        help='a flatpak repo to put the result in')
+    parser.add_argument(
+        '--gpg',
+        default=config['common'].get('gpg-key'),
+        action='store',
+        help='A GPG key to sign the output to when writing to a repo')
+    parser.add_argument('--export', action='store_true', help='Export to the provided repo')
+    parser.add_argument('--install', action='store_true', help="Install for the user (useful for testing)")
+    parser.add_argument('--no-cleanup', action='store_false', dest='cleanup', help="don't delete the temporary directory")
+    args = typing.cast('flatpaker.util.Arguments', parser.parse_args())
+    # Don't use type for this because it swallows up the exception
+    description = flatpaker.util.load_description(args.description)
+
+    # TODO: This could be common
+    appid = f"{description['common']['reverse_url']}.{flatpaker.util.sanitize_name(description['common']['name'])}"
+
+    write_build_rules = select_impl(description['common']['engine'])
+
+    with flatpaker.util.tmpdir(description['common']['name'], args.cleanup) as d:
+        wd = pathlib.Path(d)
+        desktop_file = flatpaker.util.create_desktop(description, wd, appid)
+        appdata_file = flatpaker.util.create_appdata(description, wd, appid)
+        write_build_rules(description, wd, appid, desktop_file, appdata_file)
+        flatpaker.util.build_flatpak(args, wd, appid)