rmskin-builder

Crates.io	rmskin-builder
lib.rs	rmskin-builder
version	2.0.1
created_at	2025-07-29 08:13:42.914219+00
updated_at	2025-09-15 23:27:18.611125+00
description	A CLI tool to package Rainmeter Skins into a .rmskin file.
homepage
repository	https://github.com/2bndy5/rmskin-action
max_upload_size
id	1772056
size	502,897

Brendan (2bndy5)

documentation

README

rmskin-action

A Github Action that packages a repository's Rainmeter content into a validating .rmskin file for Rainmeter's Skin Installer.

Deployments

There various ways to employ this software (written in Rust).

Github Actions

name: RMSKIN Packager

on:
  push:
    branches: [main]
    tags: '*'
  pull_request:
    branches: [main]

jobs:
  build-n-release:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout this Repo
        uses: actions/checkout@v4

      # Run this rmskin-action
      - name: Run Build action
        id: builder
        uses: 2bndy5/rmskin-action@v2.0.1

      # Upload the asset (using the output from the `builder` step)
      - name: Upload Release Asset
        if: startsWith(github.ref, 'refs/tags/')
        env:
          GITHUB_TOKEN: ${{ github.token }}
        run: gh release upload ${{ github.ref_name }} ${{ steps.builder.outputs.arc_name }}

Python Package

Originally, this was written as a pure Python executable script. After migrating the code base to Rust, the Python package is still maintained as an FFI binding.

pip install rmskin-builder
rmskin-builder.exe --help

Rust package

A Rust crate is published to take advantage of cargo-binstall for easily installing a portable binary executable.

cargo binstall rmskin-builder
rmskin-build --help

Input/CLI options

Option	Description	Required
`path`	Base directory of repo being packaged. Defaults to current working path.	no
`dir-out`	Path to save generated rmskin package. Defaults to current working path. This can also be specified using `dir_out` for backward compatibility.	no
`version`	Version of the Rainmeter rmskin package. Defaults to last 7 digits of SHA from commit or ref/tags or otherwise `x0x.y0y`.	no
`title`	Name of the Rainmeter rmskin package. Defaults to name of repository or otherwise the last directory name in the `path` option.	no
`author`	Account Username maintaining the rmskin package. Defaults to Username that triggered the action or the `git config user.name`; `Unknown` when all else fails.	no

[!NOTE] You can use your project's RMSKIN.ini file to override any above inputs except dir-out and path.

The above arguments are also used as CLI arguments but remember to prepend -- to option's name (eg path becomes --path).

Output Variables

arc-name: The name of the generated rmskin file saved in the path specified by dir_out input argument.
arc_name: The same as arc-name output value. This output variable only exists for backward compatibility.

When not executed in a Github Actions workflow, then this output variable will printed to stdout as Archive name: **.rmskin.

Ideal Package Structure

Ideally, the package directory (located at path input value) can have the following files/folders:

Name	Description	Required
`Skins`	A folder to contain all necessary Rainmeter skins.	yes
`RMSKIN.ini`	list of options specific to installing the skin(s).	yes
`RMSKIN.bmp`	A brand/logo image displayed in the Rainmeter installer.	no
`Layouts`	A folder that contains Rainmeter layout files.	no
`Plugins`	A folder that contains Rainmeter plugins.	no
`@Vault`	A resources folder accessible by all installed skins.	no

[!TIP] A cookiecutter repository has also been created to facilitate development of Rainmeter skins on Github quickly.

Commit count: 148