Skip to content

About

Dashes, screensavers and per-car light data for the FX Unleashed SimHub plugin (Simagic FX Pro).

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

FX Unleashed library

Dashes and screensavers for the Simagic FX Pro wheel's screen, made by the community, for the FX Unleashed SimHub plugin (USB mode). Browse them in the plugin (Dashes tab and Idle & sleep tab, "Library") or on fxunleashed.com/library, and install in a click: no plugin update, no restart.

FX Unleashed is an independent community project. It is not affiliated with, endorsed by or supported by Simagic. Simagic and FX Pro are trademarks of their owner, used only to say which hardware this works with. Everything here is provided "as is", without warranty of any kind. Items are made by the community: see TERMS.md.

What's in it

dashes/<id>/dash.json      the dash (the plugin's dash format, docs/dash-format.md in the plugin repo)
dashes/<id>/meta.json      name, author, description, version, games, cars, tags, licence, measured cost, sha256
dashes/<id>/preview.png    800x480, rendered by the plugin exactly as the wheel draws it
savers/<id>/...            the same for screensavers
index.json                 every item, generated by tools/build_index.py (what the plugin and the website read)
cars/                      per-car rev lights and pit limiter lights from each game's own files (below)

Car light data (cars/)

For every car of a supported game, what its dash does: when each rev light comes on and in what colour, and what the dash shows with the pit limiter on. It's read from the game's own files for each game version, so the wheel matches the car you're driving. The plugin downloads it by itself and checks it for updates every few hours.

  • cars/index.json: each game's file, its sha256 and the game version it was made from.
  • cars/<game>.json: the cars (format: docs/car-lights-format.md in the plugin repo).
  • cars/CHANGELOG.md: what changed with each game update.

It's generated by the FX Unleashed maintainers' tools after each game update, not submitted by pull request (the checks refuse changes to cars/ in a submission). tools/check_cars.py checks it on every push.

Rules (checked for every submission)

  • Checked scripts only. SimHub's NCalc formulas (ncalc:) and properties (prop:) are always fine. A js: formula is code SimHub runs, so it must pass an automatic check that allows only a short list of safe parts (no loops, no eval, no functions of its own, no way out of the dash): see SCRIPTS.md. A scripts folder is refused. A dash with a script is marked "Contains a checked script".
  • Size: dash.json up to 1 MB, pictures inside it up to 700 KB, preview up to 512 KB.
  • Format: a dash format the current plugin reads; the plugin refuses newer ones rather than half-loading them.
  • Checksums: meta.json carries the sha256 of dash.json; the plugin checks every download against it.
  • Your own work, or with permission. A converted dash (from SimHub, another game's dash, anyone's design) needs its author's permission and credit: Source and Permission in meta.json. See TERMS.md.

Submit one

Package it in the plugin (Dashes tab, Package for the library: it writes <id>.fxdash.zip), then attach that file to a Submit a dash issue (drag it in, or pick it with the box's "selecting them" link). You need a free GitHub account, but no Git. A bot checks it and, if it passes, publishes it on the spot. The full walk-through, from the custom firmware to making your own dash: fxunleashed.com/docs/library-submit. Or open a pull request yourself: a check runs on it and merges it when every rule holds. See CONTRIBUTING.md.

Just want to give a dash to a friend? The plugin's Share… button writes it as one file (<id>.fxdash.json); they drop it on the plugin's Dashes tab. For anything in this library, Copy link gives a page with a preview and an Install button.

Licences

Each item has its own licence in its meta.json (the seed items by FX Unleashed are CC-BY-4.0). The tools in tools/ and the workflow are GPL-3.0, like the plugin.

About

Dashes, screensavers and per-car light data for the FX Unleashed SimHub plugin (Simagic FX Pro).

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages