FAuctionUI

Ready-to-use GUI configuration files for the FAuction plugin.
Drop a language folder into your server to customize every auction house menu without editing YAML from scratch.


Wiki · Report a Bug · Discussions

---

What is this?

FAuction renders every screen of its auction house from YAML files under plugins/FAuction/gui/. This repository keeps those files as a maintained, ready-to-copy reference — one folder per language — so server owners can restyle the plugin's menus (layout, materials, titles, textures, descriptions) without starting from an empty file.

Structure

en/
├── auction.yml            Main auction browser
├── auctionConfirm.yml     Purchase confirmation dialog
├── expire.yml             Expired items collection
├── historic.yml           Transaction history viewer
├── playerView.yml         Player's own active listings
└── menus/
    └── main.yml           Custom main menu (defaultGui: MENU:main)

Each language lives in its own top-level folder (currently en/) and mirrors the exact layout FAuction expects under plugins/FAuction/gui/.

Usage

1. Pick the folder matching the lang you set in FAuction's config.yml (or use it as a base for a new one).
2. Copy its contents into plugins/FAuction/gui/ on your server, keeping the menus/ subfolder for main.yml.
3. Edit materials, titles, descriptions, or slot layout to your liking.
4. Apply the changes with /ah admin reload or a server restart.

These files only cover GUI layout. General settings (currency, database, categories, sorting, limits, anti-spam, etc.) live in FAuction's own config.yml, database.yml, categories.yml, and sort.yml — see the main README.

Editing a GUI file

Every screen shares the same building blocks:

• Layout — inventory size, type, and one block entry per slot index
• Utility — the action bound to a slot (e.g. auctionGui, expireGui, historicGui, previous, next, close, barrier for filler slots)
• Materials and textures — icon material, or a base64 texture for custom player heads
• Titles and descriptions — support Minecraft color codes (&c, &5, ...) and placeholders

Available placeholders in descriptions:

Placeholder	Value
{ItemName}	Item display name
{OwnerName}	Seller's player name
{Price}	Listing price
{ExpireTime}	Expiration date
{RemainingTime}	Time remaining until expiry
{Page} / {TotalPage}	Current and total page numbers
{TotalSale}	Total number of active listings
{categoryDisplayName}	Current category filter name
{sortDisplayName}	Current sort method name
{lore}	Original item lore

Adding a translation

To contribute a new language:

1. Copy the en/ folder to a new one named after the language code used by FAuction's lang_<code>.yml files (e.g. fr/, ru/, zhcn/).
2. Translate the title and description values — keep utility, material, slot indices, and placeholders unchanged.
3. Open a pull request.

Keeping this repo in sync

These files should always match the current default GUI shipped inside FAuction/src/main/resources/gui/ on the plugin's master branch. When FAuction adds a new slot, utility, or screen, update the corresponding file(s) here in the same pass.

Related links

• FAuction — the plugin these files configure
• Wiki — detailed documentation and guides
• Discord — community support
• GitHub Discussions — questions and ideas

License

Distributed under the same license as FAuction: GNU General Public License v3.0.