Skip to content

About

No description, website, or topics provided.

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Infernux Git Integration

A source control panel for the Infernux Engine. Stage, unstage, and commit straight from the editor — no terminal required.

简体中文 · Infernux Engine · Plugin development docs

Validate and Release Plugin License: MIT

Features

  • One-click git init when the open project folder is not a repository yet.
  • VS Code-style staging: a + button per file, plus Stage all (equivalent to git add -A).
  • Unstaging with a − button per file, including in repositories that have no commits yet.
  • Commit flow with a persistent message buffer and empty-message validation.
  • Automatic refresh of the file lists, plus a manual refresh button.
  • Files with a dual status (for example AM) appear in both lists, matching git status.
  • Vector icons for the stage, unstage, stage-all, and refresh controls, plus a status icon and a coloured status code on every file row.
  • Localized panel UI in English and Simplified Chinese.
  • The plugin's own licence and the notices for the bundled icon artwork ship with the plugin and are shown on the License page of the plugin information.
  • Branch management from the panel: a Branches section shows the current branch with its upstream, lists the local and remote branches, and switches, creates, renames, and deletes them. The selected branch also shows its commit log. Failures are reported in the Console.

Requirements

Requirement Version
Infernux Engine >=0.4.1,<0.5
Git >=2.13 available on your PATH

Git is a runtime requirement. The panel shells out to the git executable; when it is missing, the panel shows a short notice instead of the file lists.

Git 2.13 is the floor because the panel reads git status --porcelain=v2 (needs 2.11) and the %(upstream:short) field of git for-each-ref (needs 2.13). Both are from 2016 and 2017, so any current distribution is well past them.

The icons are vector artwork that the Editor rasterizes at runtime. That relies on the Engine's LunaSVG-backed texture loader, which is not part of the documented plugin API — if a future Engine release drops it, the panel falls back to text-only controls and everything else keeps working.

Installation

From a release

  1. Download wokrlie.git_integration.inxpkg from the Releases page.
  2. In the Editor, open Extensions/Plugins and install the downloaded archive.

The Editor checks the archive against the engine version declared in package/inx_package.json and refuses to install an incompatible build.

From source

python package.py build dist/wokrlie.git_integration.inxpkg

The build is deterministic — two runs over the same source produce byte-identical archives.

Usage

Open Extensions/Git Integration in the menu bar. The panel acts on the project folder currently open in the editor.

The full walkthrough lives in package/plugin_pages/usage.md, which also ships inside the package as the in-editor usage page.

Troubleshooting

The panel reports that Git is not usable. Git is not installed, or the Editor was started with a PATH that does not include it. Install Git and restart the Editor.

Commit does nothing. The commit message box is empty. Enter a message first.

git commit fails asking who you are. Git has no identity configured. Run:

git config --global user.name "Your Name"
git config --global user.email "you@example.com"

The panel shows files you did not expect. The panel follows the folder open in the Editor, not the folder the Editor binary lives in.

Development

python .infernux-dev/validate.py            # package layout and Python sources
python -m unittest discover -s tests        # validation and release contracts
python package.py build dist/plugin.inxpkg   # deterministic build
python package.py verify dist/plugin.inxpkg  # verify a built archive

The Editor-only code lives in package/editor/, and the runtime surface in package/runtime/. package/plugin_pages/ holds the in-editor documentation, and every English page must have a matching .zh-CN.md sibling — the validator enforces this.

Documentation

Document Purpose
package/plugin_pages/usage.md In-editor usage guide (English)
package/plugin_pages/usage.zh-CN.md In-editor usage guide (Simplified Chinese)
ROADMAP.md Planned features
CONTRIBUTING.md Contribution and commit conventions
RELEASING.md Release procedure
package/plugin_pages/license.md Plugin licence and third-party notices for the bundled artwork

License

MIT.

The same licence text and the notices for the bundled icon artwork ship inside the plugin archive, on the License page of the plugin information.

About

No description, website, or topics provided.

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages